Docs for factory v1.0.0

Write the task. Review the evidence.

A factory runs a pipeline of steps on a copy of your repo. You review the evidence and it delivers a local commit.

Terminal
$ kusaw new demo --repo app=<path>
# Landing figure. Example data; paths are placeholders.
# yaml-language-server: $schema=../../internal/schema/factory.v2.schema.json
version: 2
name: demo

repos:
  app:
    path: <path>
    base_branch: main

data_dir: .factory

limits:
  run_minutes: 30
  budget_usd_per_run: 5.00
  finally_budget_usd: 0.50

monitor:
  stuck_after_minutes: 30
  control_poll_seconds: 2

worker:
  max_parallel: 2

claude:
  command: claude
  extra_args: []

pricing: {}

steps:
  spec-check: { builtin: spec-check, timeout: 30s, retries: 0 }
  build: { builtin: build, timeout: 15m }
  review-standards: { builtin: review, args: ["--focus", "standards"], timeout: 5m, config: { fail_on: major } }
  review-spec: { builtin: review, args: ["--focus", "spec"], timeout: 5m, config: { fail_on: major } }
  verify: { builtin: verify, timeout: 5m, config: { per_command_timeout: 5m, feedback_tail_lines: 200 } }
  deliver: { builtin: deliver, timeout: 3m }
  retro: { builtin: retro, timeout: 5m }

intake:
  - spec-check

pipeline:
  - spec-check
  - loop:
      name: build-review
      max_iterations: 3
      no_progress: true
      steps:
        - build
        - parallel:
            name: review
            fail_fast: false
            steps:
              - review-standards
              - review-spec
        - verify
  - gate: { name: human-check, prompt: "Look at the diff before deliver" }
  - deliver

finally:
  - retro

telemetry:
  enabled: false

Run · demo

Print hello, world

Waiting for you

  1. spec-checkPassed
  2. buildPassed
  3. review-standardsPassed
  4. review-specPassed
  5. verifyPassed
  6. human-checkWaiting for you
  7. deliverQueued
  8. retroQueued
The pipeline you write, and the run it produces. Example data.
  1. 01

    Getting started

    Install, run a factory, and see what a finished run looks like.

  2. 02

    Concepts

    Task, step, pipeline, run, gates, evidence, and delivery.

  3. 03

    Guides

    Write a task, review a run, use the Dashboard, and steer work.

  4. 04

    Custom steps

    Replace a built-in or add a program of your own.

  5. 05

    Reference

    CLI, kusaw.yaml keys, the step protocol, and statuses.

  6. 06

    Safety and data

    What stays on your machine, what a step can reach, and what needs you.

  7. 07

    Troubleshooting and FAQ

    Match the message the factory printed, then fix it.