# 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. Downloading the binary for your platform directly.

{% tabs %}
{% tab title="Installation Script" %}

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

This option is recommended for local development.
{% endtab %}

{% tab title="Docker" %}
{% hint style="info" %}
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.
{% endhint %}

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

{% embed url="<https://gallery.ecr.aws/warpstream-labs>" %}

**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](/warpstream/reference/integrations/use-the-agent-in-docker-compose.md) as you'll need to configure a different set of environment variables for service discovery to work properly.

{% code title="playground" overflow="wrap" %}

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

{% endcode %}

**Quick Run Commands (Demo)**

{% code title="demo" overflow="wrap" %}

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

{% endcode %}
{% endtab %}

{% tab title="Binaries" %}
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.

<table><thead><tr><th width="244.66666666666666">Platform</th><th>Latest</th><th>Latest Stable</th></tr></thead><tbody><tr><td><code>linux/amd64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_amd64_latest.tar.gz">Download</a></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_amd64_latest.tar.gz">Download</a></td></tr><tr><td><code>linux/arm64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_arm64_latest.tar.gz">Download</a></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_arm64_latest.tar.gz">Download</a></td></tr><tr><td><code>darwin(macOS)/amd64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_amd64_latest.tar.gz">Download</a></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_amd64_latest.tar.gz">Download</a></td></tr><tr><td><code>darwin(macOS)/arm64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_arm64_latest.tar.gz">Download</a></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_arm64_latest.tar.gz">Download</a></td></tr></tbody></table>

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](/warpstream/overview/change-log.md).

<table><thead><tr><th width="244.66666666666666">Platform</th><th>URL</th></tr></thead><tbody><tr><td><code>linux/amd64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_amd64_latest.tar.gz">https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_amd64_$VERSION.tar.gz</a></td></tr><tr><td><code>linux/arm64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_arm64_latest.tar.gz">https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_linux_arm64_$VERSION.tar.gz</a></td></tr><tr><td><code>darwin(macOS)/amd64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_amd64_latest.tar.gz">https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_amd64_$VERSION.tar.gz</a></td></tr><tr><td><code>darwin(macOS)/arm64</code></td><td><a href="https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_arm64_latest.tar.gz">https://warpstream-public-us-east-1.s3.amazonaws.com/warpstream_agent_releases/warpstream_agent_darwin_arm64_$VERSION.tar.gz</a></td></tr></tbody></table>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.warpstream.com/warpstream/getting-started/install-the-warpstream-agent.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.