Skip to content

Gravirei/reis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

433 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

REIS

Roadmap Execution & Implementation System

Systematic development with parallel subagent execution for Atlassian Rovo Dev

npm version License: MIT

What is REIS? β€’ Installation β€’ Quick Start β€’ Commands β€’ Documentation

REIS Demo

What is REIS?

REIS (Roadmap Execution & Implementation System) is a systematic development framework for building better software with AI. Designed for Atlassian Rovo Dev, REIS provides structured workflows, specialized subagents, and comprehensive documentation to take projects from idea to deployment.

✨ What's New in v2.5

REIS v2.5 introduces parallel wave execution for significantly faster phase completion:

  • πŸš€ Parallel Waves - Execute independent waves concurrently (up to 4x speedup)
  • πŸ”— Dependency Graphs - Define and visualize wave dependencies
  • πŸ” Conflict Detection - Automatic file conflict detection and resolution
  • πŸ“Š Enhanced Kanban - Real-time parallel execution progress tracking

Previous in v2.0

  • 🌊 Wave Execution - Sequential waves with automatic checkpoints between phases
  • πŸ’Ύ Smart Resume - Resume from any checkpoint with deviation detection
  • βš™οΈ Config System - Customize wave sizes, git behavior, and templates via reis.config.js
  • πŸ“Š Metrics Tracking - Track success rates, durations, and deviations automatically
  • πŸ“ˆ Visualization - ASCII charts for progress, roadmap, and metrics
  • βœ… Plan Validation - Catch issues before execution with comprehensive validation

Why REIS?

  • πŸ“‹ Structured Workflow - Clear phases from requirements to deployment
  • πŸ€– 3 Specialized Subagents - Planner, Executor, and Project Mapper working in parallel
  • πŸ”„ Parallel Execution - Run up to 4 subagents simultaneously
  • πŸ’Ύ No Context Rot - Fresh 200k context per task
  • ⚑ Atomic Commits - One commit per task with automatic tracking
  • πŸ› οΈ Auto-Fix - Automatic bug detection and gap filling
  • πŸ“š Always-Loaded Context - Structured documentation in ~/.rovodev/

Inspired by Get Shit Done and enhanced for Rovo Dev.

Installation

npx @gravirei/reis

Or install globally:

npm install -g @gravirei/reis

On first run, REIS installs to ~/.rovodev/reis/ and sets up subagents for Rovo Dev.

Quick Start

Initialize a new project

reis new "build a todo app with React and Node.js"

This creates:

  • PROJECT.md - Your project vision
  • REQUIREMENTS.md - Detailed requirements
  • ROADMAP.md - Phase-based roadmap
  • STATE.md - Progress tracking

Configure your project (v2.0)

# Initialize configuration file
reis config init

# View current configuration
reis config show

Map an existing codebase

reis map

Analyzes your project and generates REIS structure.

Execute your roadmap

# Traditional workflow
reis plan          # Plan next phase
reis execute       # Execute the plan
reis verify        # Verify completion
reis progress      # Track progress

# v2.0 Wave-based workflow
reis execute-plan  # Execute with automatic waves and checkpoints
reis checkpoint "Feature complete"  # Create manual checkpoint
reis resume        # Resume from last checkpoint
reis visualize --type progress      # Visualize progress

Commands

REIS provides comprehensive commands organized into categories. See COMPLETE_COMMANDS.md for full details.

Getting Started

reis new [idea]         # Initialize new REIS project
reis map                # Map existing codebase
reis help               # Show all commands
reis version            # Show current version

Configuration (v2.0)

reis config init        # Create reis.config.js
reis config show        # Show current config
reis config validate    # Validate config file

Requirements & Planning

reis requirements       # Work on requirements
reis roadmap            # Work on roadmap
reis assumptions        # Document assumptions

Phase Execution

reis plan               # Create phase plan
reis discuss            # Discuss phase approach
reis research           # Research requirements
reis review             # Review plan before execution
reis execute            # Execute current phase
reis execute-plan [f]   # Execute with wave-based flow (v2.0)
reis verify             # Verify completion

Plan Review

Review plans against your codebase before execution to catch issues early:

# Review all plans
reis review

# Review specific plan
reis review .planning/phases/feature/PLAN.md

# Review with auto-fix
reis review --auto-fix

# Review with strict mode
reis review --strict

What Gets Checked:

  • File existence in codebase
  • Functions already implemented
  • Exports already in place
  • Dependencies available
  • Path correctness

Status Codes:

Status Icon Meaning
ok βœ… Ready for execution
already_complete βœ… Already implemented
path_error ⚠️ Path incorrect
missing_dependency ❌ Dependency missing

Learn more: Plan Review Guide

Verification

Verify that executed plans meet all success criteria and feature completeness requirements.

# Verify a phase
reis verify 2
reis verify phase-2
reis verify core-implementation

# Verify specific plan
reis verify path/to/plan.PLAN.md

# Options
reis verify 2 --verbose      # Detailed output
reis verify 2 --strict       # Fail on warnings

