Install the WarpStream Agent / CLI
This page contains instructions for installing the WarpStream Agent via CURL, Docker, or raw binaries.
WarpStream packages the Agent and a utility CLI into a single binary.
The WarpStream Agent / CLI can be installed in one of three ways:
With our Docker container from our public Docker registry.
With our installation script.
Downloading the binary for your platform directly.
curl https://console.warpstream.com/install.sh | bashThis option is recommended for local development.
We have special docker tags latest and latest-stable in our ECR repos. latest is always the latest published version, while latest-stable corresponds to the most recent version that is at least one month old.
We host our public Docker registry using Amazon ECR. Our docker image is multi arch: linux x86-64 and arm-64 are supported.
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.
Quick Run Commands (Demo)
The links below are for the latest version of the WarpStream Agent binary. Latest version will always be the latest version published, while latest stable is the latest version that has been published for at least one month.
If you want to download the WarpStream Agent binary as of a specific version, use the URL templates below to select your architecture and then replace the value of $VERSION with the version tag from the change log.
darwin(macOS)/amd64
Last updated
Was this helpful?