Install sf CLI

Signal Foundry CLI は npm で配布しています。まず npm 上の latest と、手元の sf の version を確認してください。

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

2026-04-29 時点で、source import / map / resolve を含む docs は @signal-foundry/cli@0.2.4 以降を前提にしています。古い CLI のまま進めると、docs にある command が unknown command になります。

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

継続利用する端末では global install を使います。

one-shot で最新版を試すだけなら npx -y @signal-foundry/cli@latest ... を使います。

このページが最初の install guide です。ソースコードを直接触るための依存関係セットアップは、CLI を使うだけなら不要です。

前提

• Node.js 20+
• npm

まず覚えること

以降の docs ではコマンドを sf ... の形で書きます。npm view @signal-foundry/cli version が通り、public npm で install 済みなら、そのまま sf ... を実行して構いません。

npx で一度試す場合:

npx -y @signal-foundry/cli@latest version

継続利用する場合:

npm install -g @signal-foundry/cli
sf version
sf auth show --json

更新の考え方

更新は同じコマンドでもう一度 install すれば十分です。

npm install -g @signal-foundry/cli@latest
sf version

one-shot で最新版を試すだけなら npx -y @signal-foundry/cli@latest ... を使います。

install 後すぐにやること

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

Codex / Claude Code で使う場合は、この直後に agent skill も 1 回だけ入れます。

sf agent install --target codex
sf agent install --target claude
sf list estimate "上場企業のうち、売上100億以上" --json
sf list candidates --from-estimate <estimateId> --json

API キーはコマンドに埋め込まず、sf auth setup のターミナル隠し入力に貼り付けます。すでに API キー設定画面を開いている場合は --no-open を付けてください。

次に起こりやすいこと

unknown command: source:

• CLI が古い
• npm install -g @signal-foundry/cli@latest
• sf version --json --check-update
• sf agent install --target codex --force
• sf agent install --target claude --force

npm ERR! 404 '@signal-foundry/cli' が出る場合は、registry が npmjs.org ではない可能性があります。private npm registry を使っている場合は、npm registry の設定を確認してください。

skill_already_installed:

• 既存の signal-foundry-agent skill がある
• sf agent install --target codex --force
• または sf agent install --target claude --force

sf: command not found:

• global install 前に shell を開いたまま
• 端末を開き直す
• npm root -g と npm bin -g の PATH を確認する

sf agent install は、同梱済みの signal-foundry-agent skill を agent 側の skill directory へコピーします。

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

すでに入っている skill を上書きする場合は --force を付けます。

sf agent install --target codex --force

うまくいっている状態

• auth show で effectiveBaseUrl が見える
• auth show で API キーの preview が見える
• sf version で想定 version が見える
• sf agent install の出力に install path が見える
• sf list estimate "上場企業のうち、売上100億以上" --json で estimate_id と credit 見積もりが返る
• sf list candidates --from-estimate <estimateId> --json で薄い preview が返る

次は Quick Start へ進んでください。

sf が動けば、以降の公開 docs の大半はそのまま追えます。逆に sf がまだ動いていない段階で DB や migration のページへ進む必要はありません。