CLI 參考
所有指令與旗標的詳細說明。
執行 tmaegis <command> --help 可取得您所安裝版本的權威說明。
全域旗標
| 旗標 | 說明 |
|---|---|
-c, --config | 設定檔路徑(預設 config.yaml) |
-r, --rules-dir | 包含 YAML 規則的目錄(預設 ./rules) |
--lang | 介面語言,BCP 47 標籤,例如 en-US、vi 或 sr-Cyrl。預設:依系統偵測。 |
--ai-provider | 覆蓋 AI 提供者:ollama、claude、openai 或 gemini |
--os-family | 覆蓋偵測到的作業系統系列,例如 ubuntu-24.04。* 會執行所有系列的規則。 |
tmaegis scan
稽核系統。唯讀。
| 旗標 | 說明 |
|---|---|
--auto-detect | 偵測作業系統與已安裝的軟體,僅執行相符的規則 |
-t, --target | 平台篩選,例如 linux、windows、postgres、aws(預設 all) |
-l, --level | CIS 設定檔等級,1 或 2(預設 1) |
-f, --format | text、json、jsonl、sarif、asff、csv、html、xlsx 或 pdf |
-o, --output | 將報告寫入檔案(xlsx 與 pdf 必須指定) |
--include-manual | 同時將人工複查建議以 SKIP 形式連同操作說明一併列出 |
--device-config | 稽核匯出的網路設備設定 |
--ai-analyze | 請 AI 提供者評估修補的影響 |
--plugin | 以逗號分隔的掃描後外掛程式 |
--push-url | 將 JSON 報告傳送到 tmaegis-server(權杖來自 TMAEGIS_SERVER_TOKEN) |
-q, --quiet | 不顯示橫幅 |
tmaegis apply
修補未通過的控制項。會先建立快照。
| 旗標 | 說明 |
|---|---|
--auto-detect, -t, -l | 與 scan 相同的選取旗標 |
--dry-run | 顯示將要變更的內容,但不修改系統 |
--deadman-timeout | 自動復原前等待確認的秒數(預設 60,0 表示停用) |
--no-confirm | 略過確認提示,適用於 CI |
--auto-rollback | 修補或其驗證失敗時自動復原(預設開啟) |
--terraform-out | 將針對雲端發現項提出的 Terraform 寫入目錄 |
tmaegis rollback
| 旗標 | 說明 |
|---|---|
--list | 列出快照並結束 |
--id | 要還原的快照(預設:最新的) |
其他指令
| 指令 | 說明 |
|---|---|
tmaegis discover [--json] | 顯示偵測到的作業系統與已安裝的軟體 |
tmaegis rules export [-o file] | 將規則目錄匯出為 JSON |
tmaegis plugin install|list | 管理外掛程式 |
tmaegis lang | 列出支援的語言 |
結束碼與 CI
使用 --format sarif 可將結果送入 GitHub 的 Security 分頁,使用 --no-confirm 可進行非互動式修補。您所用版本的結束碼行為請查看 tmaegis scan --help。