summaryrefslogtreecommitdiffstats
path: root/docs/shell-completions.md
blob: 4adf82b02e6161ed5147fe94af5637a67f2a299e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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).