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

document ansible-builder introspect command #562

Open
samccann opened this issue Jun 9, 2023 · 0 comments
Open

document ansible-builder introspect command #562

samccann opened this issue Jun 9, 2023 · 0 comments
Labels
needs_triage New item that needs to be triaged

Comments

@samccann
Copy link
Contributor

samccann commented Jun 9, 2023

This command doesn't show up in the CLI Usage chapter yet.

ansible-builder introspect -h
usage: ansible-builder introspect [-h] [--sanitize] [--user-pip USER_PIP] [--user-bindep USER_BINDEP] [--write-pip WRITE_PIP]
                                  [--write-bindep WRITE_BINDEP] [-v {0,1,2,3}]
                                  [folder]

Loops over collections in folder and returns data about dependencies. This is used internally and exposed here for verification. This is targeted
toward collection authors and maintainers.

positional arguments:
  folder                Ansible collections path(s) to introspect. This should have a folder named ansible_collections inside of it.

options:
  -h, --help            show this help message and exit
  --sanitize            Sanitize and de-duplicate requirements. This is normally done separately from the introspect script, but this option is
                        given to more accurately test collection content.
  --user-pip USER_PIP   An additional file to combine with collection pip requirements.
  --user-bindep USER_BINDEP
                        An additional file to combine with collection bindep requirements.
  --write-pip WRITE_PIP
                        Write the combined pip requirements file to this location.
  --write-bindep WRITE_BINDEP
                        Write the combined bindep requirements file to this location.
  -v {0,1,2,3}, --verbosity {0,1,2,3}
                        Increase the output verbosity, for up to three levels of verbosity (invoked via "--verbosity" or "-v" followed by an
                        integer ranging in value from 0 to 3) (default: 2)
@github-actions github-actions bot added the needs_triage New item that needs to be triaged label Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs_triage New item that needs to be triaged
Projects
None yet
Development

No branches or pull requests

1 participant