A VS Code extension for managing AI-assisted development workflows with epic/spec/ticket tracking.
- Epic Management: Organize large initiatives into epics with phases and deliverables
- Spec Tracking: Create and manage technical specifications with YAML frontmatter
- Ticket System: Track implementation tasks with priorities and assignments
- Execution Handoffs: Manage agent handoffs between different AI assistants
- Verification Results: Track code analysis and verification outcomes
- Interactive Tutorials: Learn FlowGuard through guided walkthroughs
Comprehensive documentation is available in the docs directory. Here's an overview of what you'll find:
- Installation Guide - How to install and set up FlowGuard
- Creating Your First Epic - Step-by-step tutorial for your first epic
- Configuration - Configuring LLM providers, templates, and settings
- Quick Reference - Essential shortcuts and commands cheat sheet
Learn how to use FlowGuard's core features:
- Creating Epics
- Specifications and Tickets
- Agent Handoffs
- Verification Workflows
- Template Customization
- Codebase Exploration
Technical documentation for developers and advanced users:
- Configuration Reference
- Keyboard Shortcuts
- Command Reference
- API Reference
- File Formats
- Architecture
Extend FlowGuard with custom functionality:
Interactive learning experiences:
- First Epic Tutorial - Guided walkthrough for creating your first epic
- Verification Tutorial - Learn the verification workflow
Practical examples to get you started:
- Epic Templates
- Spec Templates
- Ticket Templates
- Plugin Examples
- Handoff Examples
- Verification Examples
- Troubleshooting Guide - Solutions to common issues
- FAQ - Frequently asked questions
- Testing Documentation - How to test and validate documentation
# Install dependencies
npm install
# Compile extension
npm run compile
# Watch mode for development
npm run watch
# Run tests
npm run testFor detailed development instructions including how to build, test, and debug locally without publishing to the marketplace, see the Development Guide.
See docs/plan/1-foundation:-vs-code-extension-scaffold-&-core-models.md for the full architecture documentation.
We welcome contributions! See our Contributing Guide for details on how to get started.
For details on the comprehensive documentation implementation, see our Implementation Summary.
MIT