Orion README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Orion listing page.
Orion
Build services at AI speed on a consistent, governed foundation.
Define the business logic in JSON. Orion supplies the runtime around it.
Orion is a declarative services runtime. An Orion service consists of a workflow and a channel, with optional connectors to external systems. Post those definitions, activate them, and the service is live—without writing an application server, building a container for each service, or restarting the runtime.
Orion consistently handles the surrounding infrastructure: routing, ingress guards, rate limits, timeouts, retries, circuit breakers, connection pooling, version rollout, rollback, metrics, and tracing. Definitions can be written by a developer or proposed by an AI assistant; they follow the same draft, test, activation, and audit path.
[!NOTE] Orion is designed for request- and event-shaped work expressible as ordered task functions and JSONLogic. It is not a general-purpose application runtime or a durable workflow engine. See When Orion fits before choosing it for a project.
Quickstart
This tested path uses Docker, curl, and a POSIX-compatible shell. It starts a
local Orion instance, deploys an order-processing workflow and channel, and
calls the resulting API.
1. Start Orion
2. Inspect and deploy the example
The script makes four administration calls: it creates and activates a
workflow, then creates and activates its channel. It finishes with a test
request and is safe to run again. From a cloned repository, run
./examples/quickstart.sh instead.
3. Call your service
The response contains the parsed order with "flagged": true. The workflow
holds the business logic; the channel exposes it at POST /orders. Routing,
validation, tracing, and lifecycle management are supplied by Orion.
For expected output, troubleshooting, Windows-friendly installation paths, and cleanup instructions, follow the complete quickstart.
The core model
| Primitive | Purpose | Example |
|---|---|---|
| Channel | Receives traffic and applies ingress policy | POST /orders, Kafka topic, 0 15 2 * * * order.placed |
| Workflow | Runs the business logic as an ordered task pipeline | Parse → validate → enrich → respond |
| Connector | Provides a reusable connection to an external system | PostgreSQL, Redis, Kafka, REST API |
The definitions belonging to one service can be shipped together as a package. One Orion instance can run many packages side by side, each with its own lifecycle and rollout.
How Orion works explains request execution, composition, deployment topology, and extension boundaries in one page.
What you can build
- Microservice and decision APIs: expose transformations, validation, pricing, eligibility, and routing decisions over HTTP.
- Webhook and data-ingestion services: normalize incoming payloads and read or write external systems through governed connectors.
- Kafka consumers: process records, publish results, and route failed messages to a dead-letter topic.
- AI-agent tools: expose governed HTTP operations that an assistant can draft, dry-run, activate, and roll back using the Orion CLI and agent skill.
- Scheduled jobs: run a workflow on a cron expression instead of on a request, with every scheduled instant recorded as a durable occurrence.
- Composable services: call another channel in-process with
channel_call, while preserving the callee's guards and preventing cycles.
Choose a focused path in
What are you building?,
or deploy a tested package from examples/packages/.
Runtime capabilities
| Area | Included capability |
|---|---|
| Traffic | REST, plain HTTP, synchronous and asynchronous channels, Kafka ingress, cron schedules |
| Safety | Payload validation, API-key/HMAC/JWT channel auth, rate limiting, backpressure, CORS controls |
| Resilience | Timeouts, retries, circuit breakers, idempotency, response caching, dead-letter handling |
| Delivery | Drafts, immutable versions, dry-runs, percentage rollout, rollback, packages, WebAssembly plugins, ONNX models admitted before they serve |
| Observability | Health and readiness endpoints, Prometheus metrics, structured logs, OpenTelemetry traces |
| Data | PostgreSQL, MySQL, SQLite, MongoDB, Elasticsearch, Redis, Kafka, HTTP, SMTP, S3-compatible storage |
| Operations | Embedded SQLite for one node; PostgreSQL/MySQL and Redis for clustered replicas |
Configuration is explicit, and several production controls are permissive or disabled for local development. In particular, data channels are open unless they declare authentication or sit behind an authenticating proxy. Before exposing an instance, work through the production checklist.
Safe changes, including AI-generated ones
Workflow, channel, and connector definitions use the same governed lifecycle regardless of who authored them. A draft serves no traffic. You can validate and dry-run it, approve the exact version, activate it without restarting the server, roll traffic out by percentage, and return to a previous immutable version. Administrative changes are recorded in the audit log.
For AI-assisted authoring, install the Orion agent skill or use the self-contained prompt pack. The Claude Code tutorial walks through a complete assisted workflow.
When Orion fits
Orion fits services whose work starts with an HTTP request or Kafka record, completes as a bounded pipeline, and can be expressed with Orion's task functions and JSONLogic. It is especially useful when many small services need the same operational and governance foundation.
Choose another runtime, or pair one with Orion, when:
- work must survive restarts at an intermediate step or wait hours or days;
- ingress requires gRPC, WebSockets, or streaming responses;
- business logic requires arbitrary code with I/O, or a scripting runtime — a pure transformation ships as a sandboxed WebAssembly plugin, anything that has to reach another system does not;
- image processing, GPU-class inference, or large in-memory joins sit on the hot path — a small ONNX graph runs in-process as a governed model, a large one does not; or
- full OIDC flows or mutual TLS must terminate inside the data plane. JWT verification is built in; those flows require a gateway or service mesh.
Read Is Orion right for
you? for detailed comparisons
with durable execution engines, API gateways, automation platforms, rule
engines, and embedded dataflow-rs.
Install
The current workspace release is 1.12.0 and requires Rust 1.98 when built from source. The server and CLI are released in lockstep; use matching versions.
Release installers are also available for Linux, macOS Apple Silicon, and Windows. See Install & Run for every method, platform support, startup, and verification.
Useful local commands:
The server command reference and Orion CLI reference list all commands and flags.
Performance
The published Orion 1.0.0 benchmark measured 5.1K–5.7K workflow requests per second on one Apple M2 Pro instance, with single-digit-millisecond average latency across the recorded workflow scenarios. These are release- and workload-specific results, not capacity guarantees. Review the benchmark record for hardware, scenarios, tail latency, cluster results, and reproduction steps.
Documentation
The full manual is at docs.goplasmatic.io.
| Goal | Start here |
|---|---|
| Try Orion | Quickstart |
| Understand the model | How Orion works |
| Build a complete service | Orders API golden path |
| Find an exact schema | Reference index |
| Deploy and operate | Operate Orion |
| Secure production | Production checklist |
| Upgrade safely | Upgrades |
| Check compatibility | Support & compatibility |
The documentation source lives in docs/src/. Edit that directory,
not the generated docs/book/ output. See docs/STYLE_GUIDE.md
for its structure and editorial conventions.
Project and community
- Orion UI provides the browser-based operations console.
orion-climanages workflows, channels, connectors, plugins and schedules from a terminal.CONTRIBUTING.mdcovers development setup, tests, and pull requests.- Use GitHub Discussions for questions and GitHub Issues for bugs.
- Report vulnerabilities privately according to
SECURITY.md. - If you use Orion, add your project to
ADOPTERS.md.
Orion is built by Plasmatic and released under the Apache License 2.0.