Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
spacez320 committed Feb 9, 2024
1 parent 92c26da commit 4e896c7
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ Cryptarch's interactive window. The examples above use stream displays.

![Demo of graph display](https://raw.githubusercontent.com/spacez320/cryptarch/master/media/graph-display.gif)

### Persistence

Cryptarch, by default, will store results and load them when re-executing the same query. Storage is
located in the user's cache directory.

See: <https://pkg.go.dev/os#UserCacheDir>

### More Examples

> The examples below have been tested on `GNU bash, version 5.2.15(1)-release`.
Expand All @@ -56,11 +63,11 @@ Cryptarch's interactive window. The examples above use stream displays.
# See help.
cryptarch -h

# Execute `whoami` once, printing results to the console.
# Execute `whoami` once, printing results to the console and waiting for a user to `^C`.
cryptarch -q 'whoami'

# Execute `uptime` continuously, printing results to the console.
cryptarch -q 'uptime' -t -1
# Execute `uptime` continuously, printing results to the console, without using persistence.
cryptarch -q 'uptime' -t -1 -e=false

# Get the size of an NVME used space and output it to a table.
cryptarch -q 'df -h | grep nvme0n1p2 | awk '\''{print $3}'\''' -r 3 -v "NVME Used Space" -t -1
Expand Down

0 comments on commit 4e896c7

Please sign in to comment.