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

概要

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

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

sf CLI のインストール

Signal Foundry CLI を Homebrew、winget、または GitHub Release artifact でインストールします。

このページの内容7項目
推奨インストールOS を問わず使える方法package manager を使わない場合ドキュメント上の sf ... の意味インストール後にやることよくある失敗うまくいっている状態

Signal Foundry CLI は Homebrew、winget、または GitHub Release artifact から入れます。ユーザー向けの手順では npm / pnpm / npx を使いません。

推奨インストール

macOS / Linux:

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

Windows:

winget search --id Nexaflow.SignalFoundry --source winget
winget install --id Nexaflow.SignalFoundry --source winget
sf version --json

継続利用する端末では、同じ package manager で更新します。winget は Microsoft 側の catalog 反映が release より遅れる場合があります。最新 version が winget にまだ出ていない時だけ、下の GitHub Release artifact 手順を使います。

macOS / Linux:

brew upgrade sf
sf version --json

Windows:

winget search --id Nexaflow.SignalFoundry --source winget
winget upgrade --id Nexaflow.SignalFoundry
sf version --json

OS を問わず使える方法

package manager を待たずに使う場合は、GitHub Release artifact と SHA256SUMS を使います。これは macOS / Linux / Windows で共通の配布元です。

macOS / Linux:

SF_VERSION=0.3.18
curl -LO "https://github.com/nexaflow-io/signal-foundry-cli-releases/releases/download/cli-v${SF_VERSION}/SHA256SUMS"
curl -LO "https://github.com/nexaflow-io/signal-foundry-cli-releases/releases/download/cli-v${SF_VERSION}/signal-foundry-cli-${SF_VERSION}.tar.gz"
shasum -a 256 -c SHA256SUMS --ignore-missing
tar -xzf "signal-foundry-cli-${SF_VERSION}.tar.gz"
./signal-foundry-cli-${SF_VERSION}/bin/sf version --json

Windows PowerShell:

$Version = "0.3.18"
$Asset = "signal-foundry-cli-$Version-windows-x64.zip"
Invoke-WebRequest "https://github.com/nexaflow-io/signal-foundry-cli-releases/releases/download/cli-v$Version/SHA256SUMS" -OutFile "SHA256SUMS"
Invoke-WebRequest "https://github.com/nexaflow-io/signal-foundry-cli-releases/releases/download/cli-v$Version/$Asset" -OutFile $Asset
$Expected = (Get-Content .\SHA256SUMS | Where-Object { $_ -match [regex]::Escape($Asset) } | ForEach-Object { ($_ -split '\s+')[0] } | Select-Object -First 1)
if (-not $Expected) { throw "Checksum entry not found for $Asset" }
$Actual = (Get-FileHash ".\$Asset" -Algorithm SHA256).Hash.ToLowerInvariant()
if ($Actual -ne $Expected.ToLowerInvariant()) { throw "SHA256 mismatch: expected $Expected actual $Actual" }
Expand-Archive ".\$Asset" -DestinationPath .
.\signal-foundry-cli-$Version\bin\sf.exe version --json

Windows ZIP には bin/sf.exe と bin/node.exe が入っています。

package manager を使わない場合

CI や固定 version の検証では、GitHub Release の tar.gz / zip と SHA256SUMS を取得し、checksum を確認してから sf version --json を実行します。

CI / agent / pinned 検証では、この方法を優先します。Windows で winget の catalog 反映を待たずに最新 version を検証する場合も、GitHub Release の Windows ZIP を checksum 確認して使います。

ドキュメント上の sf ... の意味

以降のドキュメントでは、コマンドを sf ... の形で書きます。macOS / Linux は Homebrew、Windows は winget または検証用の GitHub Release ZIP を展開した環境で実行できます。

CLI が古いままだと、Company-first の help や removed-surface recovery が一致しないことがあります。迷ったらまず version を確認してください。

SIGNAL_FOUNDRY_CLI_UPDATE_URL=https://signal-foundry.app/releases/cli/latest.json \
sf version --json --check-update

インストール後にやること

次は クイックスタート でログインと会社検索を確認します。

sf login は file token store を既定で使います。初回ログインで SIGNAL_FOUNDRY_OAUTH_TOKEN_STORE=file を指定する必要はありません。

よくある失敗

unknown command が返る:

  • brew upgrade sf
  • Windows は winget upgrade --id Nexaflow.SignalFoundry で更新し、見つからない場合だけ GitHub Release ZIP に戻る
  • sf version --json

npm ERR! 404 '@signal-foundry/cli' や pnpm add -g の手順が出てくる:

  • 古いインストール手順を見ている
  • Homebrew / winget の手順に戻る。catalog 反映待ちの Windows だけ GitHub Release ZIP を使う

sf: command not found:

  • install 前に開いていた shell を使っている
  • 端末を開き直す
  • brew --prefix または winget の portable link directory が PATH に入っているか確認する

うまくいっている状態

  • sf version --json が JSON を返す

次は クイックスタート へ進んでください。

このページの内容

推奨インストールOS を問わず使える方法package manager を使わない場合ドキュメント上の sf ... の意味インストール後にやることよくある失敗うまくいっている状態