メインコンテンツへスキップ
独自のインフラで Kodus を実行している場合、CLI は同じように動作します — API に向けるだけです。

インスタンスへの接続

1

API URL を設定

Kodus API の場所を CLI に伝えます。方法を1つ選択してください:
export KODUS_API_URL=https://kodus-api.yourcompany.com
永続的にするために、シェルプロファイル(~/.bashrc~/.zshrc など)に追加:
echo 'export KODUS_API_URL=https://kodus-api.yourcompany.com' >> ~/.zshrc
source ~/.zshrc
HTTPS が必要です。 CLI はセキュリティのために非 HTTPS URL を拒否します。唯一の例外はローカル開発用の localhost127.0.0.1 です。
優先順位: KODUS_API_URL 環境変数 > ~/.kodus/config.json の apiUrl > デフォルト(https://api.kodus.io)。
2

認証

セルフホスト型 Kodus ダッシュボードからチームキーを生成して設定:
kodus auth team-key --key kodus_xxxxx
または API URL とチームキーの両方でインストーラーを使用:
curl -fsSL https://review-skill.com/install | bash -s -- --team-key kodus_xxxxx
チームキーは共有環境と AI エージェントのセットアップに最適です — 個別ログインは不要です。
3

接続を確認

kodus auth status
認証モード、組織名、トークンが有効であることが表示されるはずです。詳細モードを使用すると、使用されている API URL がログに記録されます:
kodus auth status --verbose

Cloudflare Access(Zero Trust)

セルフホスト型 API が Cloudflare Access の背後にある場合、CLI はサービストークン認証をサポートします。
export KODUS_API_URL=https://kodus-api.yourcompany.com
export CF_ACCESS_CLIENT_ID=your-client-id.access
export CF_ACCESS_CLIENT_SECRET=your-client-secret
設定されると、CLI はすべての API リクエストで CF-Access-Client-IdCF-Access-Client-Secret ヘッダーを送信します。優先順位: 環境変数 > 設定ファイル。

設定ファイルリファレンス

CLI は ~/.kodus/config.json に設定を保存します:
{
  "apiUrl": "https://kodus-api.yourcompany.com",
  "teamKey": "kodus_xxxxx",
  "teamName": "Engineering",
  "organizationName": "Acme Corp",
  "cfAccessClientId": "your-client-id.access",
  "cfAccessClientSecret": "your-client-secret"
}
フィールド必須説明
apiUrlいいえセルフホスト型 API URL。KODUS_API_URL 環境変数で上書き。
teamKeyいいえチーム APIキー(kodus_ で始まる)。KODUS_TEAM_KEY 環境変数で上書き。
teamNameいいえチームの表示名。
organizationNameいいえ組織の表示名。
cfAccessClientIdいいえCloudflare Access クライアント ID。CF_ACCESS_CLIENT_ID 環境変数で上書き。
cfAccessClientSecretいいえCloudflare Access クライアントシークレット。CF_ACCESS_CLIENT_SECRET 環境変数で上書き。
設定ファイルは 0600 パーミッション(所有者の読み取り/書き込みのみ)で作成されます。ディレクトリ ~/.kodus/0700 パーミッションで作成されます。

環境変数サマリー

変数説明
KODUS_API_URLセルフホスト型 API エンドポイント(HTTPS 必須、localhost 除く)
KODUS_TEAM_KEY共有アクセス用チームキー
KODUS_TOKENパイプライン用 CI/CD トークン
CF_ACCESS_CLIENT_IDCloudflare Access クライアント ID
CF_ACCESS_CLIENT_SECRETCloudflare Access クライアントシークレット
KODUS_VERBOSE解決された API URL とリクエスト詳細を表示するには true に設定

CI/CD 統合

CI/CD パイプラインのセルフホスト型インスタンスでは、API URL と認証を環境変数として設定します:
- name: Kodus Review
  env:
    KODUS_API_URL: ${{ secrets.KODUS_API_URL }}
    KODUS_TEAM_KEY: ${{ secrets.KODUS_TEAM_KEY }}
  run: npx @kodus/cli review --format json --fail-on error
重要度の閾値を超える問題が見つかったときにパイプラインを失敗させるには --fail-on error または --fail-on critical を使用してください。

チームへの配布

1つのコマンドでチームをオンボーディングするには、API URL とスキルインストーラーを組み合わせます:
KODUS_API_URL=https://kodus-api.yourcompany.com \
  curl -fsSL https://review-skill.com/install | bash -s -- --team-key kodus_xxxxx
これにより CLI がインストールされ、チームキーが設定され、検出された AI エージェント(Claude Code、Cursor、Windsurf)にレビュースキルがデプロイされます — すべてセルフホスト型インスタンスに向けて。

トラブルシューティング

CLI はすべての非 localhost URL に対して HTTPS を要求します。セルフホスト型インスタンスに有効な TLS 証明書があることを確認してください。ローカルでテストしている場合は、代わりに http://localhost:<port> を使用してください。
  • URL に到達できることを確認: curl -I https://kodus-api.yourcompany.com
  • ファイアウォールまたは VPN が接続をブロックしていないか確認
  • Cloudflare Access の背後にある場合は、CF_ACCESS_CLIENT_IDCF_ACCESS_CLIENT_SECRET が設定されていることを確認
  • --verbose で使用されている正確な URL を確認
  • kodus auth status で現在の認証状態を確認
  • チームキーを使用している場合は、セルフホスト型ダッシュボードで有効であることを確認
  • 個人ログインを使用している場合、トークンは1時間後に期限切れになります — CLI は自動更新しますが、リフレッシュトークンも期限切れになった場合は再ログインが必要な場合があります
  • KODUS_API_URL が正しいインスタンスを向いていることを確認
これは通常、URL が実際の API の代わりにリバースプロキシ、ロードバランサー、または Cloudflare Access ページに到達していることを意味します。確認事項:
  • URL パスが正しいこと(/api や類似の余計なパスなし)
  • 該当する場合、Cloudflare Access の資格情報が設定されていること
  • リバースプロキシがリクエストを正しく転送していること
セルフホスト型インスタンスは組織ごとにデバイス制限を強制する場合があります。制限を増やすか、ダッシュボードから古いデバイスを削除するよう管理者に連絡してください。