ドキュメント

CLI リファレンス

CLI は再現可能なターミナル運用を求めるチーム向けに Hosted API サーフェスをそのまま反映しています。

インストールと認証

bashcd sdk/cli
pip install -e .

schift auth login
schift auth status

設定の優先順位

SCHIFT_API_KEY~/.schift/config.json より優先されます。SCHIFT_API_URL は既定の https://api.schift.io/v1 より優先されます。

コマンドグループ

グループコマンドメモ
authlogin, logout, status環境変数を使わない場合は ~/.schift/config.json にキーを保存
cataloglist, get MODEL_IDモデルメタデータの参照
embedschift embed TEXT --model ..., schift embed batch --file texts.jsonl --model ... [--output out.jsonl]バッチ入力は text フィールド付き JSONL
dbcreate, list, statsホスト型コレクション管理
queryquery TEXT --collection ... [--top-k] [--model] [--threshold]自然言語検索
benchbench --source ... --target ... --data eval.jsonl [--top-k]ローカルファイルのパスを API に送る
migratefit --source ... --target ... [--sample], run --projection ... --db ... [--dry-run] [--batch-size]実 DB を書き換える前に --dry-run 推奨
usageusage [--period]アカウント要約とモデル別利用量

エンドツーエンド例

bashschift catalog list
schift embed "四半期売上レポート" --model openai/text-embedding-3-large
schift db create finance-docs --dim 3072
schift query "取締役会メモ" --collection finance-docs --top-k 5
schift bench --source openai/text-embedding-3-small --target google/gemini-embedding-001 --data ./eval.jsonl
schift migrate fit --source openai/text-embedding-3-small --target google/gemini-embedding-001 --sample 0.1
schift migrate run --projection proj_abc123 --db pgvector://user:pass@localhost/app --dry-run
  • バッチ埋め込み入力は各行が text フィールドを持つ JSON オブジェクトである必要があります。
  • migrate run は表示時にパスワードを伏せますが、実際の資格情報はシェル履歴に残さないでください。
  • CLI は Rich ベースなので、表と要約パネルは人が読む前提で設計されています。