CLI リファレンス

cgf バイナリが正準の入口です。すべてのコマンドは @/lib/cgf の TypeScript API としても利用できます — CLI は薄い殻に過ぎません。

概要

cgf <command> [args] [flags]

全機能は cgf --help で参照できます。本ページは規範的な一覧です。

コマンド

cgf ingest [root]                          プロジェクトからグラフを構築
cgf check  [root] [--format md|sarif]      クレーム・パックを実行
cgf narrative [root] [--format md|html]    人間向けドシエをレンダリング
cgf bundle [root] --out <file>             .cgfevidence を構築
           [--sign --tsa <url>]
cgf sign   <file>                          既存のバンドルに署名を追加
cgf verify <file>                          暗号検証
cgf verify-policy <file> [--preset <id>]   暗号 + ポリシー検証
cgf inspect <file>                         読み取り専用の検査
cgf bundle-diff <baseline> <head>          構造化された差分
cgf doctor [root] [--bundle <file>]        端から端までのヘルスチェック
cgf trust  add-key | list-keys | remove-key
           add-tsa | list-tsas | remove-tsa
           export | import [--mode merge|replace]

共通フラグ

フラグ意味
--out <file>bundle / narrative の出力先。
--format md|sarifcheck の出力形式。
--format md|htmlnarrative の出力形式。
--sign有効な鍵でバンドルに署名する。
--tsa <url>この TSA から RFC 3161 タイムスタンプを付与する。
--preset <id>検証時に名前付きポリシー・プリセットを適用する。

端から端まで

# 1. プロジェクトを発見する
cgf ingest                              # → .cgf/graph.json

# 2. クレーム・パックを走らせる
cgf check                               # → .cgf/check.{txt,md}
cgf check --format sarif > check.sarif  # CI 向け出力

# 3. 人間向けドシエをレンダリングする
cgf narrative --format md  > dossier.md
cgf narrative --format html > dossier.html

# 4. 署名済みバンドルとして封印、タイムスタンプ付き
cgf bundle --out dossier.cgfevidence \
           --sign --tsa https://freetsa.org/tsr

# 5. 別マシンで検証する
cgf verify dossier.cgfevidence

# 6. 厳格なポリシーで検証する
cgf verify-policy dossier.cgfevidence --preset eu-ai-act-high-risk

# 7. 二つのリリースを比較する
cgf bundle-diff baseline.cgfevidence head.cgfevidence

# 8. 一発で健全性チェック
cgf doctor --bundle dossier.cgfevidence

終了コード

コード意味
0成功 / pass
1運用エラー(パス誤り、不正なファイル、IO)
2暗号失敗(署名不正、ハッシュ破損、無効な TSA)
3ポリシー違反(署名は良好だがポリシー未充足)
4クレーム・パック失敗(クレーム付きの check / verify-policy

CI パイプラインは通例 1234fail し、SARIF または check.md をビルド成果物として表面化させます。

次に読むもの