aboutsummaryrefslogblamecommitdiffstats
path: root/doc/cli-convention.md
blob: 47eccf694a181ba5922e7790ad69bb644030e489 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
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
```