vibedraft-cli

v1.2.1

Published

2 months ago

VibeDraft CLI - Setup tool for VibeDraft spec-driven development projects

0High
0Medium
0Low

mantisware

cli spec-driven development ai-assistant

🎯 What's the Vibe?

Stop coding, start vibing! 🎮

VibeDraft flips traditional development on its head. Instead of jumping straight into code, you:

Draft your vision 💭 - What do you want to build?
Plan the tech 🗺️ - How will you build it?
Break it down 📋 - What are the steps?
Make it real 🚀 - Let AI help you implement!

Your specifications become executable - they don't just guide development, they drive it. No more drift between docs and code. No more "but the spec says..." Just pure, aligned, vibey development flow. 🌊

🚀 Quick Start

Install VibeDraft

Option 1: Global Install (Recommended)

npm install -g vibedraft-cli

Then vibe anywhere:

vibedraft init my-awesome-project
vibedraft check

Option 2: Quick Vibe (One-Time)

npx vibedraft-cli init my-awesome-project

The VibeDraft Workflow

Once installed, your AI coding assistant gets these powerful slash commands:

# 1. Set your project's vibe 📜
/vibedraft.constitution

# 2. Dream up your feature 💭
/vibedraft.draft "Build a chat app with real-time messaging"

# 3. (Optional) Clarify ambiguities 🤔
/vibedraft.clarify

# 4. Plan the tech stack 🗺️
/vibedraft.plan "Use WebSocket, React, and PostgreSQL"

# 5. (Optional) Validate quality ✅
/vibedraft.checklist

# 6. Break it into tasks 📋
/vibedraft.tasks

# 7. (Optional) Check consistency 🔍
/vibedraft.analyze

# 8. Make it happen! 🚀
/vibedraft.implement

Boom! From idea to implementation with clear, trackable steps. ✨

🎸 Features That Rock

🎨 Spec-Driven Development

Write specifications that AI can execute
Keep specs and code in perfect harmony
Track every feature from conception to completion

🤖 Multi-Agent Support

Works with your favorite AI coding assistants:

Claude Code (Anthropic)
Gemini CLI (Google)
GitHub Copilot (Microsoft)
Cursor (AI-first IDE)
Windsurf (IDE workflows)
Qwen Code (Alibaba)
Amazon Q Developer
And more!

🌍 Cross-Platform

Node.js for maximum compatibility
Bash scripts for Unix/Linux/macOS/Windows
Auto-detects your platform!

📋 Smart Templates

Pre-built templates for:

Feature specifications
Implementation plans
Task breakdowns
Quality checklists
Project constitutions

🔄 Git Integration

Automatic branch creation per feature
Sequential feature numbering
Clean commit history

🔍 Intelligent Technology Stack Detection ✨ NEW in v0.1.0

When initializing VibeDraft in an existing project, it automatically:

Scans your package.json for dependencies and configuration
Detects frameworks (React, Next.js, Vue, Angular, Express, NestJS, and 20+ more)
Identifies languages by file patterns (TypeScript, JavaScript, Python, Rust, Go, etc.)
Recognizes build tools (Vite, Webpack, Rollup, esbuild, Turborepo, Nx)
Determines project type (monorepo, web-app, fullstack, mobile, library, cli)
Discovers package manager (npm, yarn, pnpm)
Analyzes architectural patterns (JAMstack, microservices, TypeScript-first)
Auto-populates your project constitution with detected tech stack
Generates technology-specific principles and constraints
Pre-fills plan templates with known technical context

Before & After:

Before (v0.0.x):

$ vibedraft init . --here
🎨 Found files here already
Do you want to continue? (y/n)

After (v0.1.0):

$ vibedraft init . --here
🎨 Found files here already

🔍 Detected existing application:
   📦 Package: my-app v1.2.3
   🔧 Tech Stack:
      • React 18.2.0 (Frontend Framework)
      • TypeScript 5.0.4 (primary language)
      • Vite 4.3.9 (build tool)
      • Jest 29.5.0 (testing)
   📁 Project Type: Web Application (frontend)
   📂 Structure: src/, public/, tests/

✨ VibeDraft will populate your constitution with this tech stack
Do you want to continue? (y/n)

Benefits:

🚀 Zero Manual Setup - No need to manually document your tech stack
📋 Instant Context - AI understands your project from day one
🎯 Better Planning - Plans pre-filled with correct frameworks and tools
🔒 Consistent Constraints - Auto-generated principles match your stack
📚 Living Documentation - Constitution stays in sync with reality

🎯 Core Commands

CLI Commands

| Command | What It Does | Example | |---------|-------------|---------| | vibedraft init | 🎬 Bootstrap a new project | vibedraft init my-app --ai claude | | vibedraft init . | 🎬 Initialize in current directory | vibedraft init . --ai cursor | | vibedraft check | 🔍 Check your dev environment | vibedraft check |

Slash Commands (In Your AI Agent)

Essential Flow 🎯

| Command | Purpose | When to Use | |---------|---------|-------------| | /vibedraft.constitution | 📜 Set project principles | First thing - establish your project's DNA | | /vibedraft.draft | 💭 Create feature spec | When you have a new feature idea | | /vibedraft.clarify | 🤔 Ask clarifying questions | Before planning - nail down fuzzy details | | /vibedraft.plan | 🗺️ Generate tech plan | After drafting - decide how to build it | | /vibedraft.checklist | ✅ Generate quality checks | Anytime - validate requirements quality | | /vibedraft.tasks | 📋 Break into tasks | After planning - get actionable steps | | /vibedraft.analyze | 🔍 Check consistency | After tasks - verify everything aligns | | /vibedraft.implement | 🚀 Execute tasks | Ready to code - let's build! |

🧠 Context-Aware Drafting

VibeDraft is seriously smart about your project! When you run /vibedraft.draft, the AI automatically scans your entire project structure for documentation to understand your project better.

What Gets Scanned 🔍

✅ Root-level docs: README.md, ARCHITECTURE.md, CONTRIBUTING.md, DESIGN.md
✅ Feature specs: All specifications in .vibedraft/specs/ directory (or specs/ for legacy projects)
✅ Documentation folders: docs/, .github/, guides/, .vibedraft/docs/, etc.
✅ Nested markdown: ANY .md file anywhere in your project
❌ Excluded: node_modules/, .git/, build/, dist/, coverage directories

How It Works 🎯

Scan: Finds all markdown files in your project
Prioritize: Reads critical docs first (README, ARCHITECTURE)
Contextualize: Uses this knowledge to draft your feature
Align: Creates specs that fit your project's patterns and goals

Best Practices 📚

Organize Your Documentation:

project/
├── README.md              # 🌟 Project overview - always read
├── ARCHITECTURE.md        # 🏗️ System design - always read  
├── CONTRIBUTING.md        # 📝 Dev practices - always read
├── DESIGN.md              # 🎨 UI/UX patterns - always read
├── docs/
│   ├── api-guidelines.md  # 📡 API conventions
│   ├── database.md        # 💾 Data model
│   └── security.md        # 🔒 Security practices
├── .vibedraft/
│   ├── specs/
│   │   ├── 001-auth-system/spec.md    # 🔐 Existing features
│   │   └── 002-user-profile/spec.md   # 👤 Related features
│   └── docs/              # 📚 VibeDraft documentation
└── .github/
    └── workflows.md       # ⚙️ CI/CD info

Document Everything:

Project vision and goals
Architectural decisions
Existing features and patterns
Technical constraints
Domain terminology
Integration points

Example in Action 🚀

# You have these docs:
# - README.md (mentions React + TypeScript)
# - ARCHITECTURE.md (describes microservices)  
# - .vibedraft/specs/001-user-auth/spec.md (existing auth system)
# - docs/api-guidelines.md (REST conventions)

