AIGate 運用ドキュメント

概要

これまでに構築したもの

AIGate は、ローカル変更、secret リスク、プロジェクト基盤スコア、PR 準備状況、リリース準備状況を確認する CLI です。

パッケージは npm で aigate-cli として公開されており、GitHub tag と npm Trusted Publishing による自動リリースが可能です。

Codex、Gemini、Claude Code が同じリポジトリ規則を守れるように、AI assistant 向け統合ファイルも生成できます。

npm

インストールとクイックスタート

グローバルインストールなしでも npx ですぐに実行できます。

npm install -g aigate-cli
aigate --version
aigate check

npx aigate-cli check

プロセス

全体運用プロセス

AIGate はローカル開発から PR、CI、リリース、npm 公開まで同じ品質ゲートでつなぎます。

プロセス

状況別の使用例

AIGate は常に同じコマンドを実行する道具ではなく、リポジトリの状態とリスクに応じて短いルーティンを選ぶための道具です。

状況

リポジトリへ初めて導入するとき

プロセス

デフォルト設定を選び、不足している文書、AI 指示、hook を段階的に作成します。

コマンド例

aigate start --route default --ask-steps
aigate doctor
aigate install-hook --pre-push

状況

AI が多くのファイルを変更した後

プロセス

変更ファイルと secret リスクを先に確認し、失敗したテストは AI 修正プロンプトに変換します。

コマンド例

aigate check
aigate test
aigate aitest

状況

PR を作成する直前

プロセス

ローカル gate を通し、保護付き wrapper で push し、レビュー担当者向けの文脈を作ります。

コマンド例

aigate git-ready
aigate push -u origin feature/my-work
aigate pr-check

状況

private GitLab monorepo

プロセス

profile を固定し、turbo 実行環境を確認して workspace test に切り替え、GitHub/npm パッケージ検査を app score から外します。

コマンド例

aigate setup --hosting gitlab --ci-provider gitlab --project-type app --package-manager pnpm
aigate test
aigate evaluate-project

状況

オープンソース公開準備

プロセス

公開貢献ファイルを作成し、リポジトリ基盤スコアを確認します。

コマンド例

aigate start --route oss --owner @team
aigate evaluate-project --deep --report
aigate github setup --dry-run

状況

リリース前後

プロセス

tag/npm 準備状況を確認し、CI を実行し、公開後の状態トレンドを記録します。

コマンド例

aigate release-check --npm
npm run ci
aigate trends record

状況

ローカル状態を消す、または外すとき

プロセス

削除対象を先にプレビューし、正しいときだけ --force で適用します。

コマンド例

aigate clean
aigate clean --force
aigate uninstall --force

リリース

リリース自動化チャート

初回公開後は、バージョン更新と tag push が主なリリーストリガーです。

コマンド

コマンドマップ

セットアップ

startstart --route defaultstart --route ossinitresetsetupsettingsintegrate

初回実行

doctordemoinstall-hook

保護ゲート

checktestaitestgit-readypushpr

メンテナンス

cleanuninstalldelete

レポート

ai reportpr-checkgithub commentgithub checkgithub setuptrendsreportevaluate-projectverify-enforcementcompliance-reportdashboardaudit-report

リリース

release-checkrelease-check --npmbranch-strategybranch-strategy --comparenotify

コマンド

コマンド一覧と利用タイミング

