imag/doc/user/src/examples.md
Matthias Beyer db3bb95227 Add user documentation
This patch adds user documentation in for of a mdbook, using a travis
job for running the build of the book in CI to be sure it builds
properly.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-09-01 13:37:05 +02:00

22 lines
519 B
Markdown

# Examples
imag commands can be chained by piping the output.
This can be used to create, tag and categorize an entry in one step.
```
imag log --to personal "Some personal note" | \
imag tag add foobar | \
imag category set somecategory
```
imag can be configured to use aliases for module commands, so combining a basi
alias `alias i=imag` with imag module aliaes, this can be condensed to:
```
i l --to personal "Some personal note" | \
i t add foobar | \
i c set somecategory
```
for example.