aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorflu0r1ne <flu0r1ne@flu0r1ne.net>2023-05-10 12:44:09 -0500
committerflu0r1ne <flu0r1ne@flu0r1ne.net>2023-05-10 12:44:09 -0500
commit8bc4d723f9e223b61a8d601e3bd1083f31b89322 (patch)
treea6c0ad987d22d75f42c343892a9e2cda8af248fd
parent8c997bff1cebff5d1e47a19ff103e3d40c48f829 (diff)
downloadgpt-chat-cli-8bc4d723f9e223b61a8d601e3bd1083f31b89322.tar.xz
gpt-chat-cli-8bc4d723f9e223b61a8d601e3bd1083f31b89322.zip
Add instructions for completion
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 35096be..8fd1247 100644
--- a/README.md
+++ b/README.md
@@ -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