SKILLOfficialdatabase

setup

プラグイン: zilliz
ソース: GitHub で見る ↗

説明

次のような場合に使用: ユーザーが zilliz-cli（Zilliz Cloud を操作するコマンドラインツール）のインストール、Zilliz Cloud へのログイン、認証情報の設定、アクティブなクラスタコンテキスト（接続先の指定）の構成が必要な場合。また、他のスキルが必須の準備が不足していることを報告した場合にも使用します。

原文を表示

Use when the user needs to install zilliz-cli, log in to Zilliz Cloud, configure credentials, or set the active cluster context. Also use when any other skill reports a missing prerequisite.

ユースケース

zilliz-cliのインストールが必要なとき
Zilliz Cloudへのログインを行うとき
認証情報を設定するとき
クラスタコンテキストを構成するとき
他のスキルの準備不足を報告するとき

本文（日本語訳）

前提条件

zilliz-cli コマンドを実行する前に、以下を順番に確認してください:

CLI はインストール済みで最新バージョンか？ curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash を実行して、最新バージョンがインストールされていることを確認します。
ログイン済みか？ zilliz auth status を実行します。ログインしていない場合は、以下の手順に従ってログインを案内してください。
コンテキストは設定済みか？（データプレーン操作の場合のみ） zilliz context current を実行します。コンテキストが設定されていない場合は、コンテキストのセットアップを案内してください。

コマンドリファレンス

CLI のインストール／アップグレード

curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash

インストールの確認:

zilliz --version

認証

重要: ログインコマンド（zilliz login、zilliz configure）はインタラクティブなターミナルを必要とするため、Claude Code 内では実行できません。これらのコマンドは必ずユーザー自身のターミナルで実行するよう案内してください。

ログイン済みかどうかの確認:

zilliz auth status

ログインしていない場合は、ユーザーに自分のターミナルを開いて以下のいずれかを実行するよう伝えてください:

オプション 1: ブラウザベースのログイン（OAuth）— フル機能へのアクセス

zilliz login

認証用のブラウザを開きます
ユーザー情報、組織データ、API キーを取得します
ヘッドレス環境では --no-browser を使用します（手動でアクセスする URL が表示されます）

オプション 2a: ログインコマンドによる API キー認証

zilliz login --api-key

オプション 2b: configure による API キー認証（レガシー）

zilliz configure

API キーの入力を求めます（Zilliz Cloud コンソールの「API Keys」から確認できます）
OAuth ログインと比較した場合の制限事項:
- 組織の切り替えは利用できません
- Serverless クラスター上では: データベース管理、ユーザー／ロール管理が制限される場合があります
- 一部のコントロールプレーン操作には OAuth ログインが必要になる場合があります

オプション 3: 環境変数による設定

シェルプロファイル（.zshrc / .bashrc）に以下を追加できます:

export ZILLIZ_API_KEY=<your-api-key>

認証が完了したら、以下を実行して確認してください:

zilliz auth status

configure サブコマンド

zilliz configure              # インタラクティブな API キーのセットアップ
zilliz configure list          # 全設定値の表示
zilliz configure set <key> <value>  # 設定値のセット
zilliz configure get <key>     # 設定値の取得
zilliz configure clear         # 全認証情報のクリア

組織の切り替え

これらのコマンドはインタラクティブなターミナルを必要とします。ユーザー自身のターミナルで実行するよう案内してください:

# インタラクティブな選択
zilliz auth switch

# 組織 ID を指定して直接切り替え
zilliz auth switch <org-id>

ログアウト

zilliz logout

クラスターコンテキストの設定

コレクション、ベクター、インデックスなどのデータプレーンコマンドには、アクティブなクラスターコンテキストが必要です。

# クラスター ID で設定（エンドポイントは自動解決）
zilliz context set --cluster-id <cluster-id>

# エンドポイントを明示して設定
zilliz context set --cluster-id <cluster-id> --endpoint <url>

# データベースの変更（デフォルト: "default"）
zilliz context set --database <db-name>

現在のコンテキストの確認

zilliz context current

出力フォーマット

すべての zilliz-cli コマンドは --output json オプションに対応しており、構造化されたマシンリーダブルな出力が得られます。結果をプログラムで解析する必要がある場合に使用してください:

zilliz cluster list --output json
zilliz collection describe --name <name> --output json

利用可能なフォーマット: json、table、text。デフォルトは text です。

クラスタータイプの違い

クラスタータイプによって対応している機能が異なります:

機能	Free	Serverless	Dedicated
コレクション CRUD	可	可	可
ベクター検索／クエリ	可	可	可
データベースの作成／削除	不可	不可	可
ユーザー／ロール管理	不可	制限あり	可
バックアップ管理	不可	可	可
クラスターの変更	不可	不可	可

コマンドがパーミッションエラーで失敗した場合は、まずクラスタータイプを確認してください。そのクラスタータイプでは当該機能が利用できない可能性があります。

トラブルシューティング

インストール後に「command not found」が表示される: インストール先ディレクトリ（例: ~/.local/bin）が PATH に含まれているか確認してください。インストールスクリプトを再実行してみてください: curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
「not authenticated」エラー: zilliz auth status を実行してログイン状態を確認してください。トークンが期限切れの可能性があります。自分のターミナルで再度ログインを実行してください。
コンテキストエラー（クラスターが未設定）: zilliz context current を実行して確認してください。クラスターが削除または停止されている場合は、zilliz context set --cluster-id <id> で新しいコンテキストを設定してください。
パーミッションエラーまたは「not supported」エラー: クラスタータイプを確認してください。一部の操作は Dedicated クラスターでのみ利用可能です（上記の「クラスタータイプの違い」表を参照）。
ネットワークエラーまたはタイムアウトエラー: zilliz cluster describe --cluster-id <id> を実行して、クラスターが RUNNING 状態であることを確認してください。停止中のクラスターはデータプレーンのリクエストを拒否します。

