From 0abd063e018ecb8851c3a816aa941dd04d594c9e Mon Sep 17 00:00:00 2001
From: Orhun Parmaksız <orhunparmaksiz@gmail.com>
Date: Sat, 11 Dec 2021 02:59:39 +0300
Subject: 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
---
 docs/shell-completions.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 docs/shell-completions.md

(limited to 'docs')

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).
-- 
cgit v1.3.1