CLI

基本コマンド

Claude Code / Codex と人間が Signal Foundry を使うとき、最初に戻る `sf` コマンドの実行順です。

このページの内容10項目

このページは CLI の最小正本です。エージェントは目的を選び、このページで Search / Company Card / Signals / Usage の実行順を確認します。

原則は 4 つです。

エージェント向け command は --json を付ける
まず sf search で company_id を解決する
sf company <companyId> --card で compact に読み、必要な Signals だけ深掘る
リストやCSVは agent が返却JSONからローカルで作る

操作ごとの無料 / 有料境界はクレジット表を見ます。取得元と根拠の出所はデータの出所を見ます。母集団、coverage、semantic tag の読み方はデータカバレッジと semantic tag を見ます。

0. 起動前の確認

sf version --json --check-update
sf auth show --json
sf search 7203 --json

確認する key:

version
update.current_version
update.latest_version
update.update_available
effectiveBaseUrl
authMode
oauth.tokenAvailable
configPath
companies[].company.company_id
companies[].company.display_name
meta.returned_companies

古い CLI なら更新し、エージェント skill も入れ直します。

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

Windows は winget で更新します。winget search --id Nexaflow.SignalFoundry --source winget で最新 version がまだ見つからない場合だけ、sf CLI のインストールの GitHub Release ZIP 手順を使います。

1. 会社を探す

Exact lookup:

sf search 7203 --json
sf search KEYENCE --json
sf search global.toyota --json

条件検索:

sf search "大阪の製造業で求人募集" --has-jobs true --order jobs --json
sf search "AI系の求人" --ai-jobs true --order ai --json
sf search "生成AIに関心がありそうな会社" --signal genai_interest --json

確認する key:

companies[].company.company_id
companies[].company.display_name
companies[].card
companies[].source_context
companies[].query_match
meta.returned_companies
meta.matched_companies

候補が競合する場合は companies[] を見て、勝手に確定せず人間に確認します。

財務閾値を決定的に扱う場合は、自然文を q に残さず、agent が company_query.v1 JSON を作ってから実行します。

sf query --file company-query.json --json

sf company search は同じ会社 resolver の詳細 command です。会社検索だけを細かく確認する場合は Company Search を見ます。

確認する key:

query.status
query.executors.financial_gold.status
query.executors.financial_gold.result.matched_count
query.executors.financial_gold.result.matched_financial_facts[]
search.meta.returned_companies
search.meta.coverage_warnings

hosted Financial Company Query smoke gate は、PL / BS / CF、metric alias、 current-listed table routing、zero-match、unsupported 条件を同じ JSON contract で確認します。通常の確認は no-write の dry-run から始めます。

pnpm run sf:financial:company-query-hosted-smoke -- --staging --dry-run

hosted API validation まで実行する場合:

pnpm run sf:financial:company-query-hosted-smoke -- --staging

本番相当:

pnpm run sf:financial:company-query-hosted-smoke -- --production --dry-run

artifact は summary-only です。full query payload、matched facts、API key、 Supabase secret は保存しません。SIGNAL_FOUNDRY_API_KEY がある場合はその key を使い、ない場合だけ temporary API key を作成して cleanup します。env / OAuth / API key / account / environment が合わない場合は skip せず status: "blocked" と blockers[] を返します。

2. Company Card を読む

sf company <companyId> --card --json

確認する key:

company.company_id
company.display_name
card
source_coverage
suggested_next_commands[]

足りない場合だけ full profile に降ります。

sf company profile <companyId> --json

3. Signals を読む

必要な signal だけ実行します。

sf signals <companyId> --include hiring,cases,technology,ir,web --json
sf signals <companyId> --include ir,cases --limit 10 --json

確認する key:

case_studies[]
customer_relations[]
projects[]
observations[]
filings[]
source_coverage
meta

求人や建設許可の行レベル detail が必要な場合:

sf job search "<query>" --json
sf construction search "<query>" --json

4. ローカルリストを作る

ユーザーが「リスト」「CSV」「表」を求める場合は、Signal Foundry の返却JSON から agent 側で作ります。

標準手順:

sf search "<criteria>" --limit <n> --json
companies[] と card を読む
必要な会社だけ profile --card または signal を読む
Markdown / JSON / CSV をローカルで生成する

Signal Foundry v0 は Search、Company Card、Signals を高速に返します。

5. Batch / bulk を通常導線にしない

sf batch resolve と sf batch signals は direct integration 用の上限を持ちますが、初回成功や通常の v0 公開 workflow の前提にはしません。複数会社は Search JSON から agent 側でローカルに整形します。

sf search "<criteria>" --json
sf company <companyId> --card --json
sf signals <companyId> --include ir,cases --json

bulk_not_available_on_free が返った場合は usage を確認し、対象を小さく分けます。

sf usage --json

6. Usage を確認する

sf usage --json
sf credits balance --json
sf credits summary --json
sf credits summary --days 7 --limit 5 --json

確認する key:

balance.available_credits
balance.grants[]
balance.consumption_order
summary.totalQuantity
summary.meterBreakdown[]
summary.usageBreakdown[]
summary.recentEvents[]

credit_balance_insufficient や rate_limit_exceeded が出た場合は、先に残高、 usage、対象件数を見直します。

7. Feedback を送る

明示された要望や不具合だけ送ります。raw transcript、API key、顧客秘密情報は送らないでください。

