メインコンテンツへスキップ
このガイドでは、5分以内にゼロからレビュー済みの差分まで到達できます。
1

インストール

CLI をインストールし、検出されたすべての AI エージェント（Claude Code、Cursor、Codex、Windsurf）に Kodus スキルをデプロイします:
curl -fsSL https://review-skill.com/install | bash
Node.js >= 20.0.0 が必要です。
インストールを確認:
kodus --version
kodus status
2

認証

状況に合ったパスを選択してください。認証をスキップして kodus review を直接実行することもできます — トライアルモードで1日の制限内で動作します。
個人アカウントでサインイン:
kodus auth login
トークンは ~/.kodus/credentials.json に保存され、自動的に更新されます。
Kodus をセルフホストしていますか? 認証前に CLI を API に向けてください:
export KODUS_API_URL=https://kodus-api.yourcompany.com
localhost 以外では HTTPS が必要です。
認証状態を確認:
kodus auth status
3

最初のレビューを実行

コミットされていない変更がある任意の git リポジトリ内で:
kodus review
CLI は作業ツリーの差分を分析し、サマリーを出力し、（インタラクティブモードで）ファイルごとに閲覧し、提案された修正をプレビューして適用できます。よく使うバリエーション:
kodus review --staged             # ステージングされたファイルのみ
kodus review --branch main        # 現在のブランチを main と比較
kodus review --commit abc123      # 単一のコミットを分析
kodus review --fix                # 修正可能な問題を全て自動適用
kodus review --prompt-only        # AI エージェント向けコンパクト出力
kodus review --fail-on error      # エラーレベル以上でゼロ以外で終了（CI 対応）
作業ツリーレビュー（デフォルト）と --staged は、バックエンドがコミットされていない変更を確認できるようにファイルの内容をインライン化します。--branch と --commit モードは、バックエンドが自分でそれらのコミットをフェッチできるためインライン化をスキップします — これが、それらのモードが巨大なブランチでうまく機能する理由です。
4

次のステップを選択

目標に応じて:

プッシュごとに自動化

kodus hook install で pre-push フックをインストール。

CI でレビューを実行

GitHub Actions、GitLab CI、汎用パイプラインの例。

AI エージェントに接続

自律的な修正ループのために --prompt-only を Claude Code、Cursor、または Codex に渡す。

リポジトリを設定

CLI から無視ファイル、ベースブランチ、レビュー設定を管理。

​
環境変数

これらの環境変数は全てのコマンドにわたって CLI を設定します。
変数説明
KODUS_API_URLAPI エンドポイント（デフォルト: https://api.kodus.io）
KODUS_TEAM_KEY共有アクセスと AI エージェント用チームキー
KODUS_TOKENkodus auth token で生成した CI/CD トークン
KODUS_VERBOSE詳細出力には true に設定
KODUS_SKIP_HOOK単一の git push の pre-push フックをスキップするには 1 に設定
KODUS_REQUEST_TIMEOUT_MINリクエストごとのタイムアウト（分）（デフォルト: 60）
CF_ACCESS_CLIENT_IDCloudflare Access クライアント ID（Zero Trust の背後にある API）
CF_ACCESS_CLIENT_SECRETCloudflare Access クライアントシークレット
セルフホストのセットアップ、トークン、Cloudflare Access については セルフホストセットアップ を参照してください。

​
トラブルシューティング

エラーが発生しましたか? 一般的な症状と修正方法については トラブルシューティングガイド を確認してください。