Command Docs

Language

• English command reference: current page
• Traditional Chinese command reference: 繁體中文逐指令說明
• English handbook: Operator Handbook
• Traditional Chinese handbook: 繁體中文手冊

These pages track the current Rust CLI help for the command tree exposed by grafana-util.

Use these pages when you want one stable page per command or subcommand instead of a handbook chapter. The handbook explains workflow and intent; the command pages explain the concrete CLI surface.

Output selector conventions

Many list, review, and dry-run commands support both a long output selector and one or more direct shorthand flags.

Typical patterns:

• --output-format table is usually equivalent to --table
• --output-format json is usually equivalent to --json
• --output-format csv is usually equivalent to --csv
• --output-format yaml is usually equivalent to --yaml
• --output-format text is usually equivalent to --text

Use the long form when you want one explicit flag that is easy to templatize in scripts. Use the short form when you want a faster interactive command line.

Important exceptions:

• some commands only expose a subset of shortcuts
• dashboard topology is different: it supports text, json, mermaid, and dot, but it does not have shortcut flags such as --table
• destination-path flags such as --output-file or --output on draft/export commands are not render-format selectors

If you are unsure, treat the per-command page as authoritative for that exact command surface.

If you prefer man format, render grafana-util(1) locally with man ./docs/man/grafana-util.1 on macOS or man -l docs/man/grafana-util.1 on GNU/Linux. The checked-in docs/man/.1 files are generated from these English command pages via python3 scripts/generate_manpages.py. The checked-in docs/html/commands/en/.html files are generated from the same source via python3 scripts/generate_command_html.py.

Dashboard

• dashboard
• dashboard browse
• dashboard fetch-live
• dashboard clone-live
• dashboard list
• dashboard export
• dashboard raw-to-prompt
• dashboard import
• dashboard patch-file
• dashboard serve
• dashboard edit-live
• dashboard review
• dashboard publish
• dashboard delete
• dashboard diff
• dashboard list-vars
• dashboard governance-gate
• dashboard topology
• dashboard impact
• dashboard history
• dashboard screenshot

Compatibility Pages

These pages document compatibility aliases for dashboard analyze. Prefer the canonical dashboard analyze ... form in new docs and scripts.

• dashboard analyze (local alias)
• dashboard analyze (live alias)

Datasource

• datasource
• datasource types
• datasource list
• datasource browse
• datasource export
• datasource import
• datasource diff
• datasource add
• datasource modify
• datasource delete

Alert

• alert
• alert export
• alert import
• alert diff
• alert plan
• alert apply
• alert delete
• alert add-rule
• alert clone-rule
• alert add-contact-point
• alert set-route
• alert preview-route
• alert new-rule
• alert new-contact-point
• alert new-template
• alert list-rules
• alert list-contact-points
• alert list-mute-timings
• alert list-templates

Access

• access
• access user
• access org
• access team
• access service-account
• access service-account token

Shared Surfaces

• change
• change inspect
• change check
• change preview
• change apply
• change advanced
• change advanced subcommands (summary, plan, review, audit, bundle, promotion handoff)
• overview
• overview live
• status
• status staged
• status live
• profile
• profile list
• profile show
• profile add
• profile example
• profile init
• snapshot
• snapshot export
• snapshot review

Generic Resource Query

• resource
• resource describe
• resource kinds
• resource list
• resource get

The matching manpages live under docs/man/grafana-util-*.1.