What Gets Verified:

  1. Feature Completeness (FR4.1) - Critical

    • Verifies ALL planned tasks are implemented
    • Checks files, functions, classes, endpoints exist
    • Reports missing deliverables with evidence
    • Requires 100% task completion to pass
  2. Test Results

    • Runs npm test
    • Reports pass/fail counts
    • Shows failing test details
  3. Success Criteria

    • Validates each criterion from PLAN.md
    • Documents evidence
    • Reports unmet criteria
  4. Code Quality

    • Syntax validation
    • Linting (if configured)
    • Quality scoring
  5. Documentation

    • Checks README.md, CHANGELOG.md
    • Reports completeness

Verification Report:

Generated at .planning/verification/{phase}/VERIFICATION_REPORT.md with:

  • Executive summary with overall status
  • Feature Completeness breakdown (task-by-task)
  • Test results and failures
  • Success criteria validation
  • Code quality metrics
  • Actionable recommendations

FR4.1: Why Feature Completeness Matters:

Tests passing β‰  features complete. Executors may skip tasks without errors.

FR4.1 catches this by:

  • Parsing all tasks from PLAN.md
  • Verifying each deliverable exists (files, functions, tests)
  • Calculating completion: 100% = PASS, <100% = FAIL

Example:

$ reis verify phase-2

πŸ” REIS Verifier
πŸ“„ Plan: .planning/phase-2/plan.PLAN.md

Verification Scope:
  Tasks: 3
  Success Criteria: 6

πŸ”„ Running verification...

❌ VERIFICATION FAILED

Issues found:
  - Feature Completeness: 66% (1 task incomplete)
  - Task 2: Build Password Reset - INCOMPLETE
    Missing: src/auth/password-reset.js, sendResetEmail()
  - 1 test failing (related to incomplete task)

Report: .planning/verification/phase-2/VERIFICATION_REPORT.md

Action Required: Complete all tasks before proceeding

After fixing:

$ reis verify phase-2

βœ… VERIFICATION PASSED

All checks passed:
  βœ… Feature Completeness: 100% (3/3 tasks)
  βœ… Tests: 18/18 passing
  βœ… Success Criteria: 6/6 met
  βœ… Code Quality: PASS

Ready to proceed to Phase 3

See also: docs/VERIFICATION.md for detailed verification guide.

Complete Cycle Automation

Run the entire workflow with a single command:

reis cycle 1

This automatically:

  1. Plans the phase (if needed)
  2. Executes the plan
  3. Verifies completion
  4. Debugs issues (if any)
  5. Applies fixes
  6. Re-verifies until passing

Features:

  • πŸ”„ Automatic debug/fix loop
  • πŸ’Ύ State persistence (survives interruptions)
  • ⏸️ Resume capability (reis cycle --resume)
  • 🎯 Smart attempt limiting (default: 3 attempts)
  • πŸ“Š Visual progress indicators

Example:

$ reis cycle 1

╔═══════════════════════════════════════════════════════════╗
β•‘  πŸ”„ REIS Complete Cycle - Phase 1                         β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

⏳ Step 1/4: Planning
   βœ“ Plan validated

βš™οΈ  Step 2/4: Executing
   βœ“ Plan executed (5 tasks)

βœ“ Step 3/4: Verifying
   ❌ Verification failed (80% complete)
   
   Issues found:
   - Missing: test/todo.test.js
   - Feature completeness: 4/5

πŸ” Step 4/4: Debugging
   βœ“ Debug report generated
   βœ“ Fix plan generated
   
   Apply fix? (Y/n): y
   βœ“ Fix applied

Re-verifying...
   βœ“ Verification passed (100% complete)

╔═══════════════════════════════════════════════════════════╗
β•‘  βœ… Cycle Complete!                                       β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

Duration: 12m 15s
Attempts: 2
Next: reis cycle 2

Options:

--max-attempts <n>    # Maximum debug/fix attempts (default: 3)
--auto-fix            # Apply fixes without confirmation
--resume              # Resume interrupted cycle
--continue-on-fail    # Continue even if verification fails
--skip-gates          # Skip quality gate checks
--gate-only <cat>     # Run only specific gate category
-v, --verbose         # Detailed output

Quality Gates in Cycle

Gates automatically run after verification to ensure code quality:

reis cycle 3              # Includes gates
reis cycle 3 --skip-gates # Without gates

The gate phase checks security, quality, and optionally performance/accessibility before marking a phase complete. Gate failures trigger the debug phase with [GATE:category] prefixed issues.

See Quality Gates for configuration.

Learn more: Complete Cycle Guide

Checkpoints & Resume (v2.0)

reis checkpoint [msg]   # Create checkpoint
reis checkpoint --list  # List all checkpoints
reis resume             # Smart resume from last checkpoint
reis resume --from [cp] # Resume from specific checkpoint

Decision Trees (v2.3.0)

Make structured decisions with interactive decision trees:

# View decision tree from file
reis tree show examples/decision-trees/basic-tree.md

# Interactive selection with arrow keys
reis tree show examples/decision-trees/real-world-auth.md --interactive

# Create from template
reis tree new auth  # Creates decision tree from auth template

# List available templates
reis tree list

