Frequently Asked Questions¶

Common questions about RequireKit.

General Questions¶

What is RequireKit?¶

RequireKit is a requirements management toolkit using EARS notation for clear requirements, BDD/Gherkin for test scenarios, and epic/feature hierarchy for organization.

Do I need guardkit to use RequireKit?¶

No. RequireKit is fully functional standalone. guardkit is optional and adds task execution workflow, quality gates, and automated testing.

Learn more about integration →

What are EARS patterns?¶

EARS (Easy Approach to Requirements Syntax) provides five patterns for writing unambiguous requirements: Ubiquitous, Event-Driven, State-Driven, Unwanted Behavior, and Optional Feature.

Learn more about EARS →

Installation & Setup¶

How do I install RequireKit?¶

git clone https://github.com/yourusername/require-kit.git
cd require-kit
./installer/scripts/install.sh

Full installation guide →

Where are requirements stored?¶

Requirements are stored as markdown files in your project's docs/ directory: - docs/requirements/ - EARS requirements - docs/bdd/ - BDD scenarios - docs/epics/ - Epic specifications - docs/features/ - Feature specifications

Can I use RequireKit with existing projects?¶

Yes. Run /require-kit init in your project to create the directory structure, then start gathering requirements.

Usage Questions¶

How do I gather requirements?¶

Use the /gather-requirements command for interactive Q&A:

/gather-requirements feature-name

Complete workflow guide →

How do I generate BDD scenarios?¶

After formalizing requirements with EARS notation, run:

/generate-bdd

Learn about BDD →

Can I export to Jira/Linear?¶

Yes. RequireKit provides structured metadata for PM tool export:

/feature-sync FEAT-001 --jira
/feature-sync FEAT-001 --linear

Learn about PM tool integration →

Integration Questions¶

How does RequireKit integrate with guardkit?¶

Both packages detect each other via marker files. When both are installed, RequireKit can generate task specifications, and guardkit can load requirement context during execution.

Complete integration guide →

Do I need MCP servers?¶

No. MCP servers are optional and only needed if you want to extract requirements from design tools (Figma, Zeplin).

Learn about MCP setup →

Technical Questions¶

What file format does RequireKit use?¶

Markdown files with YAML frontmatter. This is: - Human-readable - Version-control friendly (Git) - Tool-agnostic - Easy to parse

Can I edit requirements manually?¶

Yes. All files are plain markdown and can be edited with any text editor.

How does traceability work?¶

Requirements link to features via frontmatter metadata, creating a traceable hierarchy from epics to implementation.

Learn about traceability →

Troubleshooting¶

Commands not found after installation¶

Add ~/.agentecflow/bin to your PATH and reload your shell.

Installation troubleshooting →

Integration not detected¶

Verify both marker files exist:

ls ~/.agentecflow/*.marker

Integration troubleshooting →