Skip to main content

login

This operation authenticates the CLI with Zilliz Cloud and saves the login state for later commands. Use browser login for interactive local use, API-key login for scripts or headless environments, and --cn with --api-key when logging in to the Zilliz Cloud China site.

Description

Authenticates the CLI with Zilliz Cloud and saves the login state for later commands. Use browser login for interactive local use and API-key login for scripts or headless environments.

Synopsis

bash
zilliz login
[--api-key <value>]
[--no-browser]
[--cn]

Options

  • --api-key (string) -

    Authenticates with an API key instead of browser OAuth. If provided without a value, prompts interactively.

  • --no-browser (boolean) -

    Uses the device-code flow without opening a browser.

  • --cn (boolean) -

    Authenticates to the Zilliz Cloud China site. The China site uses API-key login, so combine --cn with --api-key.

Example

bash
# Browser OAuth login
zilliz login

# Login with API key
zilliz login --api-key sk-xxxxxxxxxxxx

# Login to the Zilliz Cloud China site
zilliz login --cn --api-key sk-xxxxxxxxxxxx
Minimum SDK versionv1.4.x
Ctrl I