matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Add notes on CLI conventions

Browse source 
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
This commit is contained in:
Matthias Beyer 2018-12-05 16:02:12 -08:00
parent 5775a3461a
commit 73d8d54528
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/src/03010-conventions.md
View file

@ -91,6 +91,7 @@ whether the functionality could be outsourced to a more general
All libraries should be tested as much as possible. Sometimes it may not be All libraries should be tested as much as possible. Sometimes it may not be
possible without a lot of effort, but still: more tests = better! possible without a lot of effort, but still: more tests = better!
## Commandline tools ## Commandline tools
The commandline tools are the CLI-frontends for their respective libraries. The commandline tools are the CLI-frontends for their respective libraries.
@ -99,10 +100,15 @@ So `libimagdiary` has a CLI frontend `imag-diary`.
Those CLI frontends use functionality from `libimagrt` to build a Those CLI frontends use functionality from `libimagrt` to build a
commandline interface which is consistent with the rest of the ecosystem. commandline interface which is consistent with the rest of the ecosystem.
Commandline interfaces should receive store IDs as positional arguments. Commandline applications use the runtime interfaces for receiving IDs from the
Commandline interfaces should also provide a flag "-I" (that's a big i) which CLI or IDs which are piped into the application.
marks that the store IDs shall be read from stdin and are not passed via the Commandline applications use the 'stdin'/'stdout'/'stderr' wrappers provided by
commandline. the runtime (see section below).
Commandline applications are _only_ interactive when specified by the user
(normally via a `--interactive` flag). An application _must_ provide the full
functionality via its commandline interface, thus it is not allowed to provide
functionality which is only usable in interactive mode.
### IO ### IO