ansible-doctor/docs/content/configuration/cli.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2020-01-16 10:27:46 +00:00
---
title: CLI options
---
2020-06-03 14:22:56 +00:00
You can get all available CLI options by running `ansible-doctor --help`:
2020-01-16 10:27:46 +00:00
2020-06-03 14:22:56 +00:00
<!-- prettier-ignore-start -->
<!-- spellchecker-disable -->
2020-01-16 10:27:46 +00:00
{{< highlight Shell "linenos=table" >}}
$ ansible-doctor --help
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v]
[-q] [--version]
role_dir
Generate documentation from annotated Ansible roles using templates
positional arguments:
role_dir role directory (default: current working dir)
optional arguments:
-h, --help show this help message and exit
-c CONFIG_FILE, --config CONFIG_FILE
location of configuration file
-o OUTPUT_DIR, --output OUTPUT_DIR
output base dir
-f, --force force overwrite output file
-d, --dry-run dry run without writing
-v increase log level
-q decrease log level
--version show program's version number and exit
{{< /highlight >}}
<!-- spellchecker-enable -->
2020-06-03 14:22:56 +00:00
<!-- prettier-ignore-end -->