/vibedraft.draft "Add user notifications"

# AI automatically:
# ✓ Reads your README - understands it's a React/TS project
# ✓ Reviews ARCHITECTURE - knows to use microservices pattern
# ✓ Checks user-auth spec - reuses existing auth patterns
# ✓ Applies API guidelines - follows your REST conventions
# ✓ Creates a spec that perfectly fits your project! 🎸

The More You Document, The Smarter It Gets! 💡

VibeDraft learns from your project's documentation. Well-documented projects get:

🎯 More accurate specifications
🔄 Better alignment with existing features
⚡ Faster drafting (less clarification needed)
🤝 Consistent patterns and terminology

Pro Tip: Keep a docs/ folder with architecture decisions, guidelines, and patterns. VibeDraft will use it all! 🎸

🧠 Memory Bank System

VibeDraft includes a Memory Bank - a persistent knowledge system that helps AI assistants maintain context across sessions, memory resets, and team handoffs.

What is the Memory Bank? 💾

The Memory Bank is a structured set of documentation files that capture your project's essence in a way AI assistants can reliably reference. Think of it as your project's "memory" that persists even when AI sessions reset.

Core Files 📚

The Memory Bank consists of six interconnected files:

.cursor/rules/memory-bank/  (or .claude/, .github/, etc.)
├── projectbrief.md         # Foundation - what we're building
├── productContext.md       # Why - problems solved, users, value  
├── systemPatterns.md       # How - architecture, patterns, design
├── techContext.md          # What - technologies, setup, constraints
├── activeContext.md        # Now - current focus, recent changes
├── progress.md             # Status - what works, what's left
└── Notes/                  # Additional detailed documentation

File Hierarchy 🏗️

Files build upon each other:

projectbrief.md → Foundation document
productContext.md, systemPatterns.md, techContext.md → Different perspectives
activeContext.md → Combines all for current work
progress.md → Tracks implementation status

Automatic Creation ✨

Memory Bank is created automatically during vibedraft init:

# Full Memory Bank (all 6 files)
vibedraft init my-project --ai cursor

# Minimal Memory Bank (3 essential files)
vibedraft init my-project --ai cursor --minimal

Manual Management 🎛️

Create or update Memory Bank independently:

# Create for specific agent
vibedraft memory-bank --agent cursor

# Create for all detected agents
vibedraft memory-bank --all

# Create minimal version
vibedraft memory-bank --agent claude --minimal

# Update existing Memory Bank
vibedraft memory-bank --update --agent cursor

Minimal vs Full Mode 🎯

Minimal Mode (--minimal flag):

Best for: Small projects, prototypes, focused tools, solo developers
Files: projectbrief.md, techContext.md, activeContext.md
Use when: Minimal documentation overhead desired, scope is well-defined

Full Mode (default):

Best for: Large projects, teams, complex systems, long-term projects
Files: All 6 core files + Notes/ directory
Use when: Complex architecture, multiple stakeholders, project will evolve significantly

Intelligent Auto-Population 🤖

VibeDraft automatically populates Memory Bank with project data:

What gets auto-filled (100% certain):

✅ Project name (from directory)
✅ Technology stack (from detection)
✅ Core dependencies (from package.json)
✅ Build tools and setup requirements
✅ Current date and initialization status

What requires user input (clear placeholders):

📝 Project scope and deliverables
📝 Target users and use cases
📝 Success metrics and timeline
📝 Architectural details
📝 Business value and UX goals

Multi-Agent Support 🌐

Memory Bank works with all supported AI agents:

| Agent | Location | Format | Status | |-------|----------|--------|--------| | Cursor | .cursor/rules/memory-bank/ | MDC | ✅ Full Support | | Claude Code | .claude/memory-bank/ | Markdown | ✅ Full Support | | GitHub Copilot | .github/memory-bank/ | Markdown | ✅ Full Support | | Gemini CLI | .gemini/memory-bank/ | Markdown | ✅ Full Support | | Windsurf | .windsurf/memory-bank/ | Markdown | ✅ Full Support | | Qwen Code | .qwen/memory-bank/ | Markdown | ✅ Full Support | | opencode | .opencode/memory-bank/ | Markdown | ✅ Full Support | | Amazon Q | .amazonq/memory-bank/ | Markdown | ✅ Full Support | | Codex | .codex/memory-bank/ | Markdown | ✅ Full Support | | Kilocode | .kilocode/memory-bank/ | Markdown | ✅ Full Support | | Auggie | .augment/memory-bank/ | Markdown | ✅ Full Support | | Roo | .roo/memory-bank/ | Markdown | ✅ Full Support |

Usage in AI Sessions 💬

Within your AI assistant, use the /vibedraft.memory-bank slash command to:

Create Memory Bank for your agent
Update Memory Bank with recent changes
Review and fill in placeholders
Maintain consistency across files

Example workflow:

User: "update memory bank"

AI: Reviewing all Memory Bank files...
    ✓ activeContext.md - Updated with recent authentication work
    ✓ progress.md - Marked user registration as complete
    ✓ techContext.md - Added JWT and bcrypt dependencies
    ✓ Other files - No changes needed
    
    Memory Bank updated successfully!

Benefits 🎁

🔄 Persistent Context - AI maintains understanding across sessions
👥 Team Onboarding - New members and AI agents get up to speed faster
📖 Consistent Documentation - Structured approach to project knowledge
🔀 Multi-Agent Flexibility - Use any AI assistant with same context
📈 Incremental Adoption - Start minimal, expand as complexity grows
🎯 Reduced Repetition - Stop re-explaining project details to AI
⚡ Faster Development - AI has context without lengthy explanations

Best Practices 💡

Start Minimal, Expand Later
- Begin with --minimal for new projects
- Add full structure when complexity grows
Regular Updates
- Update activeContext.md frequently (weekly)
- Update progress.md after features complete
- Update others when major changes occur
Use Notes/ for Details
- Create feature-specific docs in Notes/
- Keep core files concise
- Link from core files to detailed notes
Respect File Boundaries
- Don't duplicate information across files
- Reference other files instead of repeating
- Keep each file focused on its purpose
Fill Placeholders Gradually
- Start with what you know
- Add details as project evolves
- Don't over-document too early

Example Session 🚀

# Initialize project with Memory Bank
$ vibedraft init my-app --ai cursor --here

🔍 Detected existing application:
   • React 18.2.0
   • TypeScript 5.3.0
   • Vite 5.0.0
   • 45 dependencies detected

✨ VibeDraft will populate your constitution with this tech stack
✓ Memory Bank created for cursor
  Location: .cursor/rules/memory-bank
  Files: 6 (full)

📚 Memory Bank created!
   Review and fill in placeholders in:
   .cursor/rules/memory-bank/

Learning More 📖

See templates/commands/vibedraft.memory-bank.md for detailed AI usage guide
Check individual Memory Bank files for inline documentation
Use /vibedraft.memory-bank command within your AI assistant

🛠️ Installation Options

Prerequisites

Node.js 18.0.0 or higher
npm or npx
Git (optional but recommended)
AI coding assistant of your choice

Install from npm (Recommended)

# Global install
npm install -g vibedraft-cli

# Or use with npx (no install needed)
npx vibedraft-cli init my-project

Verify Installation

vibedraft --version
vibedraft --help

Development Mode (Contributing)

# Clone the repository
git clone https://github.com/MantisWare/VibeDraft.git
cd VibeDraft

# Install dependencies
npm install

# Link for local development
npm link

# Use anywhere
vibedraft init test-project

🎨 Usage Examples

Example 1: Quick Start

