Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --details option to inspect command #2183

Open
cornelius opened this issue Oct 27, 2016 · 0 comments
Open

Add --details option to inspect command #2183

cornelius opened this issue Oct 27, 2016 · 0 comments

Comments

@cornelius
Copy link
Contributor

cornelius commented Oct 27, 2016

The inspect command should get an option to specify the detail level of the inspection. This is a shortcut to providing the detail level as individual options and commands.

The option should support the following levels. Each level includes all the information from the previous level:

  • minimal: Minimal detail level. Only the scopes os, packages, repositories, and patterns are inspected. This is for getting basic data of a system, which can be used as a hint to identify the system and its contents.
  • quick: Quick inspection to get a full overview of the system without much details. All scopes are inspected, but no files are extracted, and no meta data is gathered which takes time to inspect.
  • sizes: All scopes are inspected and file and directory sizes are gathered for the file scopes, so that users have a base for deciding if they want to filter out some of the file items when extracting files.
  • extracted: All scopes are inspected and all files are extracted. This results in a complete description of the system.
  • full: The analyze command is run in addition to inspecting and extracting all scopes. This results in a description with all data Machinery is able to obtain.

If additional options are provided together with the --details option such as --scope or --extract-files they are applied as well. Specific options take precedence over options implied by the --details option. For example machinery inspect --details=minimal --scope=users would inspect the scopes os, packages, repositories, patterns, and users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant