Confluent Hub 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.

Available Commands

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.