Skip to content

hx2ryu/zachflow

Repository files navigation

zachflow

Harness-driven sprint orchestration for AI coding agents.

License: MIT Version npm

zachflow is a workflow harness that brings explicit phase gates, file-based handoff, and contract-first development to long-running coding sessions on Claude Code's Agent Teams. It implements the Planner–Generator–Evaluator pattern with cross-session knowledge accumulation.

Quick start

npx create-zachflow my-project

That's it. create-zachflow clones zachflow at the matching tag (create-zachflow@X.Y.ZvX.Y.Z, currently v1.7.0), strips dev artifacts, re-inits git, and then auto-runs the interactive wizard when stdin is a TTY. End-to-end setup takes ~5 minutes. After it completes, open the project in Claude Code and run /sprint <run-id>.

To pin a specific zachflow tag, pass --tag=vX.Y.Z (defaults to the matching CLI version). To track main, pass --branch=main.

Want to try it without wiring up your own codebase? After npx create-zachflow, run:

bash scripts/init-project.sh --demo

Synthesizes a throwaway Node.js source repo + role + KB so you can run /sprint demo-1 immediately. The wizard prints the cleanup path at the end.

For non-interactive setup (CI), skip the wizard with --no-init and feed a config file:

npx create-zachflow my-project --no-init
cd my-project
cp templates/init.config.template.yaml init.config.yaml
# Edit init.config.yaml
bash scripts/init-project.sh --from=init.config.yaml --non-interactive

The legacy GitHub Release tarball one-liner — npx https://github.com/hx2ryu/zachflow/releases/download/vX.Y.Z/create-zachflow-X.Y.Z.tgz my-project --tag=vX.Y.Z — still works as a backup install path.

Features

  • Two first-class workflows: /sprint (PRD → Spec → Prototype → Build → PR → Retro) and /qa-fix (Jira ticket triage and fix orchestration)
  • Build Loop primitive (Contract → Implement → Evaluate → Fix) shared across workflows
  • Embedded Knowledge Base (zachflow-kb:* skills) — learning memory plus optional OKF-compatible product/domain docs in .zachflow/kb/, no external repo required
  • Stack-agnostic teammate templates — placeholder-based BE/FE/Design/Evaluator role guides, filled by interactive wizard
  • Plugin system — optional, user-installable extensions (recall:ask, local OKF import/export)
  • Auto-indexed gallery — Astro shell that renders runs/sprint/<id>/prototypes/ outputs and product KB docs (packages/zachflow-gallery/)
  • Worktree-isolated sprints — each sprint runs in dedicated git worktrees, no cross-sprint contamination
  • Active Evaluation — independent Evaluator agent traces logic + probes edge cases (not just static checks)

Architecture

.claude/skills/         # Claude Code workflow + KB skill registration
workflows/              # platform-agnostic workflow content
  ├── sprint/           # 6-phase sprint pipeline
  ├── qa-fix/           # 5-stage QA fix pipeline
  └── _shared/          # Build Loop, agent dispatch, worktree, KB integration primitives
plugins/                # optional user-installable extensions
  ├── recall/           # interactive sprint/KB recall (reference plugin)
  └── okf/              # local OKF-compatible product KB import/export
packages/               # monorepo workspaces
  ├── zachflow-gallery/ # Astro auto-indexed prototype gallery
  └── create-zachflow/  # npm bootstrap wrapper
templates/              # init wizard templates + sprint artifact templates
schemas/                # JSON Schema for KB content (learning + products)
runs/                   # sprint instance directories (sprint/, qa-fix/)
.zachflow/kb/           # embedded Knowledge Base (per-project)

See ARCHITECTURE.md for principles + Build Loop detail, MANUAL.md for operations, docs/ for KB system, plugin authoring, workflow authoring, and roadmap.

Status

v1.7.0 — runs on Claude Code Agent Teams. Adds the OKF-compatible Product KB layer: product/domain docs under .zachflow/kb/products/, product-aware workflow handoff, local OKF import/export, recall integration, and gallery pages for browsing product knowledge beside sprint prototypes. Builds on v1.6.0's model-generation calibration and v1.5.0's install/setup UX overhaul (one-command npx wizard, prerequisite preflight, --demo mode). Multi-LLM platform support is on the v1.x roadmap (see docs/llm-platform-coupling.md).

Track v1.x progress in docs/roadmap.md.

Contributing

See CONTRIBUTING.md for issue reporting, PR conventions, and coding standards.

License

MIT — see LICENSE.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors