https://github.com/rollulus/kafka-connect-cli

A CLI for Kafka Connect; moved to https://github.com/datamountaineer/kafka-connect-tools
https://github.com/rollulus/kafka-connect-cli

Last synced: 4 months ago
JSON representation

A CLI for Kafka Connect; moved to https://github.com/datamountaineer/kafka-connect-tools

• Host: GitHub
• URL: https://github.com/rollulus/kafka-connect-cli
• Owner: rollulus
• Created: 2016-03-11T15:36:03.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-05-30T08:42:29.000Z (over 9 years ago)
• Last Synced: 2025-08-28T10:52:12.419Z (6 months ago)
• Language: Scala
• Homepage:
• Size: 14.6 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Kafka Connect CLI

=================

Development is continued at: https://github.com/datamountaineer/kafka-connect-tools

-----------------------------------------------------------------------------------

This is a tiny command line interface (CLI) around the [Kafka Connect REST Interface](http://docs.confluent.io/2.0.1/connect/userguide.html#rest-interface) to manage connectors.

It is used in a git like fashion where the first program argument indicates the command: it can be one of `[ls|get|rm|create|run]`.

The CLI is meant to behave as a good unix citizen: input from `stdin`; output to `stdout`; out of band info to `stderr` and non-zero exit status on error.

Commands dealing with configuration expect or produce data in .properties style: `key=value` lines and comments start with a `#`.

    kafconcli 1.0

    Usage: kafconcli [ls|get|rm|create|run] [options] [...]

      --help

            prints this usage text

      -e  | --endpoint 

            Kafka REST URL, default is http://localhost:8083/

    Command: ls

    list active connectors names.

    Command: get

    get information about the specified connector(s).

    Command: rm

    remove the specified connector(s).

    Command: create

    create the specified connector with the .properties from stdin; the connector cannot already exist.

    Command: run

    create or update the specified connector with the .properties from stdin.

      ...

            connector name(s)

Get Active Connectors

---------------------

Command: `ls`

Example:

    $ ./cli ls

    twitter-source

Get Connector Information

-------------------------

Command: `get`

Example:

    $ ./cli get twitter-source

    #Connector `twitter-source`:

    name=twitter-source

    tasks.max=1

    (snip)

    track.terms=test

    #task ids: 0

Delete a Connector

------------------

Command: `rm`

Example:

    $ ./cli rm twitter-source

Create a New Connector

----------------------

The connector cannot already exist.

Command: `create`

Example:

    $ ./cli create twitter-source