diff options
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -34,6 +34,18 @@ Then, source the `OPENAI_API_KEY` environmental variable in your shell's configu source ~/.bashrc ``` +#### Bash / Zsh Completion + +`gpt-chat-cli` uses [argcomplete](https://github.com/kislyuk/argcomplete) to generate completion scripts for the `bash` or `zsh` shells. + +Currently, the recommended installation method is the explicit registeration of argcomplete with your shell by placing the following line in your `~/.bashrc` or `~/.zshrc`. + +```bash +eval "$(register-python-argcomplete gpt-chat-cli)" +``` + +Argcomplete also supports registration through ["global completion"](https://github.com/kislyuk/argcomplete#global-completion). The aim of global completion is to automatically register any scripts which use argcomplete. This is not currently recommended as it seems to make some assumptions which do not hold for all users. + ### User Guide #### Basic Usage |