Skip to content

alextremp/claude-rumiator

Repository files navigation

Rumiator

Ask DeepWiki

Iterative project development system for Claude Code based on Rational Unified Process (RUP)

Rumiator helps you build software projects systematically by combining specialized AI agents with structured workflows.

Quick Start

# 1. Initialize your project
/rumiator-init

# 2. Create product vision
/rumiator-create-product

# 3. Generate tasks (with business requirements)
/rumiator-create-tasks

# 4. Analyze technical approach
/rumiator-analyze-tech all

# 5. Start developing
/rumiator-develop-next

# 6. Monitor progress
/rumiator-status

⚑ New: Business requirements now integrated into task creation - faster workflow! 🎨 New: Customize commands and agents to fit your workflow - without losing changes on updates! πŸš€ New: Automatic release system - updates use stable releases instead of master branch!

Features

  • βœ… Systematic workflow - From idea to implementation
  • βœ… Specialized agents - PM, Analyst, Architect, Developers, DevOps, QA
  • βœ… Comprehensive documentation - Auto-generated specs and ADRs
  • βœ… Iterative development - Small, manageable iterations
  • βœ… Progress tracking - Visual dashboards and reports
  • βœ… Decision transparency - All choices documented
  • βœ… Bug tracking & management - Track bugs alongside features
  • βœ… Architecture evolution - Review and update architectural decisions
  • βœ… Customizable workflows - Override commands and agents to match your team's needs
  • βœ… Automatic releases - GitHub Actions automatically creates releases when changelog is updated
  • βœ… Stable updates - /rumiator-update uses published releases instead of master branch
  • βœ… You're in control - Agents ask before important decisions

Architecture

Agents (Workers)

  • project-manager - Product vision and iteration planning
  • functional-analyst - Creates tasks with business requirements (summary, user stories, acceptance criteria)
  • architect - High-level technical guidance and architectural decisions (ADRs)
  • developer-frontend - Frontend implementation based on requirements and guidance
  • developer-backend - Backend implementation based on requirements and guidance
  • devops - CI/CD and infrastructure
  • quality-assurance - Testing and validation

Commands (Workflows)

Planning & Setup

Command Purpose
/rumiator-init Initialize project structure
/rumiator-create-product Create product plan from idea
/rumiator-update-plan Update product plan
/rumiator-create-tasks Generate tasks from plan

Analysis & Design

Command Purpose
/rumiator-analyze-business ⚠️ DEPRECATED - No longer needed
/rumiator-analyze-tech Create high-level technical guidance
/rumiator-adr Create architecture decision record

Development

Command Purpose
/rumiator-develop Implement a task (feature, bug, or review)
/rumiator-develop-next Auto-select and develop next task

Bug Management

Command Purpose
/rumiator-create-bug Create a bug report
/rumiator-triage-bugs Review and prioritize bugs

Architecture Management

Command Purpose
/rumiator-review-architecture Challenge and update architectural decisions
/rumiator-propagate-architecture-change Update tasks affected by architecture changes

Monitoring & Reporting

Command Purpose
/rumiator-status Show project dashboard (features, bugs, reviews)
/rumiator-report Generate iteration report
/rumiator-block-task Mark task as blocked

Rumiator Tool

Command Purpose
/rumiator-update Update to latest Rumiator version
/rumiator-add-customization Create agent or command customizations interactively

Project Structure

your-project/
β”œβ”€β”€ .rumiator/
β”‚   β”œβ”€β”€ config.yml              # Configuration
β”‚   └── templates/              # Document templates
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ product/                # Product plan, architecture
β”‚   β”œβ”€β”€ features/               # Technical specs (high-level guidance)
β”‚   β”‚   └── [feature]/
β”‚   β”‚       β”œβ”€β”€ technical.md    # ⚑ Simplified: architectural guidance only
β”‚   β”‚       └── bugs/           # Bug analysis documents
β”‚   β”œβ”€β”€ adr/                    # Architecture decisions
β”‚   β”‚   └── reviews/            # Architecture review documents
β”‚   └── iterations/             # Iteration reports & plans
β”‚       β”œβ”€β”€ iteration-01/       # Current iteration
β”‚       β”‚   β”œβ”€β”€ tasks/                  # Task definitions (features, bugs, reviews)
β”‚       β”‚   β”‚   β”œβ”€β”€ TASK-001.yml        # type: feature
β”‚       β”‚   β”‚   β”œβ”€β”€ TASK-015.yml        # type: bug
β”‚       β”‚   β”‚   └── TASK-040.yml        # type: architecture-review
β”‚       β”‚   β”œβ”€β”€ plan.md
β”‚       β”‚   β”œβ”€β”€ report.md
β”‚       β”‚   β”œβ”€β”€ bug-triage-report.md
β”‚       β”‚   └── architecture-change-*.md
β”‚       └── iteration-02/       # Future iterations
β”‚           └── ...
└── repositories/               # Source code

Example Workflow

# Initialize
/rumiator-init

# Describe your product
/rumiator-create-product
> "A task management app for remote teams..."

