コマンドとフラグ
`sf` CLI の主要 command family と、エージェントが必ず守る flag の扱いをまとめます。
このページの内容6項目
このページは リファレンス です。初回実行は クイックスタート と 基本コマンド から始めてください。
Command families
| Family | 役割 | 代表コマンド |
|---|---|---|
version | version と更新確認 | sf version --json --check-update |
login / auth | CLIログインと接続状態確認 | sf login, sf auth show |
agent | Codex / Claude Code skill 配置 | sf agent install --target codex --force --json |
search | 会社 resolver / signal search の標準入口 | sf search 7203 --json |
query | agent が生成した company_query.v1 の実行 | sf query --file company-query.json --json |
company | 1 社の Company Card / profile 標準入口 | sf company jpx_7203 --card --json |
signals | 会社別 Signals の標準入口 | sf signals jpx_7203 --include ir,cases --json |
company search | 会社 resolver の詳細 command | sf company search 7203 --json |
company profile | Company Card / profile の詳細 command | sf company profile jpx_7203 --card --json |
company cases | 事例・顧客関係・案件 evidence | sf company cases jpx_6836 --json |
company observations | 1 社の観測 feed | sf company observations jpx_7203 --limit 5 --json |
company filings | EDINET filing 候補 | sf company filings jpx_7203 --json |
filing | supporting evidence | sf company filings jpx_7203 --json で根拠 ID を確認 |
job search | 求人行検索 | sf job search "大阪勤務のAI求人" --json |
construction search | 建設業許可と営業所明細検索 | sf construction search "大阪の建設業許可" --json |
credits | クレジット balance / summary | sf credits balance --json |
feedback | 要望 / 不具合送信 | sf feedback create "<title>" --details "<body>" --json |
Coverage / warning 入出力
通常の最初の実行は sf search から始めます。返却 JSON の coverage / warning を見て、低ヒットを市場不在として扱ってよいか判断します。会社 resolver の詳細を確認するページでは、同じ surface の sf company search も使えます。
見る key:
companies[].company.company_idcompanies[].query_matchcompanies[].source_coveragemeta.returned_companiesmeta.source_coveragewarnings[]gaps[]
weak / unsupported / needs_human の場合は、0 件成功にせず、人間に制約を返します。現行機能は各 command の --help で確認します。
財務閾値など、自然文のまま q に残すと誤読しやすい条件は、agent が company_query.v1 JSON を作ってから sf query --file <path> --json で実行します。sf query に自然文を直接渡さないでください。
運用者向け release / eval コマンドは公開 CLI の通常 workflow では使いません。公開モードでは unavailable として返します。
Flags エージェント must use
| Flag | 使う場面 | 理由 |
|---|---|---|
--json | ほぼ全コマンド | エージェントが shape を検証し、error recovery できる |
--check-update | sf version | CLI が古いことに気づける |
--card | company profile の初回 | agent が読む compact Company Card にする |
--limit <n> | cases / observations / filings / jobs / construction | bounded execution にする |
--source, --type, --subtype | observations | 根拠 feed の読み過ぎを防ぐ |
--document-type | filings | 年次 / 半期などの範囲を固定する |
--ai-jobs, --job-location, --prefecture | job search | 求人行の条件を構造化する |
--max-credits <n> | command が明示要求した deep signal / bulk 実行 | クレジット上限なし実行を防ぐ |
Flags エージェント should avoid by default
| Flag / pattern | 避ける理由 |
|---|---|
| API key を command line に直接渡す | shell history と transcript に残る。通常は sf login を使う |
| deep signal / bulk を残高確認なしで繰り返す | 無料枠を食い潰しやすい |
| unsupported 条件を 0 件成功にする | silent failure になる |
| preview URL を API base URL にする | deploy preview と production data の境界が崩れる |
| list flag を空白区切りで渡す | --section-key business_risks,strategy または flag を複数回指定する |
Recovery 入出力
失敗時はまず JSON error を見ます。
{
"ok": false,
"error": {
"code": "usage_error",
"hint": "先に `sf company search <query> --json` で company_id を解決してください。",
"suggested_next_commands": ["sf company search <query> --json"]
}
}
エージェントは error.suggested_next_commands[0] を次の候補にします。ただし、クレジット消費や deep signal / bulk を伴う場合は人間に確認してください。
max_credits_exceeded が返る場合は type: "budget_limit" です。retry/backoff ではなく、--max-credits <n> を上げるか条件を絞ってください。
Reference の正本
細かい option は CLI 自身が正本です。
sf --help --json sf search --help --json sf company --help --json sf signals --help --json sf query --help --json sf company search --help --json sf company profile --help --json sf company cases --help --json sf company observations --help --json sf company filings --help --json sf job search --help --json sf construction search --help --json sf credits balance --help --json sf credits summary --help --json sf feedback create --help --json
このドキュメントは「どこを見るか」を固定するための索引です。option の完全一覧は CLI help に寄せます。