diff options
| author | Michael Muré <batolettre@gmail.com> | 2022-09-10 11:09:19 +0200 |
|---|---|---|
| committer | Michael Muré <batolettre@gmail.com> | 2022-11-20 17:18:09 +0100 |
| commit | acc9a6f3a6df2961c3ae44352216d915cb9b5315 (patch) | |
| tree | e159372673104ade1f15ddc1a84aa9da93e93552 /doc/cli-convention.md | |
| parent | a3fa445a9c76631c4cd16f93e1c1c68a954adef7 (diff) | |
| download | git-bug-acc9a6f3a6df2961c3ae44352216d915cb9b5315.tar.gz | |
commands: reorg into different packages
Diffstat (limited to 'doc/cli-convention.md')
| -rw-r--r-- | doc/cli-convention.md | 13 |
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 +``` |