nitro

command module
v0.0.0-...-5528672 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 25, 2023 License: MIT Imports: 6 Imported by: 0

README

Nitro

Modern Command Line Tool for Apache Kafka.


Nitro is a Modern Command Line Tool for Apache Kafka. It is easy to install and use. Here is some of the features:

  • Consume messages on specific partitions between specific offsets.
  • Display topic information (e.g., with partition offset and leader info).
  • Modify consumer group offsets (e.g., resetting or manually setting offsets per topic and per partition).
  • JSON output for easy consumption with tools like kp or jq.
  • JSON input to facilitate automation via tools like jsonify.
  • Support for TLS authentication.
  • Cluster administration functions: Create & delete topics.

Documentation

Installation

Download the latest nitro binary. Make it executable from everywhere.

$ export LATEST_VERSION=$(curl --silent "https://api.github.com/repos/clivern/nitro/releases/latest" | jq '.tag_name' | sed -E 's/.*"([^"]+)".*/\1/' | tr -d v)

$ curl -sL https://github.com/clivern/nitro/releases/download/v{$LATEST_VERSION}/nitro_{$LATEST_VERSION}_Linux_x86_64.tar.gz | tar xz

Usage

To run a local kafka cluster with docker & docker-compose for testing, you can use the following command:

$ nitro cluster run [name] [port]

$ nitro cluster run local_clus1 3000
$ nitro cluster run local_clus2 3001

Please note that the above command requires both docker and docker-compose.

To destroy local clusters

$ nitro cluster destroy [name]

$ nitro cluster destroy local_clus1
$ nitro cluster destroy local_clus2

To list all configured clusters

$ nitro cluster list

To show cluster info

$ nitro cluster show [name]

$ nitro cluster show local_clus1

To add a new remote cluster

$ nitro cluster add [name]

$ nitro cluster add remote_cluster

To remove a configured cluster

$ nitro cluster show [name]

$ nitro cluster remove remote_cluster

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Nitro is maintained under the Semantic Versioning guidelines and release process is predictable and business-friendly.

See the Releases section of our GitHub project for changelogs for each release version of Helmet. It contains summaries of the most noteworthy changes made in each release.

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/nitro/issues

Security Issues

If you discover a security vulnerability within Nitro, please send an email to hello@clivern.com

Contributing

We are an open source, community-driven project so please feel free to join us. see the contributing guidelines for more details.

License

© 2022, Clivern. Released under MIT License.

Nitro is authored and maintained by @Clivern.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
core

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL