ansible-builder icon indicating copy to clipboard operation
ansible-builder copied to clipboard

document ansible-builder introspect command

Open samccann opened this issue 2 years ago • 0 comments

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)

samccann avatar Jun 09 '23 20:06 samccann