atuin/docs/shell-completions.md
Orhun Parmaksız 0abd063e01
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
2021-12-10 23:59:39 +00:00

20 lines
518 B
Markdown

# `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).