Examples

July 4, 2026 ยท View on GitHub

After crewplane init, you have one mock-safe workflow at .crewplane/workflows/single-agent-review.task.md and additional examples under .crewplane/workflows/example-templates/.

Start with the mock-safe workflow. For the other examples, either change their provider names to match configured mock-safe agents or enable the real provider agents in .crewplane/config.yml and switch the invoker to cli.

Suggested Path

  1. Run single-agent-review.task.md first. It uses the generated mock agent and leaves result and findings files you can inspect immediately.
  2. Move to code-review-example.task.md after you have provider names that match your config.
  3. Use the implementation, refactoring, design-review, and test-generation examples when you are ready to run real provider CLIs.
  4. Use composition and workspace examples only after the basic workflow shape is familiar.

Once crewplane init has generated the workflow copies, these commands run the most common examples:

crewplane run --tasks .crewplane/workflows/single-agent-review.task.md
crewplane run --tasks .crewplane/workflows/example-templates/code-review-example.task.md
crewplane run --tasks .crewplane/workflows/example-templates/feature-implement-example.task.md

Only single-agent-review.task.md is generated at the top level. The other examples live under example-templates/, so they need an explicit --tasks path. Add --no-live only when you want a plain terminal run without the live dashboard.

The source-backed public examples are the packaged templates under src/crewplane/example_templates/.

Default Example

crewplane run --tasks .crewplane/workflows/single-agent-review.task.md

Workflow Library

crewplane run --tasks .crewplane/workflows/example-templates/code-review-example.task.md

Composition

See composition examples.

crewplane run --tasks .crewplane/workflows/example-templates/composition/review-fix-composed-example.task.md

Experimental Workspace

See Experimental workspace examples.

crewplane run --tasks .crewplane/workflows/example-templates/worktree/workspace-alternatives-example.task.md

Sample Inputs

Copy sample inputs into your own project or update generated workflow paths to point at your real project files.