Install the WarpStream Agent / CLI

WarpStream packages the Agent and a utility CLI into a single binary.

The WarpStream Agent / CLI can be installed in one of three ways:

1. with our Docker container from our public Docker registry.

2. with our installation script.

3. by downloading the binary for your platform directly.

Installation Script

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

This option is recommended for local development.

Docker

We host our public Docker registry using Amazon ECR. Our docker image is multi arch: linux x86-64 and arm-64 are supported.

ECR Public Gallery

Quick Run Commands (Playground)

Port 8080 for Kinesis/Prometheus metrics, port 9092 for Apache Kafka-compatible API.

In playground mode, the Agent will advertise its IP address as localhost instead of the Docker internal IP address by default. This will allow you to connect to the agent from a client running locally. You can change this behavior with the advertiseHostnameStrategy flag.

If you're trying to run the WarpStream Agent as part of a larger docker-compose setup, then check out our reference on how to run WarpStream in docker-compose as you'll need to configure a different set of environment variables for service discovery to work properly.

playground

docker run -p 8080 -p 9092:9092 public.ecr.aws/warpstream-labs/warpstream_agent:latest playground

Quick Run Commands (Demo)

demo

docker run public.ecr.aws/warpstream-labs/warpstream_agent:latest demo

Binaries

Latest

Platform	Version	URL
linux/amd64	latest	Download
linux/arm64	latest	Download
darwin(macOS)/amd64	latest	Download
darwin(macOS)/arm64	latest	Download