Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
CLI

CLI 認証

sf CLI の ログイン、接続確認、エージェントごとの設定分離を扱います。

このページの内容5項目
初期設定接続状態を見るよく使う auth コマンドエージェントごとに設定を分けるうまくいかないとき

このページは、sf CLI の認証状態を確認したり、エージェントごとの設定を分けたりするときのリファレンスです。初回接続だけなら クイックスタート で十分です。

公開利用では、接続先は https://signal-foundry.app に揃えます。通常の人間 / エージェント接続は sf login です。API key は CLI onboarding では使わず、直接 API、backend job、.env / secret store からのプロダクト組み込みに使います。

初期設定

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

API key は ドキュメント、prompt、shell history、エージェントの会話ログには書かないでください。

接続状態を見る

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

{
  "authMode": "oauth",
  "storedApiKeyPreview": null,
  "storedBaseUrl": "https://signal-foundry.app",
  "effectiveCredentialType": "oauth_access_token",
  "effectiveCredentialPreview": "eyJhbG...redacted",
  "effectiveApiKeyPreview": null,
  "effectiveBaseUrl": "https://signal-foundry.app",
  "configPath": "/Users/you/.config/signal-foundry/config.json",
  "oauth": {
    "tokenAvailable": true,
    "tokenStore": "file"
  }
}

まず見る key:

  • effectiveBaseUrl
  • authMode
  • effectiveCredentialType
  • oauth.tokenAvailable
  • configPath

effectiveBaseUrl が https://signal-foundry.app で、authMode: "oauth"、oauth.tokenAvailable: true なら、CLI は production API に接続できます。

OAuth token は共有 config には保存しません。既定では OS を問わず file token store を使います。OS keychain は SIGNAL_FOUNDRY_OAUTH_TOKEN_STORE=keychain を明示した場合だけ使います。token refresh の書き込みは token store key ごとに直列化されるため、agent が複数の CLI command を並列実行しても refresh / 保存が競合しません。

よく使う auth コマンド

sf auth --help --json
sf login --base-url https://signal-foundry.app --json
sf auth show --json
sf auth logout
sf auth set-base-url https://signal-foundry.app
sf auth clear-base-url

通常は login と show だけで足ります。API key を使う直接 API連携 は、CLI 設定ではなく product 側の .env や secret store で管理してください。

エージェントごとに設定を分ける

Codex、Claude Code、repo ごとに別の ログイン を使う場合は、config path を分けます。

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

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

うまくいかないとき

状態確認すること
401 authentication_requiredsf auth show --json で authMode と oauth.tokenAvailable を確認
403 oauth_email_not_allowed表示された email_hint / email_domain を確認し、許可済みメールで sf login --base-url https://signal-foundry.app --json をやり直す
effectiveBaseUrl が違うsf login --base-url https://signal-foundry.app --json を再実行
別 account の結果が返るconfigPath と ログイン した チームワークスペースを確認
エージェント だけ失敗するエージェントが見ている SIGNAL_FOUNDRY_CONFIG_PATH を確認
oauth_keychain_unavailable明示した SIGNAL_FOUNDRY_OAUTH_TOKEN_STORE=keychain を外すか、OS keychain / secret-tool を確認する

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

oauth_email_not_allowed の状態では sf feedback create も同じ認証で失敗します。CLI から送れない場合は、表示された email_hint と実行したコマンドを別経路で共有してください。

このページの内容

初期設定接続状態を見るよく使う auth コマンドエージェントごとに設定を分けるうまくいかないとき