Skip to content

README.md

Latest commit

 

History

History
63 lines (40 loc) · 2.7 KB

README.md

File metadata and controls

63 lines (40 loc) · 2.7 KB
Raw

Commit Activity GitHub Issues License Build Documentation GitHub Discussions

Reqstool Client

The reqstool command line client is the core tool for managing requirements traceability. It reads requirements, annotations, and test results to generate reports, exports, and status checks.

  • Status checks -- verify that all requirements are implemented and tested, with an exit code for CI/CD gates
  • Reports -- generate detailed reports in AsciiDoc or Markdown for auditors and stakeholders
  • JSON export -- export data for custom tooling, with optional requirement/SVC filters

Installation

Prerequisites

  • Python 3.13 or later
  • pip or pipx

Install with pipx (recommended)

pipx install reqstool
reqstool -h  # confirm installation

Install with pip

pip install reqstool
reqstool -h  # confirm installation

Usage

reqstool [-h] {report,export,status} {local,git,maven,pypi} ...

Use -h/--help for more information about each command and location.

Editor and AI Integration

  • LSP — language server for IDE features: hover, completion, go-to-definition, diagnostics, and outline view (reqstool lsp)
  • MCP — tool server for AI agents (Claude, Copilot, etc.) to query requirements, SVCs, and traceability status (reqstool mcp)
  • reqstool-ai — marketplace and plugins for reqstool and reqstool+OpenSpec integrations (github.com/reqstool/reqstool-ai)

Documentation

Full documentation, including getting started guides for Java, Python, and TypeScript, can be found at reqstool.github.io.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.