コマンド	目的	使う場面
`npm install -g aigate-cli`	CLI をグローバルにインストールします。	初回セットアップ
`npx aigate-cli check`	インストールせずに現在のリポジトリを確認します。	試用または CI 前確認
`aigate start`	矢印キーまたは --route でガイド付き設定ルートを実行します。	プロジェクトに AIGate を導入するとき
`aigate start --route default --ask-steps`	推奨設定手順を実行するか一つずつ確認します。	初回設定で必要な手順だけ選びたいとき
`aigate start --route default --steps init,repo-files`	指定した設定手順 ID だけを実行し、他はスキップします。	オンボーディングや手順書で同じ設定を繰り返すとき
`aigate start --route oss --owner @team`	README、貢献文書、issue テンプレート、PR テンプレート、CODEOWNERS を作成します。	公開コントリビューション導線を開くとき
`aigate start --route ai --provider all`	AIGate 設定と Codex/Gemini/Claude 指示ファイルを作成します。	AI assistant の規則をまとめて入れるとき
`aigate init`	基本設定とレポート用フォルダを作成します。	新しいプロジェクトに導入するとき
`aigate reset`	AIGate 設定、settings、レポート placeholder を再作成します。	ローカル設定を初期状態に戻すとき
`aigate clean --force`	生成済み AIGate レポートとローカル状態を削除します。	レポートと generated state を空にするとき
`aigate uninstall --force`	AIGate 設定、.aigate ディレクトリ、AIGate 所有 hook を削除します。	プロジェクトから AIGate を外すとき
`aigate setup --language <en\|ko\|ja\|zh>`	CLI 出力言語を保存します。	チームの出力言語をそろえるとき
`aigate setup --hosting gitlab --ci-provider gitlab`	GitLab project profile を保存します。	GitHub 前提が合わない内部 GitLab app
`aigate settings`	現在の AIGate 設定を表示します。	設定確認
`aigate doctor`	初回実行環境、Git hook、プロジェクト基盤を診断します。	初回実行またはリポジトリ確認
`aigate demo`	ファイルを変更せず AIGate の利用フローを表示します。	CLI の試用やチーム説明
`aigate install-hook --pre-push`	git push 前に git-ready を実行する pre-push hook をインストールします。	危険な push をローカルで防ぐとき
`aigate check`	変更ファイル、実際の secret finding、機密ファイル削除状態を要約します。	軽いコミット前確認
`aigate test`	Git readiness と root script、turbo task、pnpm workspace、workspace package test command を検出して実行します。turbo runner がない場合は workspace script に切り替えます。	実際のテストまで確認してから commit するとき
`aigate ai report`	現在の問題、良い点、方向性、AI 引き継ぎプロンプトをまとめます。	AI にプロジェクト改善を任せる前
`aigate ai report --apply --provider codex`	AI プロジェクトブリーフを AI CLI に渡し、agent 出力をリアルタイム表示して stdout/stderr をレポートに残します。	AI 自動化を明示的に許可するとき
`aigate aitest`	失敗したテストから AI 修正プロンプトを作成します。	失敗を AI agent に渡すとき
`aigate aitest --apply --provider codex`	AI CLI を呼び出し、実行ログ、終了コード、stdout、stderr を表示します。	AI 修正を明示的に許可するとき
`aigate git-ready`	テスト、secret scan、プロジェクトスコアを含むゲートを実行します。	コミットまたは push 前
`aigate push -u origin <branch>`	ゲート通過後に git push を実行します。	ブランチをリモートへ送るとき
`aigate pr-check`	PR 準備レポートを生成します。	PR 説明を書く前
`aigate pr --title "..."`	GitHub CLI で PR を作成します。	ブランチ push 後
`aigate github comment --pr <number>`	PR に AIGate summary comment を投稿します。	レビュー担当者に gate 結果を残すとき
`aigate github check --format json`	GitHub Checks/Actions summary payload を生成します。	CI で AIGate 状態を表示するとき
`aigate github setup --owner @team`	PR テンプレートと CODEOWNERS を設定します。	公開コントリビューション導線を整えるとき
`aigate trends record`	プロジェクト状態スナップショットを記録します。	リリース前後の状態推移を残すとき
`aigate trends show`	記録済み状態トレンドを要約します。	チームレビューや週次確認
`aigate report --format markdown`	ローカルワークフローレポートを出力します。	状態共有
`aigate report --format sarif`	secret finding を SARIF で出力します。	セキュリティツール連携
`aigate evaluate-project`	リポジトリ基盤をスコア化します。	公開準備レビュー
`aigate evaluate-project --deep --report`	Git signal を含む詳細レポートを生成します。	リリースまたは定期レビュー
`aigate verify-enforcement --apply`	GitHub/GitLab API でサーバー側 AIGate 必須チェックを検証し、検証証拠を記録します。	CI が本当に merge を止めるか確認するとき
`aigate compliance-report`	コンプライアンス統制レポートを生成します。	監査と運用準備の共有
`aigate dashboard`	ローカル HTML ヘルスダッシュボードを書き込みます。	self-hosted reporting の開始
`aigate branch-strategy`	チームとリリース頻度に合うブランチ戦略を推薦します。	ブランチポリシー設計
`aigate branch-strategy --compare`	複数のブランチ戦略提案をスコア、強み、リスク、移行手順で比較します。	チームに合うブランチモデルを選ぶとき
`aigate branch-strategy --apply`	ブランチポリシー、release、hotfix、PR、CODEOWNERS、ポリシーパックの草案を生成します。	ポリシーファイル作成時
`aigate integrate all`	Codex、Gemini、Claude Code 統合ファイルを生成します。	AI assistant の規則をそろえるとき
`aigate release-check`	パッケージ、workflow、tag の準備状態を確認します。	リリース tag 作成前
`aigate release-check --npm`	repository profile を検出し、npm registry/GitHub/GitLab/package manager 状態を確認し、app に不要な npm/package version gate を除外します。	自動公開の前後
`aigate audit-report`	ガバナンスとポリシー状態を要約します。	運用監査と公開準備レビュー
`aigate notify send --channel terminal`	ローカル通知イベントを出力します。	ゲートブロック確認
`aigate git-ready --notify-channel slack`	BLOCK 時に Slack webhook 通知を送信します。	secret や高リスク変更でゲートが止まるとき
`aigate notify test --channel slack`	Slack、Discord、Teams、email、Linear、Jira payload をテストします。	チームチャンネル連携の確認

