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

概要

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

はじめに
sf CLI をインストールクイックスタートデータの出所カバレッジとタグ
CLI 概要
基本コマンドCLI 認証会社検索求人検索建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
認証
APIキーのライフサイクル利用状況の見方
請求
クレジット表
トラブルシュート
認証・接続・制限エラー低ヒット検索の見直し方クレジットと maxCredits の失敗
概要

sf CLI のインストール

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

このページの内容6項目
インストール更新パッケージマネージャーを使わない場合ドキュメント上の sf ... の意味よくある失敗うまくいっている状態

Signal Foundry CLI は、macOS / Linux では Homebrew、Windows では winget からインストールします。インストールと更新の手順は、このページを正本とします。

インストール

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

更新

継続利用する端末では、インストールと同じパッケージマネージャーで更新します。winget は Microsoft 側の catalog 反映が release より遅れる場合があります。

macOS / Linux:

brew upgrade --formula nexaflow-io/tap/sf
sf version --json

Homebrew では、tap を省略した bare sf の upgrade は使わないでください。Salesforce CLI cask と衝突する可能性があります。

Windows:

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

CLI が古いままだと、ドキュメントの手順とコマンドの help や復旧手順が一致しないことがあります。迷ったらまず version を確認します。

sf version --json --check-update

パッケージマネージャーを使わない場合

固定 version や artifact checksum の確認は release / CI 用の検証手順です。通常ユーザーのインストール手順にはしません。

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

以降のドキュメントでは、コマンドを sf ... の形で書きます。macOS / Linux は Homebrew、Windows は winget で入れた CLI を実行する前提です。

よくある失敗

unknown command が返る場合:

  1. macOS / Linux は brew upgrade --formula nexaflow-io/tap/sf を実行します。
  2. Windows は winget upgrade --id Nexaflow.SignalFoundry を実行します。
  3. sf version --json で更新後の version を確認します。

古い package registry の手順が出てくる場合:

  1. 古いインストール手順を見ています。このページの Homebrew / winget の手順に戻ります。

sf: command not found の場合:

  1. インストール前に開いていた shell を使っていないか確認します。まず端末を開き直します。
  2. brew --prefix の bin、または winget の portable link directory が PATH に入っているか確認します。

うまくいっている状態

  • sf version --json が JSON を返す

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

このページの内容

インストール更新パッケージマネージャーを使わない場合ドキュメント上の sf ... の意味よくある失敗うまくいっている状態