CLI Overview

sf CLI は、Signal Foundry を agent-friendly に叩くための実行面です。公開 docs では、package が live な環境では install 済み CLI から auth -> credit workspace loop -> 必要なら company research へ進めることを重視します。

agent がこのカテゴリを読む場合も、まず Install sf CLI で npm view @signal-foundry/cli version が通るか確認してください。public npm install は package が live なときだけ前提にします。

この CLI が向いている理由

Claude Code / Codex から見ると、sf CLI は次の 3 つを同時に満たします。

• --help で surface ごとの使い方と next commands が見える
• --json で結果とエラーの shape が安定している
• base URL を切り替えやすい

skills は どのコマンドを叩くか を決め、CLI は どう叩くか を固定します。

この docs に出てくる sf とは

このカテゴリではコマンドを sf ... で書きます。@signal-foundry/cli が live で、public npm から install 済みの CLI を前提にしています。

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

one-shot で試すだけなら:

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

最初の 5 コマンド

sf version --json --check-update
sf auth setup --base-url https://signal-foundry.app
sf auth show --json
sf data capabilities --json
sf list plan "上場企業のうち、売上100億以上" --json
sf list estimate "上場企業のうち、売上100億以上" --json

ここで確認したいのは次です。

• version --check-update で今使っている CLI build と更新可否が見える
• auth show で effectiveBaseUrl が見える
• auth show で effectiveApiKeyPreview が見える
• data capabilities で source coverage と supported / weak / unsupported が見える
• list plan で自然文が実行可能な条件に落ちる
• list estimate で estimate_id と credit 見積もりが返る

list estimate の現行 happy path は、会社マスターの上場状態、market segment、社名/識別子、EDINET 財務指標のしきい値、bounded なEDINET本文テーマ検索などです。上場日やテーマ条件は resolved_definition.source_coverage / warnings / capability map を見て、supported / weak / unsupported を分けてから保存に進んでください。

日常的に戻るページは Essential Commands です。option 一覧は Commands & Flags に分離しています。

主要コマンドの流れ

会社群や営業候補を保存する日常的な利用順は次で固定して問題ありません。

1. 前提が曖昧なら sf job business-understanding "<query>" --execute --json
2. sf list estimate "<query>" --json
3. sf list candidates --from-estimate <estimateId> --json
4. sf list materialize --from-estimate <estimateId> --execute --max-credits <n> --json
5. sf list enrich <listId> --source website --estimate --json
6. sf list enrich <listId> --source website --execute --max-credits <n> --json
7. sf list export <listId> --format csv --output ./exports/list.csv --json

1 社を深掘りするなら、次を使います。

sf job company-research 7203 --execute --json
sf companies search 7203 --json
sf company profile jpx_7203 --json
sf company observations jpx_7203 --limit 5 --json

agent 向けの基本ルール

• まず --json を付ける
• 会社群や営業候補は sf list estimate から始める
• materialize と enrich は estimate 後に --execute --max-credits を付ける
• profile や filings に自由入力の社名を直接渡さない
• 失敗したら error.hint と error.suggested_next_commands をそのまま次の行動に使う

この CLI は、長い会話よりも 1コマンド -> JSON確認 -> 次の1コマンド のループで使う方が安定します。