Getting Started

Java projects

  1. Add the Java Annotations dependency to your project

  2. Annotate implementations with @Requirements("REQ_001") and tests with @SVCs("SVC_001")

  3. Add the Maven Plugin or Gradle Plugin to your build

  4. The plugin assembles a ZIP artifact with requirements, annotations, and test results

  5. Install the CLI: pipx install reqstool

  6. Run: reqstool status local -p docs/reqstool

See the Demo Project for a complete working example.

Python projects

  1. Add reqstool-python-decorators as a dependency

  2. Decorate implementations with @Requirements("REQ_001") and tests with @SVCs("SVC_001")

  3. Add the Hatch Plugin or Poetry Plugin to your build

  4. Install the CLI: pipx install reqstool

  5. Run: reqstool status local -p docs/reqstool

TypeScript projects

  1. Add @reqstool/reqstool-typescript-tags as a dev dependency

  2. Tag your code with reqstool annotations

  3. Run the tag processor: reqstool-typescript-tags --inputs src,tests --output docs/reqstool/annotations.yml

  4. Install the CLI: pipx install reqstool

  5. Run: reqstool status local -p docs/reqstool

VS Code integration

Install the VS Code Extension from the marketplace to get hover information for requirements and SVCs directly in your editor.

AI-assisted workflow

Use reqstool-ai to integrate requirements management into AI coding assistants like Claude Code.