From 13b8a81861db1b07f06e46df24a7506213f5961f Mon Sep 17 00:00:00 2001 From: yassun7010 Date: Mon, 9 Oct 2023 02:12:41 +0900 Subject: [PATCH] chore: update readme. --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21a5c2a..4a0b9e0 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,26 @@ `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 @@ -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