Quick Start

このページは、Signal Foundry を最初に 1 回成功させるための最短手順です。

ゴールは 4 つです。

• team workspace の API key を発行する
• sf CLI に接続設定を保存する
• sf auth show --json が正しい base URL と key preview を返す
• sf companies search 7203 --json が company candidate を返す

List の保存、enrichment、export まで進める場合は First Day Playbook に進みます。

Before You Start

用意するもの:

• Node.js 20+
• npm
• Signal Foundry の team workspace
• team workspace の API key
• production base URL: https://signal-foundry.app

Preview URL は API base URL にしません。CLI には production base URL を設定してください。

初回サインアップ後は、まず team workspace を作成します。1 人で使う場合も、その team が API key、List、credit、billing の account scope になります。

API key は、CLI の隠し入力に貼り付けます。docs、prompt、shell history、agent の会話ログには書かないでください。

1. Install

まず npm 上の package と手元の CLI version を確認します。

npm view @signal-foundry/cli version
npm install -g @signal-foundry/cli@latest
sf version --json --check-update

見る key:

• version
• update.available
• update.latest

sf: command not found の場合は、shell を開き直すか、npm global bin が PATH に入っているか確認します。詳しくは Install sf CLI を見てください。

2. Authenticate

API key を 1 本発行します。

• team workspace: /home/<team-slug>/settings/api-keys

CLI に保存します。

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

見る key:

• effectiveBaseUrl
• effectiveApiKeyPreview
• configPath

agent ごとに設定を分ける場合だけ SIGNAL_FOUNDRY_CONFIG_PATH を使います。

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

3. Run First Read

まず read-only の会社検索で疎通を確認します。

sf companies search 7203 --json

見る key:

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

期待する状態:

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

この command は product credit を消費しません。

4. Check Credits

実行前の残高だけ確認します。

sf credits balance --json

見る key:

• balance.available_credits
• balance.remaining_credits
• balance.reserved_credits
• balance.grants[]

credit は request 数ではありません。保存済み row、追加 column、evidence が作られる時に使います。operation ごとの境界は Credit Schedule を見てください。

Expected Result

Quick Start が成功している状態:

auth:
  effectiveBaseUrl = https://signal-foundry.app
  effectiveApiKeyPreview = redacted preview

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

credits:
  balance.available_credits is a number
  balance.grants is an array

5. Install Agent Skill

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

sf agent install --target codex
sf agent install --target claude

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

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

配置先:

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

配置後は agent を再起動します。

If It Fails

invalid_api_key:

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

company_not_found:

sf companies search "<company name>" --json

rate_limit_exceeded:

• API response の Retry-After まで待つ
• 同じ write を再試行する場合は、API では Idempotency-Key を使う

credit_balance_insufficient:

sf credits balance --json

Quick Start の疎通では credit-consuming write を実行しません。この error が出た場合は、次に進む前に Credit Schedule と GET /credits/balance を確認してください。

Next

• 初日の保存 / enrichment / export: First Day Playbook
• 条件から List を作る: Sales List Prep
• CSV から始める: Source Import Workflow
• 1 社を深掘りする: Company Research Workflow
• API を直接叩く: API overview
• data provenance を確認する: Data Provenance