
requirements-framework-status
by HarmAalbers
A powerful hook-based system for enforcing development workflow requirements in Claude Code. Ensures critical steps like commit planning, ADR review, and TDD are completed before code modifications.
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. 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.0.4 Status: ✅ Production Ready & Feature Complete Repository: https://github.com/HarmAalbers/claude-requirements-framework
Quick Metrics
| Metric | Value |
|---|---|
| Production Code | ~8,500 lines |
| Test Suite | 544 tests (100% pass) |
| Hooks | 9 active |
| Library Modules | 17 |
| CLI Commands | 11 |
| Requirement Types | 3 strategies |
| Plugin Agents | 17 |
| Plugin Commands | 5 |
| Plugin Skills | 4 |
→ 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 (9 total)
| Hook | Type | Purpose |
|---|---|---|
check-requirements.py | PreToolUse | Blocks Edit/Write if unsatisfied |
handle-session-start.py | SessionStart | Context injection, status display |
handle-stop.py | Stop | Verify requirements before stopping |
handle-session-end.py | SessionEnd | Cleanup sessions |
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 |
ruff_check.py | PreToolUse | Python linting |
Libraries (17 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
Utilities: branch_size_calculator.py, calculation_cache.py, message_dedup_cache.py, git_utils.py, colors.py, logger.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 → PreToolUse → PostToolUse → Stop → SessionEnd
→ 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 (10)
Workflow: adr-guardian, codex-review-agent
Review: code-reviewer, silent-failure-hunter, test-analyzer, type-design-analyzer, comment-analyzer, code-simplifier, tool-validator, backward-compatibility-checker
Commands (3)
/requirements-framework:pre-commit- Quick pre-commit review/requirements-framework:quality-check- Comprehensive PR review/requirements-framework:codex-review- Codex-powered review
Skills (4)
requirements-framework-usage- Usage helprequirements-framework-status- This skillrequirements-framework-development- Dev workflowrequirements-framework-builder- Extension guidance
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 |
Production Readiness
- ✅ 544 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
スコア
総合スコア
リポジトリの品質指標に基づく評価
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
レビュー
レビュー機能は近日公開予定です