pinecone-cli について
pinecone-cli は、Pinecone を管理するコマンドラインツールです。ベクトル操作、インデックス管理、自動化を行う開発者向けで、すべてのインデックスタイプに対応し、スクリプトや CI/CD 用の JSON 出力も備えています。
主な機能
- 01インデックス、ネームスペース、バックアップを管理
- 02ベクトルの登録、検索、取得、更新、削除
- 03生のベクトル値でインデックスを検索
- 04スクリプト処理用に JSON を出力
- 05自動化向けにサービスアカウント認証を設定
活用シーン
- 01複数のインデックスタイプでベクトルを処理
- 02CI/CD でベクトルのアップロードを自動化
- 03移行前にバックアップし、新しいインデックスへ復元
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ pinecone-io/ skills --skill pinecone-cliインストール後、Claude Code で/pinecone-cliを入力して読み込まれたか確認します。
同梱ファイルreferences/command-reference.mdreferences/troubleshooting.md
詳細
Pinecone CLI (pc)
ターミナルから Pinecone を管理します。CLI は、MCP では現在対応できない、すべてのインデックスタイプにわたるベクトル操作で特に役立ちます。
CLI と MCP の比較
| CLI | MCP | |
|---|---|---|
| インデックスタイプ | すべて(標準、統合、スパース) | 統合のみ |
| ベクトル操作(upsert、query、fetch、update、delete) | ✅ | ❌ |
| 統合インデックスでのテキスト検索 | ✅ | ✅ |
| バックアップ、ネームスペース、組織/プロジェクト管理 | ✅ | ❌ |
| CI/CD/スクリプト | ✅ | ❌ |
セットアップ
インストール(macOS)
brew tap pinecone-io/tap
brew install pinecone-io/tap/pinecone
その他のプラットフォーム(Linux、Windows)では、GitHub Releasesからダウンロードしてください。
認証
# Interactive (recommended for local dev)
pc login
pc target -o "my-org" -p "my-project"
# Service account (recommended for CI/CD)
pc auth configure --client-id "$PINECONE_CLIENT_ID" --client-secret "$PINECONE_CLIENT_SECRET"
# API key (quick testing)
pc config set-api-key $PINECONE_API_KEY
ステータスを確認するには、pc auth status · pc target --show を実行します。
エージェントセッションに関する注意:エージェントのループ内で
pc loginを実行する必要がある場合、ブラウザー認証リンクが正しく表示されないことがあります。エージェントセッションを開始する前に認証しておくことをおすすめします。ターミナルで直接pc loginを実行し、認証後にエージェントを呼び出してください。
CLI の認証では PINECONE_API_KEY は設定されません
pc login は CLI ツール自体を認証するものであり、環境に PINECONE_API_KEY を設定するものではありません。Pinecone SDK を使用する Python スクリプト、Node.js SDK、その他のツールには、別途 PINECONE_API_KEY を設定する必要があります。
CLI を使ってキーを作成し、1 ステップでエクスポートできます。
KEY=$(pc api-key create --name agent-sdk-key --json | jq -r '.value')
export PINECONE_API_KEY="$KEY"
jq を使わない場合:pc api-key create --name agent-sdk-key --json を実行し、"value" フィールドを手動でコピーします。
よく使うコマンド
| タスク | コマンド |
|---|---|
| インデックスの一覧表示 | pc index list |
| サーバーレスインデックスの作成 | pc index create -n my-index -d 1536 -m cosine -c aws -r us-east-1 |
| インデックスの統計情報 | pc index stats -n my-index |
| ファイルからベクトルをアップロード | pc index vector upsert -n my-index --file ./vectors.json |
| ベクトルでクエリ | pc index vector query -n my-index --vector '[0.1, ...]' -k 10 --include-metadata |
| ベクトル ID でクエリ | pc index vector query -n my-index --id "doc-123" -k 10 |
| ID でベクトルを取得 | pc index vector fetch -n my-index --ids '["vec1","vec2"]' |
| ベクトル ID の一覧表示 | pc index vector list -n my-index |
| フィルターでベクトルを削除 | pc index vector delete -n my-index --filter '{"genre":"classical"}' |
| ネームスペースの一覧表示 | pc index namespace list -n my-index |
| バックアップの作成 | pc backup create -i my-index -n "my-backup" |
| JSON 出力(スクリプト用) | 任意のコマンドに -j を追加 |
できること
カスタムベクトルでクエリ(テキストだけではありません)
MCP とは異なり、CLI では生のベクトル値を使って任意のインデックスにクエリできます。外部で埋め込み(OpenAI、HuggingFace など)を生成する場合に便利です。
pc index vector query -n my-index \
--vector '[0.1, 0.2, ..., 0.9]' \
--filter '{"source":{"$eq":"docs"}}' \
-k 20 --include-metadata
埋め込みをクエリに直接パイプ
jq -c '.embedding' doc.json | pc index vector query -n my-index --vector - -k 10
プレビュー付きのメタデータ一括更新
# Preview first
pc index vector update -n my-index \
--filter '{"env":{"$eq":"staging"}}' \
--metadata '{"env":"production"}' \
--dry-run
# Apply
pc index vector update -n my-index \
--filter '{"env":{"$eq":"staging"}}' \
--metadata '{"env":"production"}'
バックアップと復元
# Snapshot before a migration
pc backup create -i my-index -n "pre-migration"
# Restore to a new index if something goes wrong
pc backup restore -i <backup-uuid> -n my-index-restored
CI/CD で自動化
export PINECONE_CLIENT_ID="..."
export PINECONE_CLIENT_SECRET="..."
pc auth configure --client-id "$PINECONE_CLIENT_ID" --client-secret "$PINECONE_CLIENT_SECRET"
pc index vector upsert -n my-index --file ./vectors.jsonl --batch-size 1000
JSON 出力を使ったスクリプト作成
# Get all index names as a list
pc index list -j | jq -r '.[] | .name'
# Check if an index exists before creating
if ! pc index describe -n my-index -j 2>/dev/null | jq -e '.name' > /dev/null; then
pc index create -n my-index -d 1536 -m cosine -c aws -r us-east-1
fi
参考ファイル
- すべてのコマンドのリファレンス — フラグと例を含むすべてのコマンド
- トラブルシューティングとベストプラクティス