Skip to content

Commit

Permalink
Update upstream docs to reflect CLI changes (#312)
Browse files Browse the repository at this point in the history 
* Update upstream docs to reflect CLI changes

* Update upstream docs to reflect CLI changes

* Fix Typo
  • Loading branch information
@abhikdps
abhikdps authored Nov 5, 2024
1 parent f104deb commit 606610c
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions docs/installing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,18 @@ $ ansible-creator init collection <collection-name> <path>

#### Optional Arguments

| Sort flag | Long flag | Flag argument | Description |
| --------- | ------------ | ------------- | ----------------------------------------------------------------------------------------------------- |
| -f | --force | | Force re-initialize the specified directory as an Ansible collection. (default: False) |
| | --json | | Output messages as JSON (default: False) |
| --la | --log-append | bool | Append to log file. (choices: true, false) (default: true) |
| --lf | --log-file | file | Log file to write to. (default: ./ansible-creator.log) |
| --ll | --log-level | level | Log level for file output. (choices: notset, debug, info, warning, error, critical) (default: notset) |
| --na | --no-ansi | | Disable the use of ANSI codes for terminal color. (default: False) |
| -h | --help | | Show this help message and exit |
| -v | --verbosity | | Give more Cli output. Option is additive, and can be used up to 3 times. (default: 0) |
| Short flag | Long flag | Flag argument | Description |
| ---------- | -------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| -f | --force | | Force re-initialize the specified directory as an Ansible collection. This flag is deprecated and will be removed soon. (default: False) |
| -o | --overwrite | | Overwrites existing files or directories. (default: False) |
| -no | --no-overwrite | | Restricts the overwriting operation for files or directories. (default: False) |
| | --json | | Output messages as JSON (default: False) |
| --la | --log-append | bool | Append to log file. (choices: true, false) (default: true) |
| --lf | --log-file | file | Log file to write to. (default: ./ansible-creator.log) |
| --ll | --log-level | level | Log level for file output. (choices: notset, debug, info, warning, error, critical) (default: notset) |
| --na | --no-ansi | | Disable the use of ANSI codes for terminal color. (default: False) |
| -h | --help | | Show this help message and exit |
| -v | --verbosity | | Give more Cli output. Option is additive, and can be used up to 3 times. (default: 0) |

#### Example

Expand Down Expand Up @@ -202,16 +204,18 @@ $ ansible-creator init playbook <collection-name> <path>

#### Optional Arguments

| Sort flag | Long flag | Flag argument | Description |
| --------- | ------------ | ------------- | ----------------------------------------------------------------------------------------------------- |
| -f | --force | | Force re-initialize the specified directory as an Ansible collection. (default: False) |
| | --json | | Output messages as JSON (default: False) |
| --la | --log-append | bool | Append to log file. (choices: true, false) (default: true) |
| --lf | --log-file | file | Log file to write to. (default: ./ansible-creator.log) |
| --ll | --log-level | level | Log level for file output. (choices: notset, debug, info, warning, error, critical) (default: notset) |
| --na | --no-ansi | | Disable the use of ANSI codes for terminal color. (default: False) |
| -h | --help | | Show this help message and exit |
| -v | --verbosity | | Give more Cli output. Option is additive, and can be used up to 3 times. (default: 0) |
| Short flag | Long flag | Flag argument | Description |
| ---------- | -------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| -f | --force | | Force re-initialize the specified directory as an Ansible collection. This flag is deprecated and will be removed soon. (default: False) |
| -o | --overwrite | | Overwrites existing files or directories. (default: False) |
| -no | --no-overwrite | | Restricts the overwriting operation for files or directories. (default: False) |
| | --json | | Output messages as JSON (default: False) |
| --la | --log-append | bool | Append to log file. (choices: true, false) (default: true) |
| --lf | --log-file | file | Log file to write to. (default: ./ansible-creator.log) |
| --ll | --log-level | level | Log level for file output. (choices: notset, debug, info, warning, error, critical) (default: notset) |
| --na | --no-ansi | | Disable the use of ANSI codes for terminal color. (default: False) |
| -h | --help | | Show this help message and exit |
| -v | --verbosity | | Give more Cli output. Option is additive, and can be used up to 3 times. (default: 0) |

Example:

Expand Down

0 comments on commit 606610c

Please sign in to comment.