Skip to main content

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.

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.12.0.tar.gz (256.6 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.12.0-py3-none-any.whl (156.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reqstool-0.12.0.tar.gz
  • Upload date:
  • Size: 256.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for reqstool-0.12.0.tar.gz
Algorithm Hash digest
SHA256 dbecc39579869a6eb912d5b0a00790d6ec9cfe2b9f67f5a1b656242ae475caad
MD5 2c4f33e166b3ef9c1557a970e5c92e41
BLAKE2b-256 1c2bbf0ede2ea577728604ea3c8855322dc5f254e9e6853dca4c455ba6cb560d

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool-0.12.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.12.0-py3-none-any.whl.

File metadata

  • Download URL: reqstool-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 156.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for reqstool-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6d00b03f41963809c84b9ec5f0287cddf45ee0b112a565d653875bb4f5043a3
MD5 9662a0366596e2f417d43fff0f70eab5
BLAKE2b-256 c094ae2eb217152d69be3660735a2fdceccbf73c183d2b5a0985b75a87264690

See more details on using hashes here.

Provenance

The following attestation bundles were made for reqstool-0.12.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.

Release history Release notifications | RSS feed

0.12.2

2 files

0.12.1

2 files

This release

0.12.0 This release

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.12

2 files

0.5.11

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.2

2 files

0.5.0

2 files

0.4.10

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page