Skip to main content
VentStream is distributed as one native engine binary for:
  • Linux AMD64 and ARM64
  • macOS AMD64 and Apple silicon
Linux archives target the Ubuntu 22.04 runtime baseline (glibc 2.35 or newer), and macOS archives target macOS 12 or newer. Windows amd64 ships natively from engine v0.1.28 (irm https://ventstream.dev/install.ps1 | iex) with every connector except the Kafka source — for Kafka pipelines on Windows, run the engine inside WSL2 (the Linux installer works there as-is) or use the container image. Without an agent key, the binary runs in standalone mode. It reads ventstream.yaml, resolves secret references from the local environment, and connects directly to the configured source, sink, and optional NATS infrastructure. It does not require the VentStream Cloud control plane, and with no agent key it makes zero platform connections.

​
Install with curl

The installer detects the operating system and CPU architecture, downloads the matching release archive, verifies it against the release SHA256SUMS, checks the binary version, and installs it under ~/.local/bin.
It also installs a non-secret example at ~/.config/ventstream/ventstream.example.yaml. Existing configuration files are never overwritten. Install a specific version or directory:

​
Configure and run

Copy the example into a workload directory:
The packaged example is PostgreSQL CDC to OpenSearch. Supply its referenced values through the environment:
Validate the complete configuration without opening connector sockets:
Then start the engine:
Use the source guides for PostgreSQL, Neo4j, MongoDB, MySQL/MariaDB, and Kafka/Redpanda. Native WebSocket and GraphQL roles use the same binary and are covered by the real-time guide.

​
Download an archive manually

Release archives are also available as ordinary HTTPS downloads:
On macOS, replace sha256sum --check with shasum -a 256 --check.

​
Verify provenance

The installer has a GitHub build-provenance attestation. Users who require provenance verification before execution can download and verify it instead of piping it directly to the shell:
Every native archive also has GitHub build-provenance and SBOM attestations. Verify the archive against this repository before installation:
SHA256SUMS detects transfer corruption or substitution relative to the published release record. Attestation verification additionally proves that the archive was produced by this repository’s release workflow.

​
Standalone boundary

The standalone process retains cursor and projection state locally. Stop the process to pause it and restart it to resume. Organization-wide CLI inventory, remote configuration, centralized pause/resume, and agent health require a managed deployment. The same binary becomes managed when started with a deployment’s agent key. Try it locally:
A managed engine takes configuration from the pipeline’s selected revision — an agent key alongside local source, sink, or specs sections is a hard startup error, so a running standalone workload must be restarted with a key and without its local pipeline configuration to become managed.