Docs
Getting started
Start with the console guide for your role, or run a local stack from a licensed Riptide checkout. The guides below cover account access, setup, and your first test request.
Using the console?
Choose the guide for the work you want to do. Start a workspace or sign in to follow along.
Run a local stack
1. Get access
Riptide source and private deployment tooling are available to customers under a commercial agreement. Request access if you do not already have a checkout.
2. Bring up local infrastructure
This starts Postgres, Redis, ScyllaDB, Redpanda, ClickHouse, and Grafana in Docker.
make dev-up
3. Generate code from contracts
Generate Go clients and server code, plus MCP tool definitions, from the protocol and
OpenAPI contracts. Generated files are written to gen/. To generate the
Python admin SDK as well, run make gen-sdk-python.
make gen
4. Apply database migrations
make migrate
5. Run a service
make run svc=serve
6. Run the tests
Run the unit, golden, contract, and integration tests.
make test
What's next
Use the Admin API or MCP to connect an application or agent. Read architecture for how the services work together, and private deployments for production setup.
Need access or help with setup?
Tell us which setup guide you are following and where you are blocked. Request workspace access for a managed deployment or a licensed checkout for local development.