メインコンテンツへスキップ

​
概要

Sanka CLI は、Sanka の公開API向けの薄いコマンドラインラッパーです。業務ロジックはサーバー側に置いたまま、次のような役割をCLIが担います。
  • 開発者向けAPIトークンの保存と更新
  • ローカルのプロファイルと設定
  • CRM・ワークフロー・AI系エンドポイントへのリクエスト組み立て
  • 表形式またはJSONでの出力
  • 長時間のワークフロー実行のポーリング（オプション）

​
インストール

GitHubから（初回のPyPI公開まではこちらが手早いです）:
uv tool install "git+https://github.com/sankaHQ/sanka-cli.git"
ブートストラップスクリプト:
curl -fsSL https://raw.githubusercontent.com/sankaHQ/sanka-cli/main/scripts/install.sh | sh
スクリプトはまずPyPIを試し、パッケージが未公開の場合は公開GitHubリポジトリにフォールバックします。初回のPyPI公開後:
uv tool install sanka-cli
Homebrew（公開タップ: sankaHQ/homebrew-cli）:
brew tap sankaHQ/cli
brew install sankaHQ/cli/sanka
リポジトリをクローンして開発する場合:
uv tool install .

​
認証

Sanka で 開発者向けAPI のアクセストークンとリフレッシュトークンを発行し、ローカルに保存します（利用可能な環境ではOSのキーチェーンに保存されます）。
sanka auth login --access-token "<ACCESS_TOKEN>" --refresh-token "<REFRESH_TOKEN>"
使用中のプロファイルと接続状態の確認:
sanka auth status
保存済みトークンの削除:
sanka auth logout

​
プロファイル

登録済みプロファイルの一覧と、アクティブなプロファイルの切り替え:
sanka profiles list
sanka profiles use prod

​
CRMレコード

companies / contacts / deals / tickets それぞれに、list・get・create・update・delete があります。JSONは文字列で渡すか、@ファイル.json でファイルから読み込めます。
sanka companies list
sanka companies get <company-id>
sanka contacts get <contact-id>
sanka deals create --data @deal.json
sanka tickets delete <ticket-id>
get・update・delete では、外部IDで解決する場合に --external-id を指定できます。

​
ワークフロー

sanka workflows list
sanka workflows get <workflow-ref>
sanka workflows run <workflow-ref>
sanka workflows run <workflow-ref> --wait
--wait で実行完了までポーリングします（--poll-interval や --timeout で調整可能）。

​
AI補助

sanka ai score company <record-id>
sanka ai score deal <record-id> --score-model-id <score-model-id>
sanka ai enrich company <record-id> --force-refresh
sanka ai enrich company --seed-name "Acme" --seed-url "https://acme.example" --dry-run
レコードIDの代わりにシード情報だけを渡す場合は、--dry-run が必須です。

​
共通オプションと出力

ルートのオプション:
  • --profile — 使うプロファイル名
  • --base-url — そのコマンドだけAPIのベースURLを上書き
  • --output table|json — 出力形式
既定では、対話シェル（TTY）では 表、それ以外では JSON です。必要に応じて上書きします。
sanka --output json companies list
次の環境変数は、保存せずに プロファイルの値より優先されます。
  • SANKA_PROFILE
  • SANKA_BASE_URL（設定がない場合のAPIの既定は https://api.sanka.com）
  • SANKA_ACCESS_TOKEN
  • SANKA_REFRESH_TOKEN

​
ソースと関連ドキュメント

  • リポジトリ: github.com/sankaHQ/sanka-cli
  • リポジトリ内の docs/（インストール、コマンド一覧、リリース手順など）