Getting Started

インストール

# ソースからビルド（Rust 1.81+ が必要）
cargo build --release -p aaai-cli -p aaai-gui

# バイナリを PATH に追加（例）
cp target/release/aaai ~/.local/bin/
cp target/release/aaai-gui ~/.local/bin/

初回セットアップ（推奨: `aaai init`）

新しいプロジェクトでは aaai init が最も簡単な出発点です。

cd /your/project
aaai init

対話的に以下を設定できます。

Before / After フォルダパス
監査定義ファイルの場所
承認者名
初回スナップショットの生成

--non-interactive フラグで CI/スクリプトから使えます。

aaai init --non-interactive --dir /path/to/project

手動セットアップ（ステップバイステップ）

1. 差分テンプレートを生成する

aaai snap --left ./before --right ./after --out audit.yaml

生成された audit.yaml の各エントリに reason フィールドを記入します（空欄のままだと Pending 扱い）。

2. 監査を実行する

aaai audit --left ./before --right ./after --config audit.yaml

PASSED — 全エントリが期待通りに変更されている
FAILED — ルール不一致のエントリがある
PENDING — reason 未記入のエントリがある（--allow-pending で続行可）

3. 問題を確認して修正する

# 差分の詳細を確認
aaai diff --left ./before --right ./after --content

# ベストプラクティスチェック
aaai lint audit.yaml

4. レポートを出力する

# Markdown レポート
aaai report --left ./before --right ./after --config audit.yaml --out report.md

# HTML レポート（ブラウザで開ける）
aaai report --left ./before --right ./after --config audit.yaml \
            --format html --out report.html

GUI を使う

aaai-gui

Opening 画面で Before / After / 定義ファイルを指定して「監査を開始」をクリックします。詳しくは GUI ガイドを参照してください。

.aaai.yaml でデフォルト設定

プロジェクトルートに .aaai.yaml を置くと、よく使うパスと設定を省略できます。

version: "1"
default_definition: "audit/audit.yaml"
default_ignore: "audit/.aaaiignore"
approver_name: "your-name"
mask_secrets: true

# 初期テンプレート生成
aaai config --init

シェル補完のインストール

# Zsh の例
aaai completions zsh > ~/.zfunc/_aaai
echo 'fpath=(~/.zfunc $fpath)' >> ~/.zshrc
source ~/.zshrc

次のステップ

CLI リファレンス — 全コマンドの詳細
監査定義ファイル — YAML フォーマット
内容監査戦略 — None / Checksum / LineMatch / Regex / Exact
CI/CD 統合 — GitHub Actions での使い方
GUI ガイド — 3 ペイン画面の操作方法

Keyboard shortcuts

aaai Documentation