zkcli

README

zkcli

Simple, lightweight, dependable CLI for ZooKeeper

zkcli is a non-interactive command line client for ZooKeeper. It provides with:

• Basic CRUD-like operations: create, set, delete, exists, get, ls (aka children).
• Extended operations: lsr (ls recursive), creater (create recursively)
• Well formatted and controlled output: supporting either txt or json format
• Single, no-dependencies binary file, based on a native Go ZooKeeper library by github.com/samuel/go-zookeeper (LICENSE)

Download & Install

There are pre built binaries for download. You can find RPM and deb packages, as well as pre-compiled, dependency free zkcli executable binary. In fact, the only file installed by the pre-built RPM and deb packages is said executable binary file.

Otherwise the source code is freely available; you will need git installed as well as go, and you're on your own.

Usage:

$ zkcli --help
Usage of zkcli:
  -c="": command (exists|get|ls|lsr|create|creater|set|delete)
  -debug=false: debug mode (very verbose)
  -force=false: force operation
  -format="txt": output format (txt|json)
  -servers="": srv1[:port1][,srv2[:port2]...]
  -stack=false: add stack trace upon error
  -verbose=false: verbose

Examples:

$ zkcli --servers srv-1,srv-2,srv-3 -c create /demo_only some_value

# Default port is 2181. The above is equivalent to:
$ zkcli --servers srv-1:2181,srv-2:2181,srv-3:2181 -c create /demo_only some_value

$ zkcli --servers srv-1,srv-2,srv-3 --format=txt -c get /demo_only
some_value

# Same as above, JSON format output:
$ zkcli --servers srv-1,srv-2,srv-3 --format=json -c get /demo_only
"some_value"

# exists exits with exit code 0 when path exists, 1 when path does not exist 
$ zkcli --servers srv-1,srv-2,srv-3 -c exists /demo_only
true

$ zkcli --servers srv-1,srv-2,srv-3 -c set /demo_only another_value

$ zkcli --servers srv-1,srv-2,srv-3 --format=json -c get /demo_only
"another_value"

$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only

$ zkcli --servers srv-1,srv-2,srv-3 -c get /demo_only
2014-09-15 04:07:16 FATAL zk: node does not exist

$ zkcli --servers srv-1,srv-2,srv-3 -c create /demo_only "path placeholder"
$ zkcli --servers srv-1,srv-2,srv-3 -c create /demo_only/key1 "value1"
$ zkcli --servers srv-1,srv-2,srv-3 -c create /demo_only/key2 "value2"
$ zkcli --servers srv-1,srv-2,srv-3 -c create /demo_only/key3 "value3"

$ zkcli --servers srv-1,srv-2,srv-3 -c ls /demo_only
key3
key2
key1

# Same as above, JSON format output:
$ zkcli --servers srv-1,srv-2,srv-3 --format=json -c ls /demo_only
["key3","key2","key1"]

$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only
2014-09-15 08:26:31 FATAL zk: node has children

$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only/key1
$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only/key2
$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only/key3
$ zkcli --servers srv-1,srv-2,srv-3 -c delete /demo_only

# /demo_only path now does not exist.

# Create recursively a path:
$ zkcli --servers=srv-1,srv-2,srv-3 -c creater "/demo_only/child/key1" "val1"
$ zkcli --servers=srv-1,srv-2,srv-3 -c creater "/demo_only/child/key2" "val2"

# "-c creater" is same as "-c create --force"

$ zkcli --servers=srv-1,srv-2,srv-3 -c get "/demo_only/child/key1"
val1

# This path was auto generated due to recursive create:
$ zkcli --servers=srv-1,srv-2,srv-3 -c get "/demo_only" 
zkcli auto-generated

# ls recursively a path and all sub children:
$ zkcli --servers=srv-1,srv-2,srv-3 -c lsr "/demo_only" 
child
child/key1
child/key2

The tool was built in order to allow with shell scripting seamless integration with ZooKeeper. There is another, official command line tool for ZooKeeper that the author found inadequate in terms of output format and output control, as well as large footprint. zkcli overcomes those limitations and provides with quick, well formatted output as well as enhanced functionality.

License

Release under the Apache 2.0 license

Authored by Shlomi Noach at Outbrain