slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;imp: demo: help updates

Browse Source
This commit is contained in:
Simon Michael 2023-03-17 00:53:30 -10:00
parent bbb58c3804
commit 8b2efe3c33
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
hledger/Hledger/Cli/Commands/Demo.md
View File

@ -1,26 +1,27 @@
## demo
Play small demos of hledger usage in the terminal.
Play demos of hledger usage in the terminal, if asciinema is installed.
_FLAGS
Run this command with no argument to list the demos.
To play a demo, write its number or a prefix or substring of its title.
asciinema must be installed.
Tips:
Make your terminal window large enough to see the demo clearly.
During playback, several keys are available:
- SPACE pause/unpause
- . step forward (while paused)
- CTRL-c quit early
SPACE to pause/unpause, . to step forward (while paused),
CTRL-c quit.
asciinema options can be added following a double dash, such as
`-s` (adjust speed) and `-i` (limit idle time).
Run `asciinema -h` to list these.
`-s N` to adjust speed and `-i SECS` to limit pauses.
Run `asciinema -h` to list these options.
Examples:
```shell
$ hledger demo # list available demos
$ hledger demo 1 # play the first demo
$ hledger demo install -s5 -i.5 # play the install demo at 5x speed,
# with pauses limited to half a second.
$ hledger demo # list available demos
$ hledger demo 1 # play the first demo
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
# with pauses limited to half a second
```