Skip to content
/ izk Public

Interactive zookeeper shell, with autocompletion, syntax highlighting and history

License

Notifications You must be signed in to change notification settings

brouberol/izk

Repository files navigation

IZK: interactive zookeeper

Build Status Coverage Status

izk is a modern and simple zookeeper shell, with autocompletion, history search, vi bindings, syntax highlighting and pretty-printing.

asciicast

Installation

To install izk, simply run

$ pip install izk

izk is Python 3 only. I do not plan to support Python 2, but it that's important to you, feel free to contribute!

Docker

izk is also available as a docker image. To run it, execute

$ docker run -it brouberol/izk

Note that to ease usage woith docker, all command-line arguments can be passed as environment variables, prefixed with IZK_.

Example: here is how to run izk --write in docker

$ docker run -it -e IZK_WRITE=1 brouberol/izk

Usage

$ izk --help
usage: izk [-h] [--eval [EVAL]] [--write WRITE]
           [--style {default,emacs, ...}]
           [--version]
           [zk_url]

CLI for zookeeper with syntax-highlighting and auto-completion.

positional arguments:
  zk_url                URL of the zookeeper node. Default: localhost:2181.
                        Override via the IZK_ZK_URL environment variable.

optional arguments:
  -h, --help            show this help message and exit
  --eval [EVAL]         Evaluate a single zk command and exit
  --write WRITE         Authorize write operations (update/insert/remove).
                        Override via the IZK_WRITE environment variable.
  --style {default,emacs, ...}
                        The color style to adopt. Default: monokai. Override
                        via the IZK_STYLE environment variable.
  --input-mode {vi,emacs}
                        The input mode to adopt. Default: vi. Override via the
                        IZK_INPUT_MODE environment variable.
  --version             Display izk version number and exit

Version: 0.4.4

Local Development

If you plan on developing on izk, you can install the local code by running

$ poetry run izk

You can then start a local zookeeper instance by running

$ docker run -it -p 2181:2181 --name zookeeper --rm zookeeper

About

Interactive zookeeper shell, with autocompletion, syntax highlighting and history

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •