Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
CLI

CLI の全体像

`sf` CLI の役割、実行方法、最初に辿るべきコマンドの順番をまとめます。

このページの内容5項目
この CLI が向いている理由このドキュメントに出てくる sf とは最初の 5 コマンド主要コマンドの流れエージェント向けの基本ルール

sf CLI は、Signal Foundry をエージェント向けに叩くための実行面です。 公開ドキュメントでは、検証済み CLI から auth -> search -> Company Card -> signals -> usage へ進めることを重視します。

エージェントがこのカテゴリを読む場合も、まず sf CLI のインストール で Homebrew、winget、または GitHub Release artifact から入れた sf version --json が通るか確認してください。

この CLI が向いている理由

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

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

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

このドキュメントに出てくる sf とは

このカテゴリでは command を sf ... で書きます。Homebrew、winget、または GitHub Release artifact から install 済みの CLI を前提にしています。

brew install nexaflow-io/tap/sf
sf version --json

Windows は winget install --id Nexaflow.SignalFoundry --source winget を 使います。最新 version が catalog 反映待ちの場合だけ GitHub Release ZIP を 使います。

最初の 5 コマンド

sf version --json --check-update
sf login --base-url https://signal-foundry.app --json
sf auth show --json
sf search 7203 --json
sf company jpx_7203 --card --json

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

  • version --check-update で今使っている CLI build と更新可否が見える
  • auth show で effectiveBaseUrl が見える
  • auth show で authMode と oauth.tokenAvailable が見える
  • sf search で company_id が返る
  • sf company --card で compact な Company Card が返る

日常的に戻るページは 基本コマンド です。 option 一覧は コマンドとフラグ に分離しています。

主要コマンドの流れ

会社候補を探す:

sf search "<criteria>" --limit 20 --json
sf search "AI系の求人" --ai-jobs true --order ai --json
sf search "生成AIに関心がありそうな会社" --signal genai_interest --json

財務閾値などの構造化 query を実行する:

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

Company Card を読む:

sf company <companyId> --card --json

必要な Signals だけ深掘る:

sf company cases <companyId> --limit 5 --json
sf company observations <companyId> --limit 5 --json
sf company filings <companyId> --limit 5 --json

利用量を見る:

sf credits summary --json

エージェント向けの基本ルール

  • まず --json を付ける
  • 会社群や営業候補は sf search から始める
  • profile や filings に自由入力の社名を直接渡さない
  • 必要な signal だけ読む
  • リスト、CSV、Markdown は返却JSONからローカルで作る
  • 失敗したら error.hint と error.suggested_next_commands をそのまま次の行動に使う

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

このページの内容

この CLI が向いている理由このドキュメントに出てくる sf とは最初の 5 コマンド主要コマンドの流れエージェント向けの基本ルール