Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jonwiggins/optio/llms.txt

Use this file to discover all available pages before exploring further.

Workflows are multi-step pipelines where each step is a separate agent task. Steps run sequentially — each step waits for the previous one to complete before starting. If a step fails, the pipeline stops and all subsequent steps are skipped. Workflows are managed at /workflows in the UI.

Concepts

  • Workflow template — a reusable pipeline definition with an ordered list of steps. Templates have a status of draft, active, or archived.
  • Workflow run — a live instance of a template. Each run tracks the overall pipeline status and a mapping from each step to the task it created.
  • Step — a single unit of work in the pipeline. Each step has a title, a prompt, and optionally a specific repository and agent type. Steps can also declare a condition that controls whether they run.

Creating a workflow template

1

Open the Workflows page

Navigate to /workflows and click New workflow.
2

Name and describe the workflow

Give the template a name and an optional description that explains its purpose. Set the status to draft while you’re building it.
3

Add steps

Add one or more steps in order. For each step provide:
  • Title — a short label shown in the pipeline view.
  • Prompt — the full instruction sent to the agent for that step.
  • Repository (optional) — override the repository for this step. If omitted, the repository is specified when the workflow is run.
  • Agent type (optional) — defaults to claude-code.
  • Condition (optional) — control when the step runs:
    • always — always run this step (default).
    • if_pr_opened — only run if the previous step opened a PR.
    • if_ci_passes — only run if CI checks on the previous step’s PR are passing.
    • if_cost_under — only run if the total workflow cost so far is below a threshold.
4

Activate the template

Change the status from draft to active when the template is ready to run. Archived templates cannot be run but are preserved for reference.

Running a workflow

1

Find the template

On the /workflows page, locate the template you want to run. Only active templates can be started.
2

Start a run

Click Run. If any steps in the template do not specify a repository, you will be prompted to provide a default repository URL that applies to those steps.
3

Monitor the run

Optio creates a workflow run and immediately enqueues the first step as an agent task. You are taken to the run detail view.The pipeline timeline shows each step with its current status. Click any step to open the underlying task and view its logs.

Step execution and failure behavior

Steps run strictly in the order they are defined. When a step’s task reaches a terminal state:
  • Completed or PR opened — the next step is evaluated. If the step’s condition is met, it is enqueued. If the condition is not met, the step is skipped and the next one is evaluated.
  • Failed or cancelled — the pipeline stops. The workflow run is marked failed. Steps that have not started remain in a pending state and will not run.
There is no automatic retry for failed workflow steps. To re-run a failed pipeline from the beginning, start a new workflow run. To resume from a specific step, you can force-restart or force-redo the underlying task from the task detail view.

Viewing workflow runs

From the workflow template page, the Runs tab lists all past and active runs. Each run shows:
  • Overall statusrunning, completed, failed, or cancelled.
  • Per-step status — a pipeline timeline with the status of each step’s task.
  • Task links — click any step to open the corresponding task detail page with full logs.
  • Started / completed timestamps.

Common use cases

Feature branch pipeline

Step 1: implement the feature. Step 2: run a review agent on the opened PR. Step 3: apply any requested changes.

Multi-repo release

Step 1: bump version in the library repo. Step 2: update the downstream consumer repo to use the new version.

Dependency update

Step 1: update dependencies and open a PR. Step 2: run the test suite and fix any failures.

Scaffolding + review

Step 1: scaffold a new module from a description. Step 2: review the generated code against your style guide.

Build docs developers (and LLMs) love