# Generate tasks for iteration 1 (includes business requirements)
/rumiator-create-tasks
# Created: TASK-001 (Auth), TASK-002 (Tasks CRUD), TASK-003 (Dashboard)
# Each task includes: summary, user stories, acceptance criteria

# Get technical guidance
/rumiator-analyze-tech all
# Agent asks: "Should I create an ADR for authentication approach?"
> "Yes, use JWT"
# Agent creates high-level technical guidance (no code/schemas)

# Develop tasks
/rumiator-develop-next
# Implements TASK-001 (backend + frontend + tests)
# Developer agents make implementation decisions

# Check progress
/rumiator-status
# Progress: β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–‘β–‘β–‘β–‘ 33% (1/3 tasks done)

# Continue development
/rumiator-develop-next
# Repeat until iteration complete

# Generate report
/rumiator-report
# Creates docs/iterations/iteration-01/report.md

⚑ Simplified: 2-phase workflow instead of 3 - faster and more efficient!

Key Principles

  1. Iterative - Deliver value in 2-4 week iterations
  2. Documented - Every decision is recorded
  3. Interactive - Agents ask when uncertain
  4. Transparent - Track progress visually
  5. Quality-focused - Specs, tests, reviews built-in

Documentation

πŸ“– Complete Guide - Comprehensive documentation

Topics covered:

  • Detailed workflow explanation
  • Agent responsibilities
  • Task lifecycle
  • Best practices
  • Customization guide
  • FAQ

Release Management

Rumiator uses an automated release system to ensure stable updates:

Automatic Releases

When a new version is documented in RUMIATOR_CHANGELOG.md, GitHub Actions automatically:

  1. βœ… Detects the new version (format: [X.Y.Z] - YYYY-MM-DD)
  2. βœ… Compares with the latest published release
  3. βœ… Ensures config.yml.template has matching rumiator_version
  4. βœ… Creates a GitHub Release with changelog summary and comparison link

Stable Updates

When you run /rumiator-update, it:

  • βœ… Uses the latest published release (not master branch)
  • βœ… Ensures you get tested, stable versions
  • βœ… Falls back to master only if releases are unavailable (with warning)

Benefits

  • Stability - Updates use verified releases
  • Traceability - Each release has clear changelog
  • Consistency - Version always matches between changelog and config
  • Automation - No manual release creation needed

Requirements

  • Claude Code (with agent and command support)
  • Git repository (recommended)

Version Management

Rumiator uses semantic versioning and supports automatic updates:

Checking Your Version

Your Rumiator version is stored in .rumiator/config.yml under rumiator_version

Updating Rumiator

/rumiator-update

This command will:

  1. Clone/update the official repository to repositories/claude-rumiator/
  2. Compare your version with the latest available
  3. Apply necessary migrations automatically
  4. Update your project structure and configuration

Version History

See RUMIATOR_CHANGELOG.md for detailed version history and migration instructions.

Manual Updates

If automatic update fails, you can:

  1. Check repositories/claude-rumiator/RUMIATOR_CHANGELOG.md for migration steps
  2. Manually update your .rumiator/ directory
  3. Update rumiator_version in your config.yml

For Maintainers: Creating a Release

Use the /rumiator-workflow-pr command to create a release:

/rumiator-workflow-pr

This command will:

  1. Analyze all changes since the last release
  2. Automatically detect new commands, templates, and config changes
  3. Generate migration actions based on detected changes
  4. Ask you a few questions (version type, summary, etc.)
  5. Update RUMIATOR_CHANGELOG.md and config.yml.template
  6. Commit changes and create a PR

Then:

  1. Review and merge the PR
  2. Create a git tag: git tag -a v1.x.x -m "Release v1.x.x" && git push origin v1.x.x
  3. Create a GitHub Release from the tag

Much easier than writing CHANGELOG manually! πŸŽ‰

Benefits

For Solo Developers

  • Structured approach to building projects
  • Comprehensive documentation without extra effort
  • Clear progress tracking
  • Reduces decision fatigue

For Teams

  • Shared understanding of requirements
  • Clear technical specifications
  • Documented architectural decisions
  • Easy onboarding for new members

For Learning

  • See how professional projects are structured
  • Learn RUP methodology in practice
  • Understand architecture decision-making
  • Study code organization patterns

Customization

All agents and workflows are customizable:

  • Edit .claude/agents/*.md to change agent behavior
  • Edit .claude/commands/*.md to modify workflows
  • Edit .rumiator/templates/*.md to adjust document structure

Tips

πŸ’‘ Run /rumiator-status frequently to track progress πŸ’‘ Review generated docs and refine them πŸ’‘ Let agents ask questions - it improves quality πŸ’‘ Keep iterations small (5-15 tasks) πŸ’‘ Commit after each completed task

What's Next?

After completing an iteration:

  1. Review with /rumiator-report
  2. Update plan if needed with /rumiator-update-plan
  3. Plan next iteration
  4. Repeat the cycle

Contributing

Improve Rumiator by:

  • Enhancing agent prompts
  • Adding new workflows
  • Creating new templates
  • Sharing your improvements

License

MIT - Use freely for any project


Get Started: Run /rumiator-init in your Claude Code session! πŸš€

For questions and detailed documentation, see RUMIATOR-GUIDE.md

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •