CLI Reference

Description

The following page documents the available WarpStream CLI commands.

Install the WarpStream CLI by pasting the following command into your Terminal:

curl https://console.warpstream.com/install.sh | sh

Commands

The following table displays the available top-level warpstream commands.

Command	Description
warpstream agent	Command line tool for adminstering the WarpStream Agent.
warpstream demo	Creates a temporary WarpStream account, provisions a local WarpStream cluster (writing to memory by default), and provisions a producer client to send data to the Agents.
warpstream cli	Command line tool for Kafka/WarpStream admin commands.
warpstream local	Runs a fully in-memory, self-contained WarpStream cluster (Kafka + Schema Registry + Tableflow) with no connection to the WarpStream control plane. Intended for CI.
warpstream playground	Creates a temporary WarpStream account and provisions a local WarpStream cluster (writing to memory by default).