> ## Documentation Index
> Fetch the complete documentation index at: https://ventstream.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install

> Download the VentStream engine and the fleet CLI

## Supported platforms

| Platform                      | Engine (`ventstream`)      | Fleet CLI (`ventstreamctl`)             |
| ----------------------------- | -------------------------- | --------------------------------------- |
| macOS (Apple Silicon / Intel) | ✅                          | ✅                                       |
| Linux (arm64 / amd64)         | ✅                          | ✅                                       |
| Windows                       | via **WSL2** or **Docker** | ✅ `.zip` download (no installer script) |

Windows is not supported natively for the engine — it is a server workload.
Run it inside WSL2 (the Linux installer works there as-is) or as a container.

## Engine

One line — detects your OS and architecture, verifies checksums, installs to
`~/.local/bin`:

```bash theme={null}
curl -fsSL https://ventstream.dev/install.sh | sh
```

Or grab a specific platform build from the
[releases page](https://github.com/ventstream/ventstream/releases/latest).
Container images are available for containerized deployments — see
[Deploy](/docs/deploy/kubernetes-managed-engine).

Pin a version or change the location with env vars:

```bash theme={null}
VENTSTREAM_VERSION=0.1.21 VENTSTREAM_INSTALL_DIR=/usr/local/bin \
  curl -fsSL https://ventstream.dev/install.sh | sh
```

## Fleet CLI (managed users)

```bash theme={null}
curl -fsSL https://ventstream.dev/install-cli.sh | sh
```

**Windows:** download `ventstreamctl-<version>-windows-amd64.zip` from the
[CLI releases page](https://github.com/ventstream/ventstream-releases/releases/latest),
unzip, and put `ventstreamctl.exe` on your `PATH`.

Every artifact ships with `SHA256SUMS` and per-platform SBOMs; the installer
scripts verify checksums before installing.

## Verify

```bash theme={null}
ventstream --version
ventstreamctl version
```

## Try it

This is all it takes to stream CDC from MongoDB into Elasticsearch or
OpenSearch — every insert, update, and delete, snapshot-bootstrapped and
then live from the change stream:

```bash theme={null}
VS_ROLES=cdc VS_CDC_SOURCE=mongodb \
VS_MONGO_URI='mongodb+srv://user:pass@cluster.example.net/?retryWrites=true' \
VS_MONGO_DATABASE=shop \
VS_MONGO_STATE_DIR=./state \
VS_MONGO_BOOTSTRAP_MODE=snapshot \
VS_OS_ENDPOINT=http://localhost:9200 \
VS_INDEX_TEMPLATE='${header:ventstream.cdc.relation}' \
ventstream
```

One index per collection, deterministic document ids, deletes propagate.
Swap the source for [Postgres](/docs/connectors/sources/postgres),
[MySQL](/docs/connectors/sources/mysql), or [Neo4j](/docs/connectors/sources/neo4j),
or the sink for [Meilisearch](/docs/connectors/sinks/meilisearch) or
[Redis](/docs/connectors/sinks/redis) — same binary. For a full guided run with
seeded data, take the [Quickstart](/docs/quickstart).