diff options
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). |