sf feedback create "company search の条件指定を増やしたい" \
  --details "市場区分と採用シグナルを同時に指定したいです。" \
  --source codex \
  --surface company.search \
  --json

失敗時

sf --help --json
sf search --help --json
sf company --help --json
sf signals --help --json
sf batch --help --json
sf credits summary --help --json

ok: false が返ったら次を見ます。

error.code
error.hint
error.retryable
error.suggested_next_commands[]

weak、unsupported、needs_human、credit error を 0 件成功として扱わないでください。

次に読むページ

目的から選ぶ: ユースケース
会社検索の詳細: Company Search
1 社調査: 1社調査
error shape: Help と Error Handling

CLI

基本コマンド

Claude Code / Codex と人間が Signal Foundry を使うとき、最初に戻る `sf` コマンドの実行順です。

このページの内容10項目

このページは CLI の最小正本です。エージェントは目的を選び、このページで Search / Company Card / Signals / Usage の実行順を確認します。

原則は 4 つです。

エージェント向け command は --json を付ける
まず sf search で company_id を解決する
sf company <companyId> --card で compact に読み、必要な Signals だけ深掘る
リストやCSVは agent が返却JSONからローカルで作る

0. 起動前の確認

sf version --json --check-update
sf auth show --json
sf search 7203 --json

確認する key:

version
update.current_version
update.latest_version
update.update_available
effectiveBaseUrl
authMode
oauth.tokenAvailable
configPath
companies[].company.company_id
companies[].company.display_name
meta.returned_companies

古い CLI なら更新し、エージェント skill も入れ直します。

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

1. 会社を探す

Exact lookup:

sf search 7203 --json
sf search KEYENCE --json
sf search global.toyota --json

条件検索:

sf search "大阪の製造業で求人募集" --has-jobs true --order jobs --json
sf search "AI系の求人" --ai-jobs true --order ai --json
sf search "生成AIに関心がありそうな会社" --signal genai_interest --json

確認する key:

companies[].company.company_id
companies[].company.display_name
companies[].card
companies[].source_context
companies[].query_match
meta.returned_companies
meta.matched_companies

候補が競合する場合は companies[] を見て、勝手に確定せず人間に確認します。

財務閾値を決定的に扱う場合は、自然文を q に残さず、agent が company_query.v1 JSON を作ってから実行します。

sf query --file company-query.json --json

sf company search は同じ会社 resolver の詳細 command です。会社検索だけを細かく確認する場合は Company Search を見ます。

確認する key:

query.status
query.executors.financial_gold.status
query.executors.financial_gold.result.matched_count
query.executors.financial_gold.result.matched_financial_facts[]
search.meta.returned_companies
search.meta.coverage_warnings

pnpm run sf:financial:company-query-hosted-smoke -- --staging --dry-run

hosted API validation まで実行する場合:

pnpm run sf:financial:company-query-hosted-smoke -- --staging

本番相当:

pnpm run sf:financial:company-query-hosted-smoke -- --production --dry-run

2. Company Card を読む

sf company <companyId> --card --json

確認する key:

company.company_id
company.display_name
card
source_coverage
suggested_next_commands[]

足りない場合だけ full profile に降ります。

sf company profile <companyId> --json

3. Signals を読む

必要な signal だけ実行します。

sf signals <companyId> --include hiring,cases,technology,ir,web --json
sf signals <companyId> --include ir,cases --limit 10 --json

確認する key:

case_studies[]
customer_relations[]
projects[]
observations[]
filings[]
source_coverage
meta

求人や建設許可の行レベル detail が必要な場合:

sf job search "<query>" --json
sf construction search "<query>" --json

4. ローカルリストを作る

ユーザーが「リスト」「CSV」「表」を求める場合は、Signal Foundry の返却JSON から agent 側で作ります。

標準手順:

sf search "<criteria>" --limit <n> --json
companies[] と card を読む
必要な会社だけ profile --card または signal を読む
Markdown / JSON / CSV をローカルで生成する

Signal Foundry v0 は Search、Company Card、Signals を高速に返します。

5. Batch / bulk を通常導線にしない

sf search "<criteria>" --json
sf company <companyId> --card --json
sf signals <companyId> --include ir,cases --json

bulk_not_available_on_free が返った場合は usage を確認し、対象を小さく分けます。

sf usage --json

6. Usage を確認する

sf usage --json
sf credits balance --json
sf credits summary --json
sf credits summary --days 7 --limit 5 --json

確認する key:

balance.available_credits
balance.grants[]
balance.consumption_order
summary.totalQuantity
summary.meterBreakdown[]
summary.usageBreakdown[]
summary.recentEvents[]

credit_balance_insufficient や rate_limit_exceeded が出た場合は、先に残高、 usage、対象件数を見直します。

7. Feedback を送る

明示された要望や不具合だけ送ります。raw transcript、API key、顧客秘密情報は送らないでください。

sf feedback create "company search の条件指定を増やしたい" \
  --details "市場区分と採用シグナルを同時に指定したいです。" \
  --source codex \
  --surface company.search \
  --json

失敗時

sf --help --json
sf search --help --json
sf company --help --json
sf signals --help --json
sf batch --help --json
sf credits summary --help --json

ok: false が返ったら次を見ます。

error.code
error.hint
error.retryable
error.suggested_next_commands[]

weak、unsupported、needs_human、credit error を 0 件成功として扱わないでください。

次に読むページ

目的から選ぶ: ユースケース
会社検索の詳細: Company Search
1 社調査: 1社調査
error shape: Help と Error Handling