File tree Expand file tree Collapse file tree 1 file changed +18
-2
lines changed Expand file tree Collapse file tree 1 file changed +18
-2
lines changed Original file line number Diff line number Diff line change 1010<!-- --8<-- [end:badges] -->
1111
1212` cmdcomp ` generate command shell completion file (` bash ` or ` zsh ` ) from config
13- ` json ` /` yaml ` /` toml ` file.
13+ ` JSON ` /` YAML ` /` TOML ` file.
1414
1515![ image] ( ./docs/images/image.png )
1616
17+ ## Why was ` cmdcomp ` created?
18+
19+ Completion files for many cli tools (` aws ` , ` gcloud ` , etc.) are provided by
20+ self. However, if you want to use these cli tools in multiple products and
21+ multiple environments (prd, dev, etc.), it would be useful to be able to switch
22+ contexts easily. In this situation, I have a simple Shell Script wrapper to
23+ switches settings for each environment easily. (like ` mycli prd aws s3 ... ` ).
24+
25+ ` cmdcomp ` can generate completion files for your shell script using
26+ configuration wittened by ` YAML ` or ` TOML ` or ` JSON ` .
27+
28+ In today's development, more and more cli tools be used.
29+
30+ If you want to generate a completion file for a simple wrapper script, ` cmdcomp `
31+ will be of great help.
32+
1733## Install
1834
1935``` shell
@@ -23,7 +39,7 @@ pip install cmdcomp
2339## Usage
2440
2541``` shell
26- cmdcomp --file $YOUR_CONFIG_FILE --shell-type bash
42+ cmdcomp --config $YOUR_CONFIG_FILE --shell-type bash
2743```
2844
2945## Documentation
You can’t perform that action at this time.
0 commit comments