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

概要

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

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

クイックスタート

Signal Foundry にログインし、最初の会社検索と Company Card を読むまでを通します。

このページの内容9項目
始める前に1. インストール2. ログイン3. 会社検索で疎通確認4. Company Card を読む成功している状態5. Agent Skill を入れる失敗した場合次に進む

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

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

  • sf login で CLI に接続設定を保存する
  • sf auth show --json が正しい接続先と OAuth 状態を返す
  • sf company search 7203 --json が会社候補を返す
  • sf company profile jpx_7203 --card --json が Company Card を返す

始める前に

用意するもの:

  • macOS / Linux は Homebrew
  • Windows は winget。最新 version が catalog 反映待ちの場合だけ GitHub Release ZIP を使う
  • Signal Foundry のチームワークスペース
  • 本番 URL: https://signal-foundry.app

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

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

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

1. インストール

ユーザー向けインストールでは npm / pnpm / npx を使いません。OS の package manager で sf を入れます。

macOS / Linux:

brew install nexaflow-io/tap/sf
sf version --json

Windows:

winget search --id Nexaflow.SignalFoundry --source winget
winget install --id Nexaflow.SignalFoundry --source winget
sf version --json

winget に最新 version がまだ出ていない場合は、sf CLI のインストール の GitHub Release ZIP 手順を使います。

sf: command not found の場合は、shell を開き直してください。詳しくは sf CLI のインストール を見てください。

2. ログイン

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

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

確認する key:

  • effectiveBaseUrl
  • authMode
  • oauth.tokenAvailable
  • configPath

3. 会社検索で疎通確認

まずクレジットを使う書き込みがない会社検索で疎通を確認します。

sf company search 7203 --json

確認する key:

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

期待する状態:

  • company_id が返る
  • meta.returned_companies が 1 以上
  • auth error が出ない

4. Company Card を読む

検索で得た company_id から compact card を読みます。

sf company profile jpx_7203 --card --json

確認する key:

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

成功している状態

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

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

company card:
  company.company_id exists
  card exists

5. Agent Skill を入れる

Claude Code / Codex から使う場合は、CLI の後に skill を配置します。

sf agent install --target codex --json
sf agent install --target claude-code --json

すでに同名 skill がある場合:

sf agent install --target codex --force --json
sf agent install --target claude-code --force --json

配置先:

  • Codex: ~/.codex/skills/signal-foundry-agent
  • Claude Code: ~/.claude/skills/signal-foundry-agent

配置後はエージェントを再起動してください。API key は agent の会話や prompt に貼りません。

失敗した場合

invalid_api_key:

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

company_not_found:

sf company search "<company name or domain>" --json

rate_limit_exceeded:

  • API response の Retry-After まで待つ
  • 同じ deep signal を繰り返す前に usage を確認する

次に進む

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

このページの内容

始める前に1. インストール2. ログイン3. 会社検索で疎通確認4. Company Card を読む成功している状態5. Agent Skill を入れる失敗した場合次に進む