Crewplane Documentation

July 4, 2026 ยท View on GitHub

Crewplane turns coding-agent CLI calls into explicit, resumable workflows with local run records on disk.

Crewplane concept map showing how workflows, preflight, nodes, agents, invokers, artifact references, and run records fit together.

Start By Goal

GoalStart here
Understand what Crewplane isWhy Crewplane?
Try it safely without real agent callsInstallation, then Quickstart
Prepare a real providerQuickstart, then Provider setup
Follow the guided tutorial trackRunning workflows
Look up exact syntax and configWorkflow syntax, Configuration, Commands

First Project Path

For a first project, keep this order:

  1. Install Crewplane.
  2. Run crewplane init.
  3. Run crewplane validate.
  4. Run crewplane run with the generated mock invoker.
  5. Inspect the run record.
  6. Run crewplane onboarding when you are ready to prepare one real provider.

For details, follow the Getting Started pages in order before moving into the guide track:

  1. Why Crewplane?
  2. Installation
  3. Quickstart
  4. Provider setup
  5. Continue to Running workflows.

Guided Tutorial Track

These guides are written to be read in order. Each page ends with a Next section that continues the tour.

  1. Running workflows
  2. Watch Runs Live and Inspect Results
  3. Inspecting Run Records
  4. Workflow authoring
  5. Node modes and provider roles
  6. Review loops
  7. Findings artifacts
  8. Workflow composition
  9. Optional: Experimental workspace isolation can be omitted unless you need isolated source-tree edits.
  10. Mock validation
  11. Troubleshooting
  12. Reproducible support bundle
  13. Cleanup

Jump In By Task

Feel free to jump around based on what you need right now:

Examples

Reference