指令詳細說明
語言切換
- 繁體中文指令詳細說明:目前頁面
- English command reference: 英文指令總索引
- 繁體中文手冊:維運手冊
- English handbook: Operator Handbook
這個目錄收錄 grafana-util 各個 command 與 subcommand 的獨立頁面。 如果手冊章節是幫你理解整體工作流程,這裡就是用來查實際語法、常用旗標,以及相近命令差在哪裡的地方。
輸出旗標慣例
很多 list、review、dry-run 類指令,同時支援完整寫法與較短的快捷旗標。
常見對應關係:
--output-format table通常等於--table--output-format json通常等於--json--output-format csv通常等於--csv--output-format yaml通常等於--yaml--output-format text通常等於--text
如果你是在腳本、CI 或範本裡統一帶參數,建議優先用完整寫法。 如果你是在終端直接操作,快捷旗標會比較省事。
但也有幾個重要例外:
- 有些指令只支援部分快捷旗標,不一定每種格式都有短寫
dashboard topology是特例:它支援text、json、mermaid、dot,但沒有--table這類快捷旗標--output-file,或某些匯出 / draft 指令裡的--output,代表的是輸出檔案路徑,不是輸出格式
所以如果你要確認某一條指令到底支援哪些格式,還是以該指令頁面為準。
如果你是從繁體中文手冊進來,建議這樣使用:
| 你要查什麼 | 建議閱讀順序 |
|---|---|
| 先理解功能目的和操作流程 | 先讀 docs/user-guide/zh-TW/ 對應章節 |
| 需要查某個 command 或 subcommand 怎麼用 | 直接進這裡的繁中指令頁 |
| 想核對目前 Rust CLI help 的實際語法 | 以這裡的指令頁為主,必要時再對照英文頁 |
如果你習慣用 man 格式閱讀頂層命令,macOS 可執行 man ./docs/man/grafana-util.1,GNU/Linux 可執行 man -l docs/man/grafana-util.1。
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
相容別名頁面
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
共用介面
- change
- change inspect
- change check
- change preview
- change apply
- change advanced
- change advanced 子指令(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