Skip to content

Commit

Permalink
Add NOTICE file and README.
Browse files Browse the repository at this point in the history
Signed-off-by: Marios Andreopoulos <opensource@andmarios.com>
  • Loading branch information
andmarios committed Jun 13, 2017
1 parent a2f84b2 commit dcc6eb6
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
5 changes: 5 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kafka-autocomplete
Copyright 2017 Landoop LTD.

This product includes software developed at
Landoop LTD (http://www.landoop.com).
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Kafka Autocomplete

This repository implements bash completion for some of the Kafka command line
utilities.

In order to build and install:

git clone https://github.com/Landoop/kafka-autocomplete.git
cd kafka-autocomplete
./build.sh

You will find the completion file under `release/kafka`. You can source it in
your terminal or drop it in `/etc/bash_completion.d/`. You have to set up
bash-completion too, which depends on your distribution of choice.

Currently completion is provided for three utilities:

- kafka-topics
- kafka-console-consumer
- kafka-console-producer

We provide completion for options, kafka configs and kafka properties.
Especially for `kafka-topics` if you set the `--zookeeper` switch, we try to
offer completion for topics as well.

<img src="https://storage.googleapis.com/wch/kafka-autocomplete.png" alt="kafka autocomplete screenshot" type="image/png" width="900">

---

The repository is provide under Apache 2.0 license. See LICENSE and NOTICE
for more information.

0 comments on commit dcc6eb6

Please sign in to comment.