requirements-framework-status
This skill should be used when the user asks to "requirements framework status", "show requirements project context", "what's the state of requirements framework", "requirements framework overview", or wants a comprehensive status report of the requirements framework implementation and current state.
SKILL.md
| Name | requirements-framework-status |
| Description | This skill should be used when the user asks to "requirements framework status", "show requirements project context", "what's the state of requirements framework", "requirements framework overview", or wants a comprehensive status report of the requirements framework implementation and current state. |
name: requirements-framework-status description: This skill should be used when the user asks to "requirements framework status", "show requirements project context", "what's the state of requirements framework", "requirements framework overview", or wants a comprehensive status report of the requirements framework implementation and current state. git_hash: 7953a43
Requirements Framework - Status Report
Provides comprehensive project context and current state of the Claude Code Requirements Framework.
Current Implementation Status
Version: 2.5.0 Status: ✅ Production Ready & Feature Complete Repository: https://github.com/HarmAalbers/claude-requirements-framework
Quick Metrics
| Metric | Value |
|---|---|
| Production Code | ~8,500 lines |
| Test Suite | 1079 tests (100% pass) |
| Hooks | 15 active |
| Library Modules | 32 |
| CLI Commands | 11 |
| Requirement Types | 3 strategies |
| Plugin Agents | 19 |
| Plugin Commands | 11 |
| Plugin Skills | 19 |
→ Full component inventory: See references/component-inventory.md
Implementation Timeline
Phase 1: MVP ✅ (2025-12-09)
- Core framework structure
- Session management
- State storage (
.git/requirements/) - Configuration cascade
- PreToolUse hook
- CLI tool (
reqcommand)
Phase 2: Additional Requirements ⏭️
- Skipped - Not needed for current use cases
Phase 3: Polish & UX ✅ (2025-12-24)
- Session registry & auto-detection (77 tests)
- Enhanced error messages
- Terminal colors (NO_COLOR support)
req initinteractive wizard (42 tests)req configmanagement (14 tests)
Core Components
Hooks (15 total)
| Hook | Type | Purpose |
|---|---|---|
check-requirements.py | PreToolUse | Blocks Edit/Write if unsatisfied |
handle-session-start.py | SessionStart | Context injection, status display |
handle-prompt-submit.py | UserPromptSubmit | Prompt context injection |
handle-permission-request.py | PermissionRequest | Auto-deny dangerous commands |
handle-plan-exit.py | PostToolUse | Show status after planning |
auto-satisfy-skills.py | PostToolUse | Auto-satisfy on skill completion |
clear-single-use.py | PostToolUse | Clear single_use after action |
handle-tool-failure.py | PostToolUseFailure | Failure pattern tracking |
handle-subagent-start.py | SubagentStart | Review agent context injection |
handle-pre-compact.py | PreCompact | Pre-compaction state saving |
handle-stop.py | Stop | Verify requirements before stopping |
handle-session-end.py | SessionEnd | Cleanup sessions |
handle-teammate-idle.py | TeammateIdle | Team progress tracking |
handle-task-completed.py | TaskCompleted | Team task quality gates |
ruff_check.py | PreToolUse | Python linting |
Libraries (32 modules)
Core: requirements.py, config.py, state_storage.py, session.py, registry_client.py
Strategies: strategy_registry.py, base_strategy.py, blocking_strategy.py, dynamic_strategy.py, guard_strategy.py, strategy_utils.py
Utilities: branch_size_calculator.py, calculation_cache.py, calculator_interface.py, message_dedup_cache.py, git_utils.py, config_utils.py, colors.py, logger.py, feature_selector.py, init_presets.py, interactive.py
Session Learning: session_metrics.py, learning_updates.py
Messages: messages.py, message_validator.py
CLI Commands (11)
status, satisfy, clear, init, config, doctor, verify, sessions, list, prune, logging
Architecture Overview
Configuration Cascade
Global (~/.claude/requirements.yaml)
↓ (merge if inherit=true)
Project (.claude/requirements.yaml)
↓ (always merge)
Local (.claude/requirements.local.yaml)
Requirement Strategies
| Type | Satisfaction | Use Case |
|---|---|---|
| Blocking | Manual (req satisfy) | Planning, review |
| Dynamic | Auto-calculated | Branch size limits |
| Guard | Condition check | Protected branches |
Session Lifecycle
SessionStart → UserPromptSubmit → PreToolUse → PermissionRequest →
PostToolUse → PostToolUseFailure → SubagentStart → PreCompact →
Stop → SessionEnd → TeammateIdle → TaskCompleted
→ Full architecture details: See references/architecture-overview.md
Advanced Features
| Feature | Status | Description |
|---|---|---|
| Auto-Satisfaction | ✅ | Skills auto-satisfy requirements |
| Single-Use Scope | ✅ | Clears after each action |
| Message Dedup | ✅ | 5-min TTL, 90% spam reduction |
| Stop Verification | ✅ | Blocks stop if unsatisfied |
| Branch Guards | ✅ | Protected branch enforcement |
| Branch Size Calc | ✅ | Dynamic with 30-sec cache |
| Interactive Init | ✅ | 5 context-aware presets |
| Config Management | ✅ | req config without YAML editing |
Plugin Components
Agents (19)
Workflow: adr-guardian, codex-review-agent, codex-arch-reviewer, commit-planner, solid-reviewer, tdd-validator
Review: code-reviewer, silent-failure-hunter, test-analyzer, type-design-analyzer, comment-analyzer, code-simplifier, tool-validator, backward-compatibility-checker, frontend-reviewer, refactor-advisor
Utility: comment-cleaner, import-organizer, session-analyzer
Commands (11)
/requirements-framework:arch-review- Team-based architecture review (recommended for planning)/requirements-framework:deep-review- Cross-validated team review (recommended for PR)/requirements-framework:pre-commit- Quick pre-commit review/requirements-framework:quality-check- Lightweight PR review (alternative to /deep-review)/requirements-framework:plan-review- Lightweight plan review (alternative to /arch-review)/requirements-framework:codex-review- Codex-powered review/requirements-framework:commit-checks- Auto-fix code quality issues/requirements-framework:session-reflect- Session analysis and improvements/requirements-framework:brainstorm- Design-first development/requirements-framework:write-plan- Create implementation plan/requirements-framework:execute-plan- Execute plan with checkpoints
Skills (19)
Framework Skills (5):
requirements-framework-usage- Usage helprequirements-framework-status- This skillrequirements-framework-development- Dev workflowrequirements-framework-builder- Extension guidancesession-learning- Session analysis and improvement
Process Skills (14):
using-requirements-framework- Bootstrap skill (session start injection)brainstorming- Design-first explorationwriting-plans- Implementation plan creationexecuting-plans- Plan execution with checkpointstest-driven-development- RED-GREEN-REFACTOR enforcementsystematic-debugging- Root-cause investigationverification-before-completion- Evidence-based completionsubagent-driven-development- Parallel task executionfinishing-a-development-branch- Branch completion optionsusing-git-worktrees- Isolated workspacesdispatching-parallel-agents- Concurrent problem solvingreceiving-code-review- Technical feedback evaluationrequesting-code-review- Review agent dispatchwriting-skills- TDD-for-documentation meta-skill
Architecture Decision Records
| ADR | Decision |
|---|---|
| ADR-001 | Remove main/master branch skip |
| ADR-002 | Use Claude Code's native session_id |
| ADR-003 | Dynamic sync file discovery |
| ADR-004 | Guard requirement strategy |
| ADR-005 | Per-project init command |
| ADR-006 | Plugin-based architecture |
| ADR-007 | Deterministic command orchestrators |
| ADR-008 | CLAUDE.md weekly maintenance |
| ADR-009 | Agent auto-fix plan validation |
| ADR-010 | Cross-project feature upgrade |
| ADR-011 | Externalize messages to YAML |
| ADR-012 | Agent Teams integration |
| ADR-013 | Standardized agent output format |
Production Readiness
- ✅ 1079 tests, 100% pass rate
- ✅ TDD methodology throughout
- ✅ Fail-open design (errors don't block)
- ✅ Session management & cleanup
- ✅ Interactive setup wizard
- ✅ Comprehensive diagnostics (
req doctor) - ✅ Zero external dependencies
- ✅ Color support (NO_COLOR compliant)
- ✅ Performance optimization (caching)
Usage Guide
For New Users
req init # Interactive setup
req status # Check status
req doctor # Verify installation
For Framework Developers
./sync.sh status # Check sync
./sync.sh deploy # Deploy changes
python3 ~/.claude/hooks/test_requirements.py # Run tests
For Team Leads
req init --preset strict # Team onboarding
req config # View settings
Resources
- Repository: https://github.com/HarmAalbers/claude-requirements-framework
- README:
/Users/harm/Tools/claude-requirements-framework/README.md - Development Guide:
DEVELOPMENT.md - Sync Tool:
./sync.sh - Tests:
hooks/test_requirements.py
Reference Files
references/component-inventory.md- Detailed component listing with line countsreferences/architecture-overview.md- Design patterns and architectural decisions