From acc9a6f3a6df2961c3ae44352216d915cb9b5315 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Sat, 10 Sep 2022 11:09:19 +0200 Subject: commands: reorg into different packages --- doc/cli-convention.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 doc/cli-convention.md (limited to 'doc/cli-convention.md') 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 +``` -- cgit