Skip to content

Commit

Permalink
chore: update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
yassun7010 committed Oct 8, 2023
1 parent 3e1451a commit 13b8a81
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,26 @@
<!-- --8<-- [end:badges] -->

`cmdcomp` generate command shell completion file (`bash` or `zsh`) from config
`json`/`yaml`/`toml` file.
`JSON`/`YAML`/`TOML` file.

![image](./docs/images/image.png)

## Why was `cmdcomp` created?

Completion files for many cli tools (`aws`, `gcloud`, etc.) are provided by
self. However, if you want to use these cli tools in multiple products and
multiple environments (prd, dev, etc.), it would be useful to be able to switch
contexts easily. In this situation, I have a simple Shell Script wrapper to
switches settings for each environment easily. (like `mycli prd aws s3 ...`).

`cmdcomp` can generate completion files for your shell script using
configuration wittened by `YAML` or `TOML` or `JSON`.

In today's development, more and more cli tools be used.

If you want to generate a completion file for a simple wrapper script, `cmdcomp`
will be of great help.

## Install

```shell
Expand All @@ -23,7 +39,7 @@ pip install cmdcomp
## Usage

```shell
cmdcomp --file $YOUR_CONFIG_FILE --shell-type bash
cmdcomp --config $YOUR_CONFIG_FILE --shell-type bash
```

## Documentation
Expand Down

0 comments on commit 13b8a81

Please sign in to comment.