# Export to different formats
reis tree export my-decision.md --format html
reis tree export my-decision.md --format svg
reis tree export my-decision.md --format mermaid

# Track decisions
reis decisions list           # View all decisions
reis decisions show abc123    # Show specific decision
reis decisions stats          # Decision statistics

Features:

  • πŸ“Š Interactive Selection: Navigate with arrow keys, see metadata
  • 🎯 Decision Tracking: Record and query all decisions with context
  • πŸ“€ Export Formats: HTML, SVG, Mermaid, JSON
  • πŸ“ Templates: 7 built-in templates (auth, database, testing, etc.)
  • πŸ”€ Conditional Branches: Context-aware recommendations
  • β™Ώ Accessibility: --no-color, --high-contrast, --ascii-only modes

Quick Example:

## Decision Tree: Choose Database

\`\`\`
What database should we use?
  β”œβ”€ PostgreSQL [recommended] β†’ Feature-rich, ACID compliant
  β”œβ”€ MongoDB β†’ Flexible schema, document store
  └─ SQLite β†’ Embedded, zero-config
\`\`\`

Learn more: Decision Trees Guide | Examples

Visualization (v2.0)

reis visualize --type progress  # Progress visualization
reis visualize --type roadmap   # Roadmap timeline
reis visualize --type metrics   # Metrics dashboard
reis visualize --watch          # Auto-refresh mode

Parallel Wave Execution (New in v2.5)

Execute independent waves concurrently for faster phase completion:

# Enable parallel execution
reis execute 3 --parallel

# Limit concurrent waves
reis execute 3 --parallel --max-concurrent 2

# Preview execution plan
reis execute 3 --parallel --dry-run --show-graph

# Visualize dependencies
reis visualize --dependencies

Define wave dependencies in PLAN.md:

## Wave 1: Setup
<!-- @dependencies: none -->
- Initialize project

## Wave 2: Backend
<!-- @dependencies: Wave 1 -->
- Create API endpoints

## Wave 3: Frontend
<!-- @dependencies: none -->
- Build UI components

## Wave 4: Integration
<!-- @dependencies: Wave 2, Wave 3 -->
- Connect frontend to backend

Features:

  • πŸš€ Dependency-based scheduling - Waves run as soon as dependencies complete
  • ⚑ Configurable concurrency - Control max parallel waves (1-10)
  • πŸ” Conflict detection - Detect file conflicts before execution
  • πŸ›‘οΈ Resolution strategies - fail, queue, branch, or merge conflicts
  • πŸ“Š Visual progress - Kanban board shows parallel execution
  • πŸ’Ύ State persistence - Resume interrupted parallel execution

Configuration (reis.config.js):

module.exports = {
  waves: {
    parallel: {
      enabled: true,
      maxConcurrent: 4,
      conflictStrategy: 'fail'  // 'fail' | 'queue' | 'branch' | 'merge'
    }
  }
};

Learn more: Parallel Execution Guide

Progress Management

reis progress           # Show progress
reis pause              # Pause work
reis todo               # Add todo
reis todos              # Show todos

Roadmap Management

reis add [phase]        # Add phase
reis insert [p] [after] # Insert phase
reis remove [phase]     # Remove phase

Milestones

reis milestone complete [name]  # Complete milestone
reis milestone discuss [name]   # Discuss milestone
reis milestone new [name]       # Create milestone

Utilities

reis debug              # Debug info
reis update             # Update REIS
reis docs               # Open docs
reis whats-new          # What's new
reis uninstall          # Uninstall

Subagents

REIS includes 5 specialized subagents for Rovo Dev:

🎯 reis_planner

Creates executable phase plans with task breakdown, dependency analysis, resource requirements, and success criteria.

⚑ reis_executor

Executes plans with atomic commits, deviation handling, checkpoints, state management, and auto-fix capabilities.

πŸ” reis_plan_reviewer

Reviews plans against your codebase before execution, detecting already-implemented features, path errors, missing dependencies, and potential conflicts.

βœ… reis_verifier

Verifies execution results against success criteria, runs test suites, validates code quality, detects missing features (FR4.1), and generates comprehensive verification reports.

πŸ—ΊοΈ reis_project_mapper

Maps codebases with architecture analysis, dependency mapping, tech stack identification, and REIS structure initialization.

Documentation

Core Documentation

v2.0 Documentation

After Installation

Full documentation is also available at ~/.rovodev/reis/

Access from CLI:

reis docs

Example Workflow

# Start a new project
reis new "build an AI chatbot"

# Refine requirements
reis requirements

# Create roadmap
reis roadmap

# Execute phases
reis plan && reis execute && reis verify

# Track progress
reis progress

# Continue to next phase
reis plan && reis execute

Tech Stack

  • Node.js
  • Chalk (terminal styling)
  • Inquirer (interactive prompts)
  • Rovo Dev (AI development)

Credits

Inspired by Get Shit Done by TΓ‚CHES.

Adapted and enhanced for Atlassian Rovo Dev with parallel subagent execution.

License

MIT - see LICENSE file.

Links


Made with ❀️ for systematic development

About

REIS - Roadmap Execution & Implementation System for Rovo Dev

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages