Skip to main content

Installation

This guide covers installing the TypeStream CLI and starting a local development environment.

Install the CLI​

brew install typestreamio/tap/typestream

Verify the installation:

typestream --version

Prerequisites​

You need Docker and Docker Compose installed to run TypeStream locally.

Start the local environment​

TypeStream ships with a local command group that manages a full Docker Compose stack: Redpanda (Kafka-compatible broker), Schema Registry, Envoy proxy, and the TypeStream server.

Production mode​

Run the full stack (server inside Docker):

typestream local start

You should see:

INFO 🚀 starting TypeStream server
INFO 🛫 starting server
INFO 🛫 starting redpanda
INFO ✨ redpanda started
INFO ✨ server started
INFO ✅ server healthy
INFO ✅ redpanda healthy
INFO 🎉 TypeStream server started

Development mode​

If you're developing on the server itself, use dev mode. This starts only the infrastructure services -- you run the server on your host for hot reload:

typestream local dev

Then start the server separately:

./scripts/dev/server.sh

Demo data​

Demo data generators start automatically with the local environment. After a few seconds, verify the topics are available:

echo 'ls /dev/kafka/local/topics' | typestream

You should see topics like web_visits, crypto_tickers, wikipedia_changes, and _schema.

Stop the environment​

typestream local stop

To stop and remove all volumes (clean slate):

typestream local dev clean

Configuration​

TypeStream is configured via a typestream.toml file. At startup, the server looks for this file using the TYPESTREAM_CONFIG_PATH environment variable, then falls back to the current directory and /etc/typestream.

Default configuration:

[grpc]
port = 4242

[sources.kafka.local]
bootstrapServers = "localhost:9092"
schemaRegistry.url = "http://localhost:8081"
fsRefreshRate = 60

See the configuration reference for all options.