From 52c80631c6991482f6b9e1993deaf9907c935e18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Behmo?= <regis@behmo.com>
Date: Fri, 3 May 2019 07:55:21 +0200
Subject: [PATCH] Document CLI auto-complete

---
 docs/install.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/install.rst b/docs/install.rst
index a43e465..b73cd47 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -53,3 +53,18 @@ Installing from a local clone of the repository::
     git clone https://github.com/regisb/tutor
     cd tutor
     pip install -e .
+    
+Autocomplete
+------------
+
+Tutor is built on top of `Click <https://click.palletsprojects.com>`_, which is a great library for building command line interface (CLI) tools. As such, Tutor benefits from all Click features, including `auto-completion <https://click.palletsprojects.com/en/7.x/bashcomplete/>`_. After installing Tutor, auto-completion can be enabled by running::
+
+    _TUTOR_COMPLETE=source tutor >> ~/.bashrc
+
+If you are running zsh, run instead::
+
+    _TUTOR_COMPLETE=source_zsh tutor >> ~/.zshrc
+
+After opening a new shell, you can test auto-completion by typing::
+
+    tutor <tab><tab>
\ No newline at end of file