aboutsummaryrefslogtreecommitdiffstats
path: root/doc/cli-convention.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cli-convention.md')
-rw-r--r--doc/cli-convention.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/cli-convention.md b/doc/cli-convention.md
new file mode 100644
index 00000000..47eccf69
--- /dev/null
+++ b/doc/cli-convention.md
@@ -0,0 +1,13 @@
+## Pattern
+
+CLI commands should consistently follow this pattern:
+
+```
+xxx --> list xxx things if list, otherwise show one
+xxx new --> create thing
+xxx rm --> delete thing
+xxx show ID --> show one
+xxx show --> show one with "select" implied ID
+xxx yyy --> action commands for that thing, or subcommand
+xxx select|deselect --> select/deselect implied ID
+```