# Orbital

> Orbital runs agent workflows on your own machine. A workflow is a file of steps: agent prompts, commands and gates. Orbital runs each step with a coding agent such as Claude Code, Codex or OpenCode, keeps the run's history, and can deliver the work as a pull request.

Every page below is plain Markdown. https://docs.beta.runorbital.dev/llms-full.txt holds all of them in one file.

## Docs

- [Overview](https://docs.beta.runorbital.dev/index.md): Agents that finish the job. Turn goals into finished work.
- [Install Orbital](https://docs.beta.runorbital.dev/get-started/install.md): Install the Mac app or the orbital command, then sign in to a harness
- [Start your first run](https://docs.beta.runorbital.dev/get-started/first-run.md): Add a repository as a project, run explain-repo and read its answer
- [Build with AI](https://docs.beta.runorbital.dev/get-started/build-with-ai.md): Give agents and chat assistants Orbital's docs, its MCP endpoint and its skills
- [How Orbital works](https://docs.beta.runorbital.dev/concepts/how-orbital-works.md): How a run carries out a workflow, step by step, with the coding agents you already use
- [Runs](https://docs.beta.runorbital.dev/runs.md): A run carries out one workflow for one project, towards one goal
- [Workflows](https://docs.beta.runorbital.dev/workflows.md): A workflow is one file of steps and edges that Orbital runs
- [Durability after restarts](https://docs.beta.runorbital.dev/runs/durability.md): Every run carries on where it was when Orbital starts again
- [Projects and folders](https://docs.beta.runorbital.dev/projects.md): A project is a name and the folders its runs work in
- [Harnesses and models](https://docs.beta.runorbital.dev/harnesses.md): A harness is the coding agent that does each agent step
- [Roles and tool access](https://docs.beta.runorbital.dev/roles.md): Named building blocks decide who a step's agent is and what it uses
- [Start a run](https://docs.beta.runorbital.dev/runs/start-a-run.md): Give a project a goal, pick a workflow and start a run
- [Watch a run](https://docs.beta.runorbital.dev/runs/watch-a-run.md): Find a run, see what it is doing and read its changes
- [Message a run](https://docs.beta.runorbital.dev/runs/message-a-run.md): Steer a working agent or answer its question from the composer
- [Pause, stop or resolve a run](https://docs.beta.runorbital.dev/runs/control-a-run.md): Pause, resume, retry, abort, archive or resolve a run
- [The run queue](https://docs.beta.runorbital.dev/runs/queue.md): Orbital runs a set number of runs at once and queues the rest
- [Write your first workflow](https://docs.beta.runorbital.dev/workflows/write-a-workflow.md): Run the smallest complete workflow: one agent step and one terminal
- [Write prompts](https://docs.beta.runorbital.dev/workflows/write-prompts.md): Read run values in a prompt, and use conditions, loops and filters
- [Add branches](https://docs.beta.runorbital.dev/workflows/add-branches.md): Send a run to different steps with conditions on its edges
- [Add a loop](https://docs.beta.runorbital.dev/workflows/add-a-loop.md): Send work back to an earlier step, and stop the loop after a set number of rounds
- [Run steps in parallel](https://docs.beta.runorbital.dev/workflows/run-steps-in-parallel.md): Run independent review steps at once and collect their results
- [Reuse a workflow](https://docs.beta.runorbital.dev/workflows/reuse-a-workflow.md): Move a shared sequence of steps into its own workflow file and import it
- [Pass context between steps](https://docs.beta.runorbital.dev/workflows/pass-context.md): Hand a value from one step to the next through the run's context
- [Add gates and waits](https://docs.beta.runorbital.dev/workflows/gates-and-waits.md): Stop a run for a person with a gate, or for a set time with a wait
- [Triggers](https://docs.beta.runorbital.dev/triggers.md): Rules that start, stop, pause or message runs when something happens
- [Make a trigger rule](https://docs.beta.runorbital.dev/triggers/make-a-rule.md): Create a rule that acts on runs, test it, and follow what it does
- [Supervisor](https://docs.beta.runorbital.dev/supervisor.md): A standing chat that watches your runs and steps in when one needs help
- [Lead delivery with a supervisor](https://docs.beta.runorbital.dev/supervisor/lead-delivery.md): Put a delivery lead over your runs, as a coding agent or the Supervisor
- [Chats](https://docs.beta.runorbital.dev/chats.md): Talk to one coding agent in its own worktree, with no workflow
- [Create a project](https://docs.beta.runorbital.dev/projects/create-a-project.md): Add a project and its folders, then set its run limit and actions
- [Worktrees and delivery](https://docs.beta.runorbital.dev/projects/worktrees-and-delivery.md): Code workflows work in a worktree, open a pull request and see it merged
- [Switch a run's harness](https://docs.beta.runorbital.dev/harnesses/switch-harness.md): Retry a run's current step on another harness, by hand or automatically
- [Use different models](https://docs.beta.runorbital.dev/harnesses/use-different-models.md): Run different steps on different harnesses, models and efforts
- [Give steps a role](https://docs.beta.runorbital.dev/roles/configure-steps.md): Choose each step's role, persona, model settings and tool access in the editor
- [Settings](https://docs.beta.runorbital.dev/settings.md): Where Settings is and what each of its sections is for
- [Connect a coding agent](https://docs.beta.runorbital.dev/mcp/connect.md): Register Claude Code, Codex, OpenCode or any MCP client with Orbital
- [Use the shipped skills](https://docs.beta.runorbital.dev/mcp/skills.md): Install Orbital's two agent skills and ask coding agents to use them
- [The orbital command](https://docs.beta.runorbital.dev/command-line.md): Run Orbital, validate workflows and start runs from a terminal
- [Troubleshooting](https://docs.beta.runorbital.dev/troubleshooting.md): Find the fix for a symptom, or report a bug with the right files

## Examples

- [Implement a feature](https://docs.beta.runorbital.dev/examples/feature-pull-request.md): Turn a short goal or a ticket into a reviewed, merged pull request
- [Deliver an epic](https://docs.beta.runorbital.dev/examples/deliver-an-epic.md): Deliver an epic's tickets in dependency order, one merged pull request each
- [Review pull requests](https://docs.beta.runorbital.dev/examples/review-pull-requests.md): Start a review run each time someone opens a pull request
- [Improve a codebase](https://docs.beta.runorbital.dev/examples/improve-a-codebase.md): Deliver small improvements one at a time, or one focused refactor, without a ticket
- [Triage issues](https://docs.beta.runorbital.dev/examples/triage-issues.md): Propose a label, priority and next step for each open issue, without changing the tracker
- [Research report](https://docs.beta.runorbital.dev/examples/research-report.md): Research a question on the web and write a short report with sources
- [One-shot implementation](https://docs.beta.runorbital.dev/examples/workflows/one-shot-implementation.md): The smallest workflow that delivers real work, from worktree to pull request
- [Implementer with a local step](https://docs.beta.runorbital.dev/examples/workflows/local-step.md): An Implementer checked by a command step, routing on what the machine observed
- [Outer loop over an epic](https://docs.beta.runorbital.dev/examples/workflows/epic.md): An outer loop that delivers an epic's tickets through a sub workflow
- [Ticket to merge](https://docs.beta.runorbital.dev/examples/workflows/ticket.md): A complete workflow that takes a ticket to a merged pull request, like the shipped delivery sub workflows

## Reference

- [Attributes](https://docs.beta.runorbital.dev/reference/attributes.md): Every attribute a workflow, node or edge takes, with its values and defaults
- [Node types](https://docs.beta.runorbital.dev/reference/node-types.md): The eight kinds of step a workflow can hold, what each does and the attributes it takes
- [Template variables](https://docs.beta.runorbital.dev/reference/template-variables.md): The variables a prompt template can read, from inputs to the current work
- [Context](https://docs.beta.runorbital.dev/reference/context.md): What run context holds, where each value comes from, and when it is available
- [Error handling](https://docs.beta.runorbital.dev/reference/error-handling.md): Route failed steps, bound repair loops, and see what happens when nothing matches
- [History and threads](https://docs.beta.runorbital.dev/reference/history-and-threads.md): What each prompt carries from earlier steps, and how sessions and threads continue
- [The orbital command](https://docs.beta.runorbital.dev/reference/command.md): Every orbital subcommand with its options, an example and its exit codes, plus environment variables and data files
- [HTTP API](https://docs.beta.runorbital.dev/reference/http-api.md): Find the running server, authenticate, then list runs and projects and start runs from a script
- [MCP tools](https://docs.beta.runorbital.dev/reference/mcp-tools.md): Every tool on Orbital's MCP endpoint, with its arguments, result and an example, plus tool groups and supervisor limits
- [Settings](https://docs.beta.runorbital.dev/reference/settings.md): Every Settings field with its default and values, and the settings file behind them
- [Accounts and privacy](https://docs.beta.runorbital.dev/reference/accounts.md): What signing in to the Orbital web app shares, what Orbital asks GitHub for, and how to take it back.
- [Models and prices](https://docs.beta.runorbital.dev/reference/models.md): The models Orbital suggests for each agent, their reference prices, and how to set your own
- [Shipped workflows](https://docs.beta.runorbital.dev/reference/shipped-workflows.md): The eight workflows Orbital ships, what each needs, and their shared sub workflows