AgentSkillsCN

requirements-framework-status

当用户询问“需求框架现状”、“展示需求项目上下文”、“需求框架目前处于何种状态”、“需求框架概览”，或希望获取需求框架实施情况与当前状态的全面报告时，应使用此技能。

SKILL.md
--- frontmatter
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

MetricValue
Production Code~8,500 lines
Test Suite544 tests (100% pass)
Hooks9 active
Library Modules17
CLI Commands11
Requirement Types3 strategies
Plugin Agents17
Plugin Commands5
Plugin Skills4

→ 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 (req command)

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 init interactive wizard (42 tests)
  • •req config management (14 tests)

Core Components

Hooks (9 total)

HookTypePurpose
check-requirements.pyPreToolUseBlocks Edit/Write if unsatisfied
handle-session-start.pySessionStartContext injection, status display
handle-stop.pyStopVerify requirements before stopping
handle-session-end.pySessionEndCleanup sessions
handle-plan-exit.pyPostToolUseShow status after planning
auto-satisfy-skills.pyPostToolUseAuto-satisfy on skill completion
clear-single-use.pyPostToolUseClear single_use after action
ruff_check.pyPreToolUsePython 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

code
Global (~/.claude/requirements.yaml)
    ↓ (merge if inherit=true)
Project (.claude/requirements.yaml)
    ↓ (always merge)
Local (.claude/requirements.local.yaml)

Requirement Strategies

TypeSatisfactionUse Case
BlockingManual (req satisfy)Planning, review
DynamicAuto-calculatedBranch size limits
GuardCondition checkProtected branches

Session Lifecycle

code
SessionStart → PreToolUse → PostToolUse → Stop → SessionEnd

→ Full architecture details: See references/architecture-overview.md

Advanced Features

FeatureStatusDescription
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 help
  • •requirements-framework-status - This skill
  • •requirements-framework-development - Dev workflow
  • •requirements-framework-builder - Extension guidance

Architecture Decision Records

ADRDecision
ADR-001Remove main/master branch skip
ADR-002Use Claude Code's native session_id
ADR-003Dynamic sync file discovery
ADR-004Guard requirement strategy
ADR-005Per-project init command
ADR-006Plugin-based architecture
ADR-007Deterministic command orchestrators
ADR-008CLAUDE.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

bash
req init              # Interactive setup
req status            # Check status
req doctor            # Verify installation

For Framework Developers

bash
./sync.sh status      # Check sync
./sync.sh deploy      # Deploy changes
python3 ~/.claude/hooks/test_requirements.py  # Run tests

For Team Leads

bash
req init --preset strict   # Team onboarding
req config                 # View settings

Resources

Reference Files

  • •references/component-inventory.md - Detailed component listing with line counts
  • •references/architecture-overview.md - Design patterns and architectural decisions