You are viewing documentation for an older version of Confluent Platform. For the latest, click here.
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¶
Follow the instructions below to install the Confluent Hub client.
Follow these instructions to install the Confluent Hub client from a TAR archive:
- Download the Confluent Hub client archive.
- Extract the archive file into a directory.
- Optional: add the
bindirectory to your path so you can run
- Optional: verify the installation by running
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>
<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
latestwhen 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.
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.
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.
|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.
confluent-hub client uses the following codes for errors:
|1||Component not found, which must be either a valid identifier from
Confluent Hub in format
|2||Invalid options or arguments|
|4||Error while reading from/writing to filesystem|
|6||Component is already installed|
|8||Component is not available for installation yet|