diff options
| author | Orhun Parmaksız <orhunparmaksiz@gmail.com> | 2021-12-11 02:59:39 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-10 23:59:39 +0000 |
| commit | 0abd063e018ecb8851c3a816aa941dd04d594c9e (patch) | |
| tree | e61f6858727989bf7d848d7dab76632e6657b222 /docs/shell-completions.md | |
| parent | Update messages in install.sh about the AUR packages (#231) (diff) | |
| download | atuin-0abd063e018ecb8851c3a816aa941dd04d594c9e.zip | |
Support generating shell completions (#235)
* Add gen-completions subcommand for generating shell completions
* Update documentation about generating shell completions
* Include the shell completions in release tarball
Diffstat (limited to 'docs/shell-completions.md')
| -rw-r--r-- | docs/shell-completions.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/shell-completions.md b/docs/shell-completions.md new file mode 100644 index 00000000..4adf82b0 --- /dev/null +++ b/docs/shell-completions.md @@ -0,0 +1,19 @@ +# `atuin gen-completions` + +[Shell completions](https://en.wikipedia.org/wiki/Command-line_completion) for Atuin can be generated by specifying the output directory and desired shell via `gen-completions` subcommand. + +``` +$ atuin gen-completions --shell bash --out-dir $HOME + +Shell completion for BASH is generated in "/home/user" +``` + +Possible values for the `--shell` argument are the following: + +- `bash` +- `fish` +- `zsh` +- `powershell` +- `elvish` + +Also, see the [supported shells](./../README.md#supported-shells). |