Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rollulus committed Mar 25, 2016
1 parent e9da6e8 commit e9e79c0
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Kafka Connect CLI
=================

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]`.
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 `#`.
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] [<connector-name>...]
Expand Down Expand Up @@ -33,6 +31,11 @@ Commands dealing with configuration expect or produce data in .properties style:
<connector-name>...
connector name(s)

Usage
=====

Clone this repository, do a `mvn package` and run the jar in a way you prefer, for example with the provided `cli` shell script. The CLI can be used as follows.

Get Active Connectors
---------------------

Expand Down Expand Up @@ -107,3 +110,9 @@ Example:
track.terms=test
#task ids: 0

Misc
====

Contributions are encouraged, feedback to [rollulus](https://keybase.io/rollulus) at xs4all dot nl, recommendations for more idiomatic Scala are welcome.

Thanks, enjoy!

0 comments on commit e9e79c0

Please sign in to comment.