Skip to main content

A tool for managing requirements with related tests and test results.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reqstool-0.10.0.tar.gz (190.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reqstool-0.10.0-py3-none-any.whl (137.4 kB view details)

Uploaded Python 3

File details

Details for the file reqstool-0.10.0.tar.gz.

File metadata

  • Download URL: reqstool-0.10.0.tar.gz
  • Upload date:
  • Size: 190.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for reqstool-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b77841c3f61107a468c33ad86358ae6e9f32fa781906f77a2e15eef779b3e69c
MD5 1b6b6dea611a7f7430a1b99b9b3f2273
BLAKE2b-256 0e70764fbed4ad26c0c19cda07c60edb7ea30f3e52c6ea99a5d116258426de4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool-0.10.0.tar.gz:

Publisher: release_prod.yml on reqstool/reqstool-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file reqstool-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: reqstool-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 137.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for reqstool-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7572e35f700d1376503d065b852eada5c25eee485d4171170feebb355d3e0d62
MD5 bca32dfecef4f4c4c08e4f812b6cd613
BLAKE2b-256 620c846e8c122be605353d9c20f0d14f188492a71ccee93f19b9c13ec3cff937

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool-0.10.0-py3-none-any.whl:

Publisher: release_prod.yml on reqstool/reqstool-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page