GuardKit¶
Plan Features. Build Faster.
Stop shipping broken code. GuardKit is built on Feature Plan Development (FPD) — a feature-first workflow where a single /feature-plan command generates a complete, consistent plan, subtask breakdown, and implementation workspace.
Key Features¶
- Feature Planning - Single
/feature-plancommand generates complete workspace with subtasks and implementation guide - Clarifying Questions - Targeted questions before assumptions, complexity-gated
- Architectural Review - SOLID, DRY, YAGNI evaluation before coding
- Test Enforcement - Automatic test fixing (up to 3 attempts), ensures 100% pass rate
- AI Agent Discovery - Automatic specialist matching via metadata (stack, phase, keywords)
- Quality Gates - Coverage thresholds (80% line, 75% branch), compilation checks, code review
- Parallel Development - Built-in wave detection + Conductor.build integration
Quick Start¶
New to GuardKit? Start here:
- 5-Minute Quickstart - Get up and running fast
- GuardKit Workflow - Learn the core workflow
- Choose a Template - Select your tech stack
Documentation Sections¶
📚 Core Concepts¶
Learn the fundamentals: workflow, complexity evaluation, quality gates, and task states.
🚀 Advanced Topics¶
Design-first workflow, UX integration, iterative refinement, and plan modification.
🎨 Templates¶
React, Python, .NET templates and customization guide. See also Template System Architecture for how templates work internally.
🤖 Agent System¶
AI agent discovery, enhancement workflow, and boundary sections.
🔄 Task Review¶
Analysis and decision-making workflows separate from implementation.
🔌 MCP Integration (Optional)¶
Enhance with Model Context Protocol servers for library docs and design patterns.
🛠️ Troubleshooting¶
Common issues, solutions, and the /debug command.
Example Workflow¶
Feature Planning (Recommended)¶
# Install GuardKit
curl -sSL https://raw.githubusercontent.com/guardkit/guardkit/main/installer/scripts/install.sh | bash
# Initialize your project
cd /path/to/your/project
guardkit init react-typescript
# Plan a feature (single command!)
/feature-plan "add user authentication"
# System creates:
# ✅ Review task with technical options
# ✅ Subtask breakdown with parallel waves
# ✅ Implementation guide
# ✅ Feature workspace in tasks/backlog/
# Work through generated subtasks
/task-work TASK-AUTH-001
/task-complete TASK-AUTH-001
Simple Tasks (Direct)¶
# Create and work on a simple task (natural language description)
/task-create "The login button styling is broken on mobile devices"
/task-work TASK-a3f8 # Plans, reviews, implements, tests
/task-complete TASK-a3f8
Three commands from idea to production-ready code.
When to Use GuardKit¶
✅ Use GuardKit When¶
- Individual tasks or small features (1-8 hours)
- Solo dev or small teams (1-3 developers)
- Need quality enforcement without ceremony
- Want AI assistance with human oversight
- Small-to-medium projects
- Learning new stack (use reference templates)
- Creating team templates (use
/template-create)
🔗 Use RequireKit When¶
For formal requirements management (EARS notation, BDD with Gherkin, epic/feature hierarchy, PM tool sync), see RequireKit which integrates seamlessly with GuardKit.
Links¶
- GitHub Repository - Source code and contributions
- Report an Issue - Bug reports and feature requests
- RequireKit - Formal requirements management
Plan Features. Build Faster. Built for pragmatic developers who ship quality code.