Install the Confluent Cloud CLI

You can use the Confluent Cloud CLI to administer your Confluent Cloud cluster. The Confluent Cloud CLI is supported for macOS, Linux, and Unix-based operating systems.

Important

  • The Confluent Cloud CLI only supports basic produce or consume operations. For example, you cannot pass in a properties file using the Confluent Cloud CLI. This means you cannot set other configuration properties or produce with keys. For advanced produce or consume operations, use the use the Confluent CLI confluent local produce and confluent local consume commands with the --cloud --config <path-to-file> flag.
  • The Confluent Cloud CLI requires users to log in with a Confluent Cloud user account.
  • The Confluent Cloud CLI is interactive and does not support scripting.

Scripted installation

Run this command to install the Confluent Cloud CLI. This command creates a bin directory in your designated location (<path-to-directory>/bin).

Important

The CLI installation location must be in your PATH (e.g. /usr/local/bin).

curl -L https://cnfl.io/ccloud-cli | sh -s -- -b /<path-to-directory>/bin

Tarball installation

Download and install the raw binaries by platform.

Next steps

  • Run this command to log in to your Confluent Cloud cluster.

    ccloud login --url https://confluent.cloud
    

    Your output should resemble:

    Enter your Confluent credentials:
    Email: jdoe@myemail.io
    Password:
    
    Logged in as jdoe@myemail.io
    Using environment t118 ("default")
    
  • Run this command to view your cluster.

    ccloud kafka cluster list
    

    Your output should resemble:

          Id      |       Name        | Provider |   Region    | Durability | Status
    +-------------+-------------------+----------+-------------+------------+--------+
        lkc-emmox | My first cluster  | gcp      | us-central1 | LOW        | UP
        lkc-low0y | My second cluster | gcp      | us-central1 | LOW        | UP
    
  • Run this command to designate the active cluster.

    ccloud kafka cluster use lkc-emmox
    
  • Verify installation by typing ccloud in your terminal.

    ccloud
    

    You should see Confluent Cloud CLI usage information:

    Welcome to the Confluent Cloud CLI
    
    Usage:
      ccloud [command]
    
    Available Commands:
      api-key         Manage API keys
      completion      Output shell completion code
      environment     Manage and select ccloud environments
      help            Help about any command
      kafka           Manage Kafka
      login           Login to Confluent Cloud
      logout          Logout of Confluent Cloud
      service-account Manage service accounts
      update          Update ccloud
      version         Print the ccloud version
    
    Flags:
      -h, --help            help for ccloud
      -v, --verbose count   increase output verbosity
          --version         version for ccloud
    
  • Connect Confluent Cloud CLI to a Cluster.

Uninstall the Confluent Cloud CLI

Run these commands to uninstall the Confluent Cloud CLI. These commands assume you have installed the CLI in the /usr/local/bin folder.

rm -rf ~/.ccloud/

sudo rm /usr/local/bin/ccloud

Uninstall CLI Versions Prior to 0.78.x

You can uninstall versions of the Confluent Cloud CLI prior to 0.78.x with these instructions. You can check the version of the Confluent Cloud CLI with the ccloud version command.

Tip

Confluent Cloud CLI versions prior to 0.78.x stored their configuration in .ccloud/config. This file is no longer used and can be deleted. For more information, see Login and Configuration.

MacOS

Run this command from your terminal:

brew uninstall ccloud

Linux

  1. Delete the Confluent Cloud CLI files and folder from your system. For example:

    rm -rf <path-to-ccloud-cli>/ccloud-0.2.1
    
  2. Remove the entry from your PATH environment variable.

Windows

  1. Delete the Confluent Cloud CLI files and folder from your system. For example:

    rm -rf <path-to-ccloud-cli>/ccloud-0.2.1
    
  2. Remove the entry from your JAVA_HOME environment variable.

Previous Confluent Cloud Versions

To install a previous version of the Confluent Cloud CLI, see the 5.2.0 CLI documentation.