Skip to main content

Command Line Interface


The Command Line Interface (CLI) is currently in alpha. This documentation shows the limited functionality that is available today. Contact for feedback and other inquiries.


The Responsive CLI runs a proxy server that handles communication with storage services and control plane services that run in the Responsive network. Today, it supports the following operations:

  1. use: selects the store to use
  2. find: retrieve the value for a specific key
  3. update: updates the value for a specific key
Responsive CLI

This can be used in various scenarios, for example you can leverage this tool to debug a bad join result by examining the contents of the store for the key that caused the undesirable result. You can also patch records in stores that have been corrupted either by bad processing logic or invalid upstream data.

Getting Started

Today, installation is available only via Docker and you must run both the proxy server and the CLI for it to function. Both the CLI and the proxy server accept the same properties file as a ResponsiveKafkaStreams application. If constructing a standalone configuration for use with the CLI, include the following configurations:

responsive.mongo.usernameif configured with security
responsive.mongo.passwordif configured with security
schema.registry.urlif your store uses schema registry
schema.registry.basic.auth.user.infoif your schema registry is configured with basic auth

This configuration file must be mounted at /mnt/, which the docker container will look for when configuring.

# first run the proxy server
$ docker run --init \
-v <path/to/app.propertie>s:/mnt/ \
-p 8080:8080 run-statestore-proxy

This will create the server, which listens to port 8080. The interactive CLI will connect to this server over the localhost network1:

docker run -it --init \
--network host \
-v <path/to/>:/mnt/ \ responsive-cli


use <store>Specifies which state store to use in this session. This should match the name of your state store
find <key>Finds the value for the specified key and prints it out. If using schema registry, the schema registry deserializer will be used to deserialize the value
update <key> <value>Updates the key to the given value. If using schema registry, the specified value will be validated for correct schema before updating the value.
setType <target> <type>Sets either the KEY or VALUE serde to be one of RAW, BASE64 or JSON.2

  1. You can avoid using the host network by executing into the docker container created by the first command and run bash responsive-cli.

  2. RAW will use the text raw UTF8 bytes. BASE64 will assume the target is Base64 encoded. JSON will assume a correct JSON encoding.