Git

ブランチとデリバリーの流れ

main は保護された安定ブランチです。作業は codex/*、feature/*、fix/*、docs/*、chore/* で行い、PR 経由で main に入れます。release/* と hotfix/* はリリース安定化と緊急修正用です。

npm install -g aigate-cli
aigate setup --language ja
aigate ai report
aigate start --route default --ask-steps
aigate start --route oss --dry-run
aigate reset --dry-run
aigate clean
aigate start --route ai --provider all
git switch -c feature/my-change
aigate doctor
aigate install-hook --pre-push
aigate test
aigate aitest
aigate git-ready
git add <files>
git commit -m "feat: short summary"
aigate push -u origin feature/my-change
aigate pr-check --output .aigate/reports/pr.md
aigate pr --title "feat: short summary"
aigate github comment --pr <number>
aigate github check --output .aigate/reports/github-check.md
aigate trends record
aigate branch-strategy --compare
aigate github setup --owner @your-org/team --dry-run
aigate release-check --npm

機能

現在実装済みの機能

npm パッケージ aigate-cli の公開と npx 実行

Git 変更と untracked ファイルの readiness check

aigate start によるガイド付き開始ルート

aigate start --route default による段階的なデフォルト設定

aigate reset、clean、uninstall による初期化と削除コマンド

aigate start --route oss によるオープンソース初期ファイル生成

aigate test による turbo 実行環境を確認した root/workspace プロジェクトテスト自動化

pnpm-workspace.yaml、package.json workspaces、apps/*、packages/* test detection と切り替え

aigate ai report による AI プロジェクト状態ブリーフ

aigate aitest による AI 修正プロンプト、リアルタイム agent ログ、任意の agent 実行

doctor、demo、install-hook による初回実行 UX

doctor による generatedBy version drift warning

pre-push Git hook のインストール

doctor と evaluate-project による advisory/partial/verified server-enforced AIGate 診断

verify-enforcement による GitHub/GitLab server enforcement のライブ検証と証拠記録

検証済み server enforcement がなく AIGate CI gate だけがある場合の evaluate-project A グレード上限

secret パターン検出と SARIF 出力

git-ready、保護付き push、保護付き PR 作成

GitHub PR comment と GitHub Checks summary payload

PR テンプレートと CODEOWNERS のガイド付き設定

再利用可能な公開 GitHub Action

プロジェクト状態トレンド履歴

private app、GitLab、pnpm の自動検出と profile 固定

doctor、AI 指示、branch strategy policy pack 全体の GitHub/GitLab profile 整合性

Markdown、HTML、JSON、SARIF レポート

コンプライアンスレポートとローカル HTML ヘルスダッシュボード

プロジェクトスコアと deep Git signal 評価

ブランチ戦略推薦、提案比較、ポリシーパック生成

Codex/Gemini/Claude Code 統合ファイル生成

韓国語/英語/日本語/中国語 CLI 設定

release-check と app profile 対応 release-check --npm

Trusted Publishing による npm 自動リリース

GitHub CI、OpenSSF Scorecard、GitHub Release 運用

ターミナル、Slack BLOCK、Discord、Teams、email、Linear、Jira 通知

GHCR Docker image と Homebrew tap の公開配布

機能

今後実装する機能

製品レベルの Slack BLOCK 通知 UX

中央通知ポリシー強化

Linear/Jira workflow integrations の深化

standalone binary 配布

組織ダッシュボード

SSO/SAML、エンタープライズガバナンス