CLI Auth

このページは、sf CLI の認証状態を確認したり、API key を更新したりするときの reference です。初回設定だけなら CLI Connection Settings で十分です。

公開利用では、接続先は https://signal-foundry.app に揃えます。API key は API キー設定画面で発行し、CLI の隠し入力に貼り付けます。

初期設定

sf auth setup --base-url https://signal-foundry.app
sf auth show --json

すでに API キー設定画面を開いている場合:

sf auth setup --base-url https://signal-foundry.app --no-open
sf auth show --json

API key は docs、prompt、shell history、agent の会話ログには書かないでください。sf auth setup の隠し入力を使います。

接続状態を見る

auth show --json の代表的な出力は次です。

{
  "storedApiKeyPreview": "sf_liv...4E0E",
  "storedBaseUrl": "https://signal-foundry.app",
  "effectiveApiKeyPreview": "sf_liv...4E0E",
  "effectiveBaseUrl": "https://signal-foundry.app",
  "configPath": "/Users/you/.config/signal-foundry/config.json"
}

まず見る key:

• effectiveBaseUrl
• effectiveApiKeyPreview
• configPath

effectiveBaseUrl が https://signal-foundry.app で、API key preview が表示されていれば、CLI は production API に接続できます。

よく使う auth コマンド

sf auth --help
sf auth setup --base-url https://signal-foundry.app
sf auth show --json
sf auth set-base-url https://signal-foundry.app
sf auth clear-api-key
sf auth clear-base-url

通常は setup と show だけで足ります。clear-* は、別 account の API key を入れてしまったときや、接続先を作り直すときに使います。

API key を更新する

API key を rotate した後は、CLI 側の保存値も更新します。

sf auth setup --base-url https://signal-foundry.app --no-open
sf auth show --json

古い key が残っているか不安な場合は、いったん消してから設定します。

sf auth clear-api-key
sf auth setup --base-url https://signal-foundry.app --no-open
sf auth show --json

agent ごとに設定を分ける

Codex、Claude Code、CI job で別の API key を使う場合は、config path を分けます。

export SIGNAL_FOUNDRY_CONFIG_PATH="$PWD/.signal-foundry/config.json"
sf auth setup --base-url https://signal-foundry.app
sf auth show --json

この環境変数は現在の shell だけに効きます。別 terminal で同じ設定を使う場合は、同じ SIGNAL_FOUNDRY_CONFIG_PATH をもう一度設定してください。

うまくいかないとき

Preview URL は、公開利用の接続先にしません。公開 docs の手順では https://signal-foundry.app を使います。