ガイダンス

コマンドを実行する前に、必ず前提条件を確認してください。
前提条件を満たしていない場合は、先に進む前に問題を解消してください。スキップしないでください。
zilliz login、zilliz configure、引数なしの zilliz auth switch は Claude Code 内で絶対に実行しないでください。これらはインタラクティブな入力を必要とするため、必ずユーザー自身のターミナルで実行するよう案内してください。
API キーをチャットに貼り付けるようユーザーに求めないでください。セキュリティリスクとなります。認証情報は自分のターミナルで設定するよう案内してください。
ユーザーからログイン完了の報告を受けたら、zilliz auth status で確認してください。
コンテキストを設定したら、zilliz context current で確認してください。
他の skill におけるデータプレーンコマンドを実行する前に、必ずコンテキストが設定されていることを確認してください。
コマンドが予期せず失敗した場合は、クラスタータイプまたは認証モードが原因である可能性を検討してください。

原文（English）を表示

Prerequisites

Before running any zilliz-cli command, verify the following in order:

CLI installed and up to date? Run curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash to ensure the latest version is installed.
Logged in? Run zilliz auth status. If not logged in, guide through login (see below).
Context set? (Only for data-plane operations) Run zilliz context current. If no context, guide through context setup.

Commands Reference

Install / Upgrade CLI

curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash

Verify installation:

zilliz --version

Authentication

IMPORTANT: Login commands (zilliz login, zilliz configure) require an interactive terminal and CANNOT run inside Claude Code. Always instruct the user to run these in their own terminal.

Check if already logged in:

zilliz auth status

If not logged in, tell the user to open their own terminal and run one of the following:

Option 1: Browser-based login (OAuth) — full feature access

zilliz login

Opens a browser for authentication
Retrieves user info, organization data, and API keys
Use --no-browser in headless environments (displays a URL to visit manually)

Option 2a: API Key via login command

zilliz login --api-key

Option 2b: API Key via configure (legacy)

zilliz configure

Prompts for an API key (found in Zilliz Cloud console under API Keys)
Limitations compared to OAuth login:
- Organization switching not available
- On Serverless clusters: database management, user/role management may be restricted
- Some control-plane operations may require OAuth login

Option 3: Environment variable

User can add to their shell profile (.zshrc / .bashrc):

export ZILLIZ_API_KEY=<your-api-key>

After the user completes authentication, verify by running:

zilliz auth status

Configure Subcommands

zilliz configure              # Interactive API key setup
zilliz configure list          # Show all config values
zilliz configure set <key> <value>  # Set a config value
zilliz configure get <key>     # Get a config value
zilliz configure clear         # Clear all credentials

Switch Organization

These commands require an interactive terminal. Instruct the user to run in their own terminal:

# Interactive selection
zilliz auth switch

# Direct switch by org ID
zilliz auth switch <org-id>

Logout

zilliz logout

Set Cluster Context

Data-plane commands (collection, vector, index, etc.) require an active cluster context.

# Set by cluster ID (endpoint auto-resolved)
zilliz context set --cluster-id <cluster-id>

# Set with explicit endpoint
zilliz context set --cluster-id <cluster-id> --endpoint <url>

# Change database (default: "default")
zilliz context set --database <db-name>

View Current Context

zilliz context current

Output Format

All zilliz-cli commands support --output json for structured, machine-readable output. Use this when you need to parse results programmatically:

zilliz cluster list --output json
zilliz collection describe --name <name> --output json

Available formats: json, table, text. Default is text.

Cluster Type Differences

Different cluster types have different feature support:

Feature	Free	Serverless	Dedicated
Collection CRUD	Yes	Yes	Yes
Vector search/query	Yes	Yes	Yes
Database create/drop	No	No	Yes
User/role management	No	Limited	Yes
Backup management	No	Yes	Yes
Cluster modify	No	No	Yes

When a command fails with a permissions error, check the cluster type first — the feature may not be available on that cluster type.

Troubleshooting

"command not found" after install: Check that the install directory (e.g., ~/.local/bin) is in your PATH. Try re-running the install script: curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash.
"not authenticated" errors: Run zilliz auth status to check login state. Tokens may have expired — re-run login in your own terminal.
Context errors (no cluster set): Run zilliz context current to verify. If the cluster was deleted or suspended, set a new context with zilliz context set --cluster-id <id>.
Permission or "not supported" errors: Check the cluster type — some operations are only available on Dedicated clusters (see Cluster Type Differences table above).
Network or timeout errors: Verify the cluster is RUNNING with zilliz cluster describe --cluster-id <id>. Suspended clusters reject data-plane requests.

Guidance

Always check prerequisites before executing any command.
If a prerequisite fails, fix it before proceeding — do not skip ahead.
NEVER run zilliz login, zilliz configure, or zilliz auth switch (without arguments) inside Claude Code — they require interactive input. Always instruct the user to run these in their own terminal.
NEVER ask the user to paste API keys into the chat — this is a security risk. Guide them to configure credentials in their own terminal instead.
After the user reports login is complete, verify with zilliz auth status.
After setting context, verify with zilliz context current.
For data-plane commands in other skills, always verify context is set first.
When a command fails unexpectedly, consider whether the cluster type or auth mode may be the cause.

原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。