Quickstart
Nervix is experimental software in active development. It is intended for evaluation, local testing, and design exploration. It is not suitable for real production workloads.
This section takes you from nothing to a running Nervix graph. It is a hands-on tutorial: each step is a small, complete change that you apply to a live single-node cluster and verify before moving on. You build one graph throughout — it starts as a trivial pass-through pipeline and grows into a branched graph with conditional routing and structured error handling.
- Installation: getting Nervix onto your machine
- Running Nervix: starting a single-node server, connecting a client, and starting the Kafka and Redis containers the tutorial talks to
- Your First Pipeline: Kafka To Redis: read JSON orders from a Kafka topic and publish them to a Redis Pub/Sub channel
- Conditional Routing: split the stream with a junction, route filters, and computed fields
- Branched Processing: partition the stream per customer and deduplicate independently inside each branch
- Error Routes: capture failing records as structured errors on a dead-letter relay
- HTTP Ingestion: POST records straight at the server through a vhost-hosted endpoint
- JAQ Transformations: reshape foreign JSON at the boundary with a jq-style codec
- Protobuf Codecs: decode binary payloads from uploaded
.protodefinitions - User-Defined Functions: package expression logic as a reusable compiled Roto function
- Window Aggregates: summarize the stream with per-customer sliding windows
- Generators: emit periodic records from materialized relay state
- Correlators: join orders with payments across two streams
- Altering A Running Graph: change routing logic and evolve schemas without tearing anything down
- Paced Domains: replay timestamped history on an accelerated domain clock
Every page links the Manual chapter that documents each feature in full: the tutorial shows one working path, and the manual holds the reference.