Confluent Platform CLI
Switch branches/tags
v6.0.0-beta181011024526 v6.0.0-beta181009071136 v6.0.0-beta181009071126 v6.0.0-beta181009070836 v5.1.0-rc1 v5.1.0-beta201806200051 v5.1.0-beta201806191956 v5.1.0-beta39 v5.1.0-beta38 v5.1.0-beta37 v5.1.0-beta36 v5.1.0-beta35 v5.1.0-beta34 v5.1.0-beta180929024526 v5.1.0-beta180928000756 v5.1.0-beta180919183606 v5.1.0-beta180917172706 v5.1.0-beta180912202326 v5.1.0-beta180911213206 v5.1.0-beta180905054157 v5.1.0-beta180829024526 v5.1.0-beta180828173516 v5.1.0-beta180828022857 v5.1.0-beta180824214446 v5.1.0-beta180820223106 v5.1.0-beta180812233046 v5.1.0-beta180730185716 v5.1.0-beta180724024536 v5.1.0-beta180723173636 v5.1.0-beta180723023347 v5.1.0-beta180722215127 v5.1.0-beta180718203536 v5.1.0-beta180707004950 v5.1.0-beta180706202701 v5.1.0-beta180703024529 v5.1.0-beta180702220040 v5.1.0-beta180702214311 v5.1.0-beta180702063440 v5.1.0-beta180702063039 v5.1.0-beta180701175749 v5.1.0-beta180701010040 v5.1.0-beta180630224439 v5.1.0-beta180628184841 v5.1.0-beta180628064520 v5.1.0-beta180627203509 v5.1.0-beta180626014959 v5.1.0-beta180622181348 v5.1.0-beta180620183559 v5.1.0-beta180620180739 v5.1.0-beta180620180431 v5.1.0-beta180619025141 v5.1.0-beta180618225004 v5.1.0-beta180618223247 v5.1.0-beta180618214711 v5.1.0-beta180618191747 v5.1.0-beta180615005408 v5.1.0-beta180614233101 v5.1.0-beta180613013021 v5.1.0-beta180612224009 v5.1.0-beta180612043613 v5.1.0-beta180611231144 v5.0.2-beta181118024524 v5.0.2-beta181117022246 v5.0.2-beta181116205152 v5.0.2-beta181116204811 v5.0.2-beta181116204629 v5.0.1 v5.0.1-rc3 v5.0.1-rc2 v5.0.1-rc1 v5.0.1-beta181018200736 v5.0.1-beta181008233543 v5.0.1-beta180914024526 v5.0.1-beta180913003126 v5.0.1-beta180911213156 v5.0.1-beta180909000436 v5.0.1-beta180909000146 v5.0.1-beta180905054336 v5.0.1-beta180902210116 v5.0.1-beta180830182727 v5.0.1-beta180828173436 v5.0.1-beta180826190446 v5.0.1-beta180824214627 v5.0.1-beta180812233236 v5.0.1-beta180802235906 v5.0.0 v5.0.0-rc4 v5.0.0-rc3 v5.0.0-rc1 v5.0.0-beta33 v5.0.0-beta32 v5.0.0-beta31 v5.0.0-beta30 v5.0.0-beta29 v5.0.0-beta28 v5.0.0-beta27 v5.0.0-beta26 v5.0.0-beta25 v5.0.0-beta24 v5.0.0-beta23
Nothing to show
Clone or download
Latest commit 9773c90 Nov 7, 2018

README.md

Confluent Platform CLI

A CLI to start and manage Confluent Platform from command line.

Installation

  • Download and install Confluent OSS

  • Checkout confluent-cli by running:

    $ git clone git@github.com:confluentinc/confluent-cli.git
  • Set CONFLUENT_HOME environment variable to point to the location of Confluent OSS. For instance:

    $ export CONFLUENT_HOME=/usr/local/confluent-3.3.0
  • Install confluent-cli:

    $ cd confluent-cli; make install

Usage

To get a list of available commands, run:

$ export PATH=${CONFLUENT_HOME}/bin:${PATH};
$ confluent help

Examples:

  • Start all the services!
$ confluent start
  • Retrieve their status:
$ confluent status
  • Open the log file of a service:
$ confluent log connect
  • Access runtime stats of a service:
$ confluent top kafka
  • Discover the availabe Connect plugins:
$ confluent list plugins
  • or list the predefined connector names:
$ confluent list connectors
  • Load a couple connectors:
$ confluent load file-source
$ confluent load file-sink
  • Get a list with the currently loaded connectors:
$ confluent status connectors
  • Check the status of a loaded connector:
$ confluent status file-source
  • Read the configuration of a connector:
$ confluent config file-source
  • Reconfigure a connector:
$ confluent config file-source -d ./updated-file-source-config.json
  • or reconfigure using a properties file:
$ confluent config file-source -d ./updated-file-source-config.properties
  • Figure out where the data and the logs of the current confluent run are stored:
$ confluent current
  • Unload a specific connector:
$ confluent unload file-sink
  • Stop the services:
$ confluent stop
  • Start on a clean slate next time (deletes data and logs of a confluent run):
$ confluent destroy

Set CONFLUENT_CURRENT if you want to use a top directory for confluent runs other than your platform's tmp directory.

$ cd $CONFLUENT_HOME
$ mkdir -p var
$ export CONFLUENT_CURRENT=${CONFLUENT_HOME}/var
$ confluent current