# Initialize a new project with Claude
vibedraft init my-chat-app --ai claude

# In your AI agent
/vibedraft.draft Build a real-time chat app with rooms and DMs

/vibedraft.plan Use Socket.io for WebSocket, Express backend, React frontend

/vibedraft.tasks

/vibedraft.implement

Example 2: Quality-First Approach

# Start with a constitution
/vibedraft.constitution Create principles for security, performance, and accessibility

# Draft your feature
/vibedraft.draft User authentication with OAuth providers

# Clarify ambiguities
/vibedraft.clarify

# Plan with clarifications
/vibedraft.plan

# Analyze for consistency
/vibedraft.analyze

# Generate tasks
/vibedraft.tasks

# Create quality checklist
/vibedraft.checklist Create security checklist for auth

# Implement
/vibedraft.implement

Example 3: Current Directory Init

# Initialize in existing directory
cd my-existing-project
vibedraft init --here --ai cursor --script sh

🤖 Supported AI Agents

| Agent | Status | Format | Notes | |-------|--------|--------|-------| | Claude Code | ✅ Full | Markdown | Anthropic's CLI tool | | Gemini CLI | ✅ Full | TOML | Google's AI CLI | | GitHub Copilot | ✅ Full | Markdown | IDE-based (VS Code) | | Cursor | ✅ Full | Markdown | AI-first IDE | | Windsurf | ✅ Full | Markdown | Workflow-based IDE | | Qwen Code | ✅ Full | TOML | Alibaba's AI CLI | | Opencode | ✅ Full | Markdown | Open-source option | | Amazon Q | ✅ Full | Markdown | AWS Developer CLI |

VibeDraft auto-generates the right command format for your agent! 🎯

📁 Project Structure

After running vibedraft init, you'll get:

your-project/
├── .vibedraft/              # All VibeDraft files live here! ✨
│   ├── scripts/            # Automation scripts
│   │   └── bash/          # Unix/Linux/macOS/Windows scripts
│   ├── templates/         # Spec, plan, and task templates
│   │   ├── commands/      # Slash command definitions
│   │   ├── spec-template.md
│   │   ├── plan-template.md
│   │   └── tasks-template.md
│   ├── memory/
│   │   └── constitution.md  # Project principles
│   ├── specs/             # 🆕 Your feature specs (moved from root)
│   │   └── 001-your-feature/
│   │       ├── spec.md    # Feature specification
│   │       ├── plan.md    # Implementation plan
│   │       └── tasks.md   # Actionable tasks
│   ├── docs/              # 🆕 VibeDraft documentation
│   │   ├── VIBEDRAFT_README.md  # VibeDraft guide
│   │   └── spec-driven.md       # SDD methodology
│   └── .gitignore         # 🆕 VibeDraft-specific ignores
├── .gitignore             # Project-level ignores
├── README.md              # Your project README (created if doesn't exist)
└── [your AI agent config] # .claude/, .cursor/, etc. (stays in root)

🆕 v1.0.0 Structure Changes

All VibeDraft files now live in .vibedraft/ to prevent conflicts with your application:

✅ Specs moved: .vibedraft/specs/ (was specs/ in root)
✅ Docs organized: .vibedraft/docs/ (was root-level files)
✅ Backward compatible: Supports both old (specs/) and new (.vibedraft/specs/) locations
✅ Clean root: Only README, .gitignore, and agent configs in root

🎛️ Command Options

`vibedraft init`

vibedraft init [project-name] [options]

Arguments:

project-name - Name of your project (creates new directory)
. - Initialize in current directory
--here - Initialize in current directory (alternative syntax)

Options:

--ai <agent> - Choose AI agent: claude, gemini, copilot, cursor, qwen, opencode, windsurf, q
--ignore-agent-tools - Skip AI agent CLI tool checks
--no-git - Skip Git repository initialization
--force - Overwrite existing files without asking

Examples:

