requirements-framework-usage

Configure, customize, and troubleshoot the Claude Code Requirements Framework and its req CLI.

1|Updated Dec 11, 2025
One-click install
npx skills add https://github.com/HarmAalbers/claude-requirements-framework --skill requirements-framework-usage-harmaalbers
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: requirements-framework-usage
Source: https://github.com/HarmAalbers/claude-requirements-framework/tree/main/plugins/requirements-framework/skills/requirements-framework-usage
Command: npx skills add https://github.com/HarmAalbers/claude-requirements-framework --skill requirements-framework-usage-harmaalbers

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Developers using the Claude Code Requirements Framework often struggle to configure workflow gates, customize requirement checklists, manage sessions, and debug hooks that fail to trigger. This Skill provides guided help for the entire framework, from the typed 7-node workflow (Design → Plan → Validate → Build → Review → Verify → Ship) to the req CLI and YAML configuration cascade. ## Core Features & Use Cases - Configuration Guidance: Set up global, project, and local requirements.yaml configs with scopes (session, branch, permanent, single_use), checklists, and Bash command triggers. - CLI Assistance: Explains req commands such as req status, req satisfy, req pause, req init, req config, and req doctor for inspecting and driving requirements. - Troubleshooting: Diagnoses hooks not triggering, sessions not found, plugin hook integrity issues, and configuration loading problems. - Use Case: A team wants code review enforced before every commit. The Skill shows how to define a single_use requirement with a git\s+commit Bash trigger pattern and map it to auto-satisfy via the /pre-commit skill. ## Quick Start Ask how to add a checklist to the plan_validated requirement or how to troubleshoot a hook that is not blocking edits.

Frequently Asked Questions about requirements-framework-usage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a checklist to a requirement in Claude Code?▼

Add a checklist key under the requirement in .claude/requirements.yaml with 5-10 concise, actionable items. For example, list steps like plan reviewed by /arch-review and atomic commits identified under plan_validated.

How do I block git commits until a review is done?▼

Define a requirement with scope single_use and a trigger_tools entry matching Bash with the command_pattern git\s+commit. Each commit then requires satisfaction, which can happen automatically via the /pre-commit skill mapping.

What are the requirement scopes in the requirements framework?▼

Four scopes exist: session lasts until the Claude session ends, branch persists across sessions, permanent never auto-clears, and single_use clears after each triggering action such as a commit.

Why is the requirements hook not triggering on file edits?▼

Check whether you are on main or master, confirm the requirement is enabled with req config, run req doctor to validate plugin hook integrity, and ensure CLAUDE_SKIP_REQUIREMENTS is not set. Wildcard permissions like Edit(*) also bypass hooks.

How do I temporarily disable requirements for one project?▼

Set enabled: false in .claude/requirements.local.yaml, export CLAUDE_SKIP_REQUIREMENTS=1, disable a single requirement with req config <name> --disable --local, or run req pause to suspend blocking gates for the session.