Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Guides

Step-by-step tutorials for common Orloj workflows.

Start here: Your First Agent System in 5 Minutes — install orlojctl and orlojd, scaffold a pipeline with orlojctl init, add an API key, apply manifests, and run a task end-to-end with the web console.

Other guides use real manifests from the examples/ directory or walk through authoring resources by hand. For ready-made scenario folders (full YAML sets you can copy into your environment), see examples/use-cases/.

If you have not installed Orloj yet, begin with Install. Developers building from a clone may prefer the Quickstart (go run + checked-in blueprints).

Available Guides

Your First Agent System in 5 Minutes The fastest path from zero to a running multi-agent pipeline with a real model.

Deploy Your First Pipeline For platform engineers who want to run a multi-agent pipeline end-to-end. Walk through the pipeline blueprint: define three agents (planner, researcher, writer), wire them into a sequential graph, submit a task, and inspect the results.

Set Up Multi-Agent Governance For platform engineers who need to enforce tool authorization and model constraints. Create policies, roles, and tool permissions. Deploy a governed agent system and verify that unauthorized tool calls are denied.

Configure Model Routing For platform engineers who need to route agents to different model providers. Set up ModelEndpoints for OpenAI and Anthropic, bind agents to endpoints by reference, and verify that requests route correctly.

Connect an MCP Server For platform engineers who want to integrate MCP-compatible tool servers. Register an MCP server (stdio or HTTP), verify tool discovery, filter imported tools, and assign them to agents.

Build a Custom Tool For developers who need to extend agent capabilities with external tools. Implement the Tool Contract v1, register the tool as a resource, configure isolation and retry, and validate with the conformance harness.

Capture README Orloj in Action Media For maintainers refreshing repository branding assets. Generate reproducible frontend screenshots and lifecycle GIF media for the README Orloj in Action section.

Run Your First Agent Evaluation For platform engineers and ML teams who want to measure agent quality. Create a golden dataset, run evaluations with multiple scoring strategies, compare models side-by-side, and set up human review workflows.

Call AgentSystems via OpenAI Chat Completions For teams that already speak the OpenAI Chat Completions API. Point an OpenAI client at Orloj, set model to an AgentSystem name, and invoke governed multi-agent runs without a custom integration.

Build an Interactive Agent Session For teams building copilots, support chats, and human-steered agent workflows. Create a durable multi-turn Session, submit idempotent messages, consume replayable SSE, and pause or resume execution.

Chat with an AgentSystem For operators and developers collaborating with an AgentSystem from the terminal. Learn the Session mental model, design a conversational coordinator, stream turns with orlojctl chat, review tool actions inline, and resume a durable conversation.