Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
USAGE
## USAGE

```
graf [-h|--help] <-u USER:PASS|-t TOKEN> URL [--from FROM] [--to TO] [--interval SECS] [-f]

select and print grafana dashboard panel to terminal
@@ -11,8 +12,13 @@ graf [-h|--help] <-u USER:PASS|-t TOKEN> URL [--from FROM] [--to TO] [--interval
time specifiers for grafana (defaults to now-1m, now)
INTERVAL interval in seconds between frames (defaults to <terminal rows> / TO-FROM)
-f follow, update data every INTERVAL seconds
```

EXAMPLE
## EXAMPLE

[![asciicast](https://asciinema.org/a/568183.svg)](https://asciinema.org/a/568183)

<!-- -------------- offline example (no pretty colours for you) -----------------

$ graf http://localhost:3000 -u admin:admin --from now-1m -f
0 - title="dash" uid="2qZKhw-4z"
@@ -43,3 +49,5 @@ Please select a panel: 1
| | | | | |'-----. | '.
^C
$

-->