# Basic init
vibedraft init my-project

# With specific AI agent
vibedraft init my-project --ai claude

# Current directory
vibedraft init --here

# Force overwrite in current directory
vibedraft init . --force --ai cursor

`vibedraft check`

Check your development environment:

vibedraft check

Verifies:

Git installation
AI agent CLI tools (Claude, Gemini, Cursor, etc.)
Node.js version
Script permissions

🎨 The VibeDraft Philosophy

1. Specs Are Executable

Your specifications aren't just documentation - they're executable blueprints that AI can implement.

2. Constitution-Driven

Every project starts with a constitution defining principles, patterns, and practices. AI respects these throughout development.

3. Feature Isolation

Each feature gets its own:

Git branch
Spec directory
Implementation plan
Task list

4. AI-Augmented, Human-Guided

AI helps with the heavy lifting, but you stay in control with clear specifications and quality checks.

5. Quality Built-In

Checklists, analysis, and clarification steps ensure you build the right thing, the right way.

🌊 Development Workflow

┌─────────────────────────────────────────────────────────┐
│                   Start New Feature                      │
└────────────────────┬────────────────────────────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │  /vibedraft.constitution   │  Set principles
        │         (First time)        │
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │    /vibedraft.draft        │  What to build?
        │   (Feature description)     │
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │   /vibedraft.clarify       │  (Optional)
        │  Ask clarifying questions   │  Remove ambiguity
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │    /vibedraft.plan         │  How to build?
        │   (Technical approach)      │
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │   /vibedraft.analyze       │  (Optional)
        │  Check consistency          │  Verify alignment
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │    /vibedraft.tasks        │  Break it down
        │  (Actionable steps)         │
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │  /vibedraft.checklist      │  (Optional)
        │  Generate quality checks    │  Validate quality
        └────────────┬───────────────┘
                     │
                     ▼
        ┌────────────────────────────┐
        │  /vibedraft.implement      │  Make it real!
        │    (Build the feature)      │
        └────────────┬───────────────┘
                     │
                     ▼
                  ✨ Done! ✨

🎓 Learn More

Documentation

Quick Start Guide - Get up and running fast
Installation Guide - Detailed setup instructions
Spec-Driven Development - Deep dive into the methodology
Agent Support Guide - Adding new AI agents
Local Development - Contributing to VibeDraft

Examples

Check out the templates/ directory for example specs, plans, and task lists!

🔧 Scripts Reference

VibeDraft includes automation scripts in both Node.js and Bash:

Node.js Scripts

check-prerequisites.js - Validate project setup
create-new-feature.js - Initialize new feature structure
setup-plan.js - Set up implementation plan
update-agent-context.js - Refresh AI agent context

Bash Scripts

check-prerequisites.sh - Validate project setup
create-new-feature.sh - Initialize new feature structure
setup-plan.sh - Set up implementation plan
update-agent-context.sh - Refresh AI agent context

Scripts are cross-platform compatible and work on Unix/Linux/macOS/Windows!

🧪 Testing

VibeDraft includes a comprehensive test suite covering all CLI functionality.

Run Tests

# Run all tests
npm test

# Run with verbose output
npm run test:verbose

# Run with coverage (Node 20+)
node --test --experimental-test-coverage test/cli.test.js

Test Coverage

The test suite includes 46 test cases covering:

✅ CLI help and version commands
✅ vibedraft check - Environment validation
✅ vibedraft init - Project initialization
- All AI agent integrations (8 agents)
- Git repository management
- File structure validation
- Error handling
✅ Edge cases and error scenarios
✅ Integration tests

See test/README.md for detailed test documentation.

Test Results

✅ 25+ passing tests
📊 60+ test cases total
🎯 All CLI commands covered

🔨 Development

Build Scripts

# Install dependencies
npm install

# Run tests
npm test

# Run tests with verbose output
npm run test:verbose

