インスタンスへの接続
API URL を設定
Kodus API の場所を CLI に伝えます。方法を1つ選択してください:永続的にするために、シェルプロファイル(優先順位:
- 環境変数(推奨)
- 設定ファイル
- インライン(一回限り)
~/.bashrc、~/.zshrc など)に追加:KODUS_API_URL 環境変数 > ~/.kodus/config.json の apiUrl > デフォルト(https://api.kodus.io)。認証
- チームキー(推奨)
- 個人ログイン
- CI/CD トークン
セルフホスト型 Kodus ダッシュボードからチームキーを生成して設定:または API URL とチームキーの両方でインストーラーを使用:
Cloudflare Access(Zero Trust)
セルフホスト型 API が Cloudflare Access の背後にある場合、CLI はサービストークン認証をサポートします。- 環境変数
- 設定ファイル
CF-Access-Client-Id と CF-Access-Client-Secret ヘッダーを送信します。優先順位: 環境変数 > 設定ファイル。
設定ファイルリファレンス
CLI は~/.kodus/config.json に設定を保存します:
| フィールド | 必須 | 説明 |
|---|---|---|
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_ID | Cloudflare Access クライアント ID |
CF_ACCESS_CLIENT_SECRET | Cloudflare Access クライアントシークレット |
KODUS_VERBOSE | 解決された API URL とリクエスト詳細を表示するには true に設定 |
CI/CD 統合
CI/CD パイプラインのセルフホスト型インスタンスでは、API URL と認証を環境変数として設定します:- GitHub Actions
- GitLab CI
- 汎用
チームへの配布
1つのコマンドでチームをオンボーディングするには、API URL とスキルインストーラーを組み合わせます:トラブルシューティング
セキュリティエラー: API URL は HTTPS プロトコルを使用する必要があります
セキュリティエラー: API URL は HTTPS プロトコルを使用する必要があります
CLI はすべての非 localhost URL に対して HTTPS を要求します。セルフホスト型インスタンスに有効な TLS 証明書があることを確認してください。ローカルでテストしている場合は、代わりに
http://localhost:<port> を使用してください。接続拒否またはタイムアウト
接続拒否またはタイムアウト
- URL に到達できることを確認:
curl -I https://kodus-api.yourcompany.com - ファイアウォールまたは VPN が接続をブロックしていないか確認
- Cloudflare Access の背後にある場合は、
CF_ACCESS_CLIENT_IDとCF_ACCESS_CLIENT_SECRETが設定されていることを確認 --verboseで使用されている正確な URL を確認
認証失敗(401)
認証失敗(401)
kodus auth statusで現在の認証状態を確認- チームキーを使用している場合は、セルフホスト型ダッシュボードで有効であることを確認
- 個人ログインを使用している場合、トークンは1時間後に期限切れになります — CLI は自動更新しますが、リフレッシュトークンも期限切れになった場合は再ログインが必要な場合があります
KODUS_API_URLが正しいインスタンスを向いていることを確認
API が無効なレスポンスを返した(JSON が期待されたが HTML が返された)
API が無効なレスポンスを返した(JSON が期待されたが HTML が返された)
これは通常、URL が実際の API の代わりにリバースプロキシ、ロードバランサー、または Cloudflare Access ページに到達していることを意味します。確認事項:
- URL パスが正しいこと(
/apiや類似の余計なパスなし) - 該当する場合、Cloudflare Access の資格情報が設定されていること
- リバースプロキシがリクエストを正しく転送していること
デバイス制限に達しました
デバイス制限に達しました
セルフホスト型インスタンスは組織ごとにデバイス制限を強制する場合があります。制限を増やすか、ダッシュボードから古いデバイスを削除するよう管理者に連絡してください。