Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gump.build/docs/llms.txt

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

​
Playbook

Gump ships with built-in workflows for common engineering patterns. Each one is a complete YAML file — run it as-is or fork and customize. 
# List available workflows
gump playbook list

# Run one
gump run cheap2sota --spec spec.md

​
Workflows

Built-in. Available as positional arg to gump run. Ready to run.

Freeform

Single agent, no plan. Quick experiments.

Cheap2Sota

Start cheap. Escalate only on failure.

TDD

Test-first, implement, verify.

Implement Spec

Decompose, implement, adversarial review, converge.

Parallel Tasks

Decompose. Build all tasks at once.

Bugfix

Reproduce first, then fix.

Refactor

Change the structure, keep the behavior.

​
Patterns

Copy-and-adapt. Requires a project-specific gate. Shows what’s possible.

Test Backfill

Add tests to existing untested code.

Security Fix

Audit vulnerabilities, then patch each one.

Docgen

Generate missing documentation from code.

Migration

Database, API, or dependency migrations in atomic steps.

Spike

Technical exploration. Analysis, not code.

​
Quick tips

Use --dry-run to see the execution plan without launching any agent:
gump run tdd --spec spec.md --dry-run
If a run crashes or you want to tweak something mid-flight:
# Resume where you left off (preserves worktree and sessions)
gump run --resume

# Replay from a clean state at a specific step
gump run --replay --from-step impl
A sub-workflow can be called as a step, a gate validator, or inside GET:
# As a step
- name: setup
  workflow: workflows/setup-env
    project: "{spec.project}"

# As a gate validator
gate:
  - validate: validators/arch-review
      diff: "{diff}"
      agent: claude-opus
Add a context block to any step to feed extra information:
get:
  context:
    - file: "docs/architecture.md"
    - bash: "git log --oneline -10"