summaryrefslogtreecommitdiff
path: root/examples/completion/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/completion/README')
-rw-r--r--examples/completion/README28
1 files changed, 28 insertions, 0 deletions
diff --git a/examples/completion/README b/examples/completion/README
new file mode 100644
index 0000000..f15654e
--- /dev/null
+++ b/examples/completion/README
@@ -0,0 +1,28 @@
+$ completion
+============
+
+Demonstrates Click's shell completion support.
+
+.. code-block:: bash
+
+ pip install --editable .
+
+For Bash:
+
+.. code-block:: bash
+
+ eval "$(_COMPLETION_COMPLETE=source_bash completion)"
+
+For Zsh:
+
+.. code-block:: zsh
+
+ eval "$(_COMPLETION_COMPLETE=source_zsh completion)"
+
+For Fish:
+
+.. code-block:: fish
+
+ eval (env _COMPLETION_COMPLETE=source_fish completion)
+
+Now press tab (maybe twice) after typing something to see completions.