Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Install the Confluent Cloud CLI

Follow the instructions for installing the Confluent Cloud CLI based on your operating system.

MacOS

Install using these brew commands:

1. Tap the Confluent repository for Confluent Cloud.

   brew tap confluentinc/ccloud
   

2. Install Confluent Cloud.

   brew install ccloud
   

3. Optional: Verify installation by typing ccloud in your terminal.

   ccloud
   

   You should see Confluent Cloud CLI usage information:

   usage: ccloud [(--config-dir <configDir> | -c <configDir>)] [(--verbose | -v)]
           <command> [<args>]
   
   The most commonly used ccloud commands are:
       consume   Consume from a topic.
       help      Display help information
       init      Initialize the CLI.
       produce   Produce to a topic.
       topic     Manage topics.
       version   Print the version number.
   
   See 'ccloud help <command>' for more information on a specific command.
   

Linux

Download and unzip the Confluent Cloud tarball.

1. Download and unzip from here. Add the contents of the bin directory to your PATH environment variable so that which ccloud finds the Confluent Cloud CLI command.

2. Optional: Verify installation by typing ccloud in your terminal.

   ccloud
   

   You should see Confluent Cloud CLI usage information:

   usage: ccloud [(--config-dir <configDir> | -c <configDir>)] [(--verbose | -v)]
           <command> [<args>]
   
   The most commonly used ccloud commands are:
       consume   Consume from a topic.
       help      Display help information
       init      Initialize the CLI.
       produce   Produce to a topic.
       topic     Manage topics.
       version   Print the version number.
   
   See 'ccloud help <command>' for more information on a specific command.
   

Windows

Download and unzip the Confluent Cloud ZIP file.

1. Download and unzip from here. Use the bin/ccloud.ps1 PowerShell script to run Confluent Cloud CLI.

2. Set the JAVA_HOME environment variable.

3. Optional: Verify installation by typing ccloud in your terminal.

   .\bin\ccloud.ps1 <command>
   

   You should see Confluent Cloud CLI usage information:

   usage: ccloud [(--config-dir <configDir> | -c <configDir>)] [(--verbose | -v)]
           <command> [<args>]
   
   The most commonly used ccloud commands are:
       consume   Consume from a topic.
       help      Display help information
       init      Initialize the CLI.
       produce   Produce to a topic.
       topic     Manage topics.
       version   Print the version number.
   
   See 'ccloud help <command>' for more information on a specific command.