christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-11 15:51:00 +00:00
Code Issues Releases Activity

Document CLI auto-complete

Browse Source
This commit is contained in:
Régis Behmo 2019-05-03 07:55:21 +02:00
parent 4b6e6bcbf7
commit 52c80631c6
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/install.rst
View File

@ -53,3 +53,18 @@ Installing from a local clone of the repository::
git clone https://github.com/regisb/tutor git clone https://github.com/regisb/tutor
cd tutor cd tutor
pip install -e . 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>