クイックスタート

このページは、Signal Foundry を最初に 1 回成功させるための手順です。 ここでは credit を使う書き込みは実行しません。

確認することは 5 つです。

• sf login で CLI に接続設定を保存する
• sf auth show --json が正しい接続先と OAuth 状態を返す
• Codex / Claude Code で使う場合は最初の指示を渡す
• sf search 7203 --json が会社候補を返す
• sf company jpx_7203 --json が Company Card を返す

始める前に

用意するもの:

• macOS / Linux は Homebrew
• Windows は winget
• Signal Foundry のチームワークスペース
• 本番 URL: https://signal-foundry.app

Preview URL は API の接続先にしません。CLI には本番 URL を設定します。

初回サインアップ後は、まずチームワークスペースを作成します。1 人で 使う場合も、そのチームが API keys、usage、billing の利用範囲になります。

通常の人間 / エージェント接続は sf login です。API key は直接 API を 組み込む場合だけ使います。

1. インストール

sf CLI を、macOS / Linux は Homebrew、Windows は winget でインストールします。 手順と失敗時の切り分けは sf CLI のインストール を見てください。

sf version --json

sf version --json が JSON を返れば、次に進みます。

2. ログイン

CLI を WorkOS/AuthKit で接続します。

sf login --json
sf auth show --json

見る key:

• effectiveBaseUrl
• authMode
• oauth.tokenAvailable

3. エージェントに最初の指示を渡す

Codex / Claude Code 側の事前設定は不要です。最初の依頼に、次のような 1 文を含めます。CLI だけで使う場合は、この手順を飛ばしてかまいません。

Signal Foundry の CLI `sf` が使えます。まず `sf --help --json` と
`sf auth show --json` を確認してから進めてください。実行は常に `--json` を
付け、失敗時は `error.hint` と `error.suggested_next_commands` に
従ってください。

CLI は help とエラー応答に次のコマンド候補を含めて返すので、エージェントに 古い手順を覚えさせる必要はありません。API key はエージェントの会話や プロンプトに貼りません。

4. 検索して canonical ID を得る

まず、書き込みが発生しない会社検索で canonical company_id を取得します。 会社名、証券コード、法人番号、domain のいずれかを短く渡します。

sf search 7203 --json

見る key:

• companies[].company.company_id
• companies[].company.display_name
• companies[].query_match
• meta.returned_companies

期待する状態:

• companies[0].company.company_id に canonical ID が返る
• meta.returned_companies が 1 以上
• 認証エラーが出ない

5. Company Card を読む

検索で得た canonical company_id をそのまま Company Card に渡します。 検索語や証券コードは渡しません。

sf company jpx_7203 --json

見る key:

• company.company_id
• company.display_name
• card
• source_coverage

成功している状態

auth:
  effectiveBaseUrl = https://signal-foundry.app
  authMode = oauth
  oauth.tokenAvailable = true

search:
  meta.returned_companies >= 1
  companies[0].company.company_id exists

company card:
  company.company_id exists
  card exists

失敗した場合

invalid_api_key が返る場合:

1. sf auth show --json を実行します。
2. sf login --json でログインし直します。

company_not_found が返る場合:

1. sf search "<社名、証券コード、法人番号、domain>" --json を実行します。
2. companies[].company.company_id を確認し、候補が複数なら勝手に 1 社へ確定しません。

rate_limit_exceeded が返る場合:

1. API レスポンスの Retry-After まで待ちます。
2. 同じ Signals の読み取りを繰り返す前に、利用状況を確認します。

最初のうちにやらなくてよいこと

• Preview URL をエージェントの接続先にすること
• 1 本の共有キーを複数用途に使い回すこと
• 個人 account を billing / クレジットの通常スコープとして使うこと
• 検索語をそのまま Company Card / Signals に渡すこと(先に sf search で company_id を解決します)
• 会社検索 JSON を整形しないまま成果物にすること(候補表や CSV はローカルで作ります)

次に進む

• 目的別に選ぶ: ユースケース
• 会社を深掘りする: 1社調査
• 会社検索の option を見る: Company Search
• credit 境界を見る: クレジット表
• データの出所を確認する: データの出所