Skip to main content

Zilliz Codex Plugin

Zilliz Codex Plugin lets OpenAI Codex operate Zilliz Cloud through natural language. After installation, Codex can help you install and use Zilliz CLI, authenticate to Zilliz Cloud, set an active cluster context, and run common cloud and data operations such as managing clusters, collections, vectors, indexes, imports, backups, users, roles, and monitoring status.

Prerequisites​

  • You have installed OpenAI Codex.

  • You have a Zilliz Cloud account.

  • You can install Codex plugins in your local Codex environment.

Setup procedure​

1

Add the marketplace.

plaintext
codex plugin marketplace add zilliztech/zilliz-plugin
2

Open /plugins in Codex and install zilliz from the marketplace.

You can also install directly with codex-marketplace as follows.

plaintext
npx codex-marketplace add zilliztech/zilliz-plugin --plugins

Initial setup​

After installation, invoke the quickstart skill in Codex. For example, ask Codex:

plaintext
Set up the Zilliz CLI.

The setup flow will guide you through:

1

Install Zilliz CLI.

The plugin requires the Zilliz CLI. If not installed, run:

bash
curl -fsSL https://zilliz.com/cli/install.sh | bash

Verify installation:

bash
zilliz --version
2

Authenticate.

Authenticate with your Zilliz Cloud account:

bash
zilliz login

This opens a browser for authentication. After login, your credentials are stored locally.

3

Connect to your cluster.

Configure your default cluster connection:

bash
zilliz context set --cluster-id <your-cluster-id>

Or let the plugin help you select from available clusters.

Verification​

Test the plugin with a simple request:

plaintext
List my clusters.

The plugin should display your Zilliz Cloud clusters.

You can also ask Codex to check your current environment:

plaintext
Show my Zilliz Cloud status.

Troubleshooting​

  • Plugin does not appear in Codex

    Solution: Make sure the marketplace was added successfully:

    plaintext
    codex plugin marketplace add zilliztech/zilliz-plugin

    Then open /plugins and install zilliz.

  • Plugin shows "CLI not found"

    Solution: Install the Zilliz CLI:

    bash
    curl -fsSL https://zilliz.com/cli/install.sh | bash

  • Authentication fails

    Solution:

    1. Check your internet connection.

    2. Verify your Zilliz Cloud account is active.

    3. Try logging out and back in:

    plaintext
    zilliz logout
    zilliz login

  • No cluster configured

    Solution: Set a default cluster:

    plaintext
    zilliz context set --cluster-id <cluster-id>

Next step​

Zilliz Codex Plugin, Zilliz Claude Code Plugin, and Zilliz Gemini CLI Extension all use Zilliz CLI as the underlying execution layer. You can read Zilliz Claude Code Plugin Capabilities and Zilliz Claude Code Plugin Examples to learn how to write prompts.

Contact Sales
Ctrl I