summaryrefslogtreecommitdiffstats
path: root/third_party/python/Click/examples/aliases/README
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/python/Click/examples/aliases/README')
-rw-r--r--third_party/python/Click/examples/aliases/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/third_party/python/Click/examples/aliases/README b/third_party/python/Click/examples/aliases/README
new file mode 100644
index 0000000000..5a4a066566
--- /dev/null
+++ b/third_party/python/Click/examples/aliases/README
@@ -0,0 +1,17 @@
+$ aliases_
+
+ aliases is a fairly advanced example that shows how
+ to implement command aliases with Click. It uses a
+ subclass of the default group to customize how commands
+ are located.
+
+ It supports both aliases read from a config file as well
+ as automatic abbreviations.
+
+ The aliases from the config are read from the aliases.ini
+ file. Try `aliases st` and `aliases ci`!
+
+Usage:
+
+ $ pip install --editable .
+ $ aliases --help