# Run tests with coverage
npm run test:coverage

# Lint code (autofix enabled)
npm run lint

# Lint without fixing
npm run lint:check

# Clean build artifacts
npm run clean

Local Development

To work on VibeDraft locally:

Clone the repository
Install dependencies: npm install
Link locally: npm link
Lint and fix code: npm run lint
Test your changes: npm test
Run the CLI: vibedraft --help

See docs/local-development.md for detailed development instructions.

Code Quality

VibeDraft uses ESLint for code quality and consistency:

Automatic Fixing: npm run lint automatically fixes most issues
Check Only: npm run lint:check reports issues without fixing
Modern Config: Uses ESLint 9+ flat config format
Pre-publish: Linting runs automatically before publishing

ESLint Rules

ES6+ modern JavaScript
Consistent code style (semicolons, quotes, spacing)
No unused variables (prefix with _ for intentionally unused)
Enforces best practices and error prevention
Custom configuration in eslint.config.js

Publishing & Versioning

VibeDraft includes automated release scripts with version bumping:

Quick Release (Patch)

# Bump patch version (1.0.0 → 1.0.1), test, commit, tag, and publish
npm run release

Version Bump Types

# Patch release (bug fixes): 1.0.0 → 1.0.1
npm run release:patch

# Minor release (new features): 1.0.0 → 1.1.0
npm run release:minor

# Major release (breaking changes): 1.0.0 → 2.0.0
npm run release:major

Manual Publishing

# Just publish (without version bump)
npm run publish:npm

What Happens During Release

Pre-version checks: Runs linting and tests
Version bump: Increments version in package.json
Auto-fix: Runs linter with autofix
Git commit: Commits version bump with message "Release vX.X.X"
Git tag: Creates a git tag for the version
Git push: Pushes commits and tags to remote
Publish: Publishes to npm registry

Version Script Hooks

preversion: Runs lint and tests before versioning
version: Runs lint with autofix and stages changes
postversion: Pushes commits and tags to git
prepublishOnly: Final lint and test check before publish

🌟 Why VibeDraft?

✅ For Developers

Clear, trackable development process
AI assistance without losing control
Better specs = better code
Git integration out of the box

✅ For Teams

Consistent project structure
Constitutional principles everyone follows
Easy onboarding with clear workflows
Quality built into the process

✅ For AI Agents

Structured context and workflows
Clear templates to follow
Consistent command patterns
Constitutional guidance for decisions

🤝 Contributing

Want to make VibeDraft even more vibey? We'd love your help!

Fork the repo
Create a feature branch - Use VibeDraft to spec it! 😉
Make your changes - Keep the vibes flowing
Test thoroughly - Make sure it rocks
Submit a PR - Share the love!

Check out our contributing guidelines for more details.

📝 Environment Variables

| Variable | Description | Example | |----------|-------------|---------| | VIBEDRAFT_FEATURE | Override feature detection (for non-Git repos) | 001-chat-feature | | GH_TOKEN / GITHUB_TOKEN | GitHub token for downloading releases | ghp_xxx... |

🎤 Support

Issues: Found a bug? Open an issue
Discussions: Questions? Start a discussion
Docs: Check the docs folder

📜 License

MIT License - See LICENSE for details

🎸 Keep the Vibes Flowing!

🚀 Quick Command Reference

# CLI Commands
vibedraft init <project>      # Start a new project
vibedraft init .              # Init in current directory
vibedraft check               # Check your environment

# Slash Commands (In Your AI Agent)
/vibedraft.constitution       # Set project principles
/vibedraft.draft             # Draft a feature
/vibedraft.clarify           # Ask clarifying questions
/vibedraft.plan              # Create implementation plan
/vibedraft.analyze           # Check consistency
/vibedraft.tasks             # Generate task list
/vibedraft.checklist         # Create quality checklist
/vibedraft.implement         # Execute implementation

Now go build something amazing! 🚀✨