Confluent Hub Client

The Confluent Hub client is a command line tool that makes it easy to install and update components from Confluent Hub into a local Confluent Platform installation.

Installing Confluent Hub Client

Important

If you are using Confluent Platform 5.0.0 or later, you can skip this section and continue to Installing Components With Confluent Hub Client.

If you’re using Confluent Platform 4.1.x or earlier, follow the instructions below to install the Confluent Hub client.

Archive

Follow these instructions to install the Confluent Hub client from a TAR archive:

  1. Download the Confluent Hub client archive.
  2. Extract the archive file into a directory.
  3. Optional: add the bin directory to your path so you can run confluent-hub from anywhere.
  4. Optional: verify the installation by running confluent-hub

Installing Components With Confluent Hub Client

The most common purpose is to install a component from Confluent Hub into a local Confluent Platform installation:

$ confluent-hub install <owner>/<component>:<version>

where

  • <owner> is the name of the component’s owner on Confluent Hub;
  • <component> is the name of the component on Confluent Hub; and
  • <version> is either the version of the component on Confluent Hub or the literal latest when you just want to install the latest version of the component

Click the “Installation” tab of a component on Confluent Hub to get the specific confluent-hub install command for that particular component.

Tip

If the “Installation” tab doesn’t give the Confluent Hub command, the component owner has not yet provided a download. In this case, you can follow the instructions on the “Installation” tab or contact the component owner for details.

Command Reference

Confluent Hub client has several command line options that let you fully control its behavior, and it can be used in scripts and Dockerfiles where the client has already been installed.

Command Description
confluent-hub help Print help for the client or a specific command.
confluent-hub install Install a component from Confluent Hub.

To list available commands, run confluent-hub with no parameters:

usage: confluent-hub <command> [ <args> ]

Commands are:
    help      Display help information
    install   install a component from either Confluent Hub or from a local file

See 'confluent-hub help <command>' for more information on a specific command.

Error Codes

The confluent-hub client uses the following codes for errors:

Code Description
0 Successful completion
1 Component not found, which must be either a valid identifier from Confluent Hub in format <owner>/<name>:<version>, or the absolute or relative path to a local ZIP file downloaded from Confluent Hub.
2 Invalid options or arguments
3 Network problems
4 Error while reading from/writing to filesystem
5 Security issues
6 Component is already installed
7 Unknown error
8 Component is not available for installation yet