Skip to content

Workflow Configuration

Workflow templates are described with YAML. The editor uses YAML as the only data source, and stage preview, append, delete, reorder, and Agent selection all write back to the YAML string.

Basic Structure

yaml
name: Minimal implementation
description: Only includes the apply stage and implements changes from the proposal
version: 1
stages:
  - id: stage-proposal-apply
    name: Apply change
    type: proposal-apply
    agent: codex-acp
    prompt: Implement code changes according to the approved proposal tasks.
    when: Proposal is ready to apply
    onFailure: Stop later stages
    mcp: []
    skills: []

Top-Level Fields

FieldTypeDescription
namestringWorkflow name
descriptionstringWorkflow description
versionnumberTemplate version
stagesarrayStage list

Stage Fields

FieldTypeRequiredDescription
idstringNoUnique stage id. If omitted, ids such as stage-1 are generated by order.
namestringNoDisplay name. If omitted, id is used.
typestringNoStage type. Unknown types are treated as custom.
agentstringNoACP Agent id used by this stage.
promptstringNoStage execution instruction.
whenstringNoTrigger condition description.
onFailurestringNoFailure handling description.
mcpstring[]NoMCP capabilities required by the stage.
skillsstring[]NoSkills required by the stage.

Stage Types

TypeDescription
proposal-applyImplement code changes according to approved proposal tasks.
proposal-archiveSummarize execution results and archive the proposal.
code-reviewReview correctness, maintainability, and test coverage of the current change.
security-checkCheck dependencies, permissions, secrets, and potential security risks.
create-prPrepare change summary, verification results, risk notes, and create a PR.
customCustom stage.

Compatibility handling: old value apply is parsed as proposal-apply, and old value archive is parsed as proposal-archive.

Save Rules

  • Custom templates can be saved directly.
  • Saving a built-in template creates a custom copy.
  • Invalid YAML syntax blocks saving and shows a parse error.
  • Built-in templates do not show a delete entry.
  • Custom templates can be deleted from the detail page or sidebar.

Released under MIT