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.2.tar.gz (272.4 kB view details)

Uploaded Aug 23, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

reqstool-0.12.2-py3-none-any.whl (161.7 kB view details)

Uploaded Aug 23, 2026 Python 3

File details

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

File metadata

Download URL: reqstool-0.12.2.tar.gz
Upload date: Aug 23, 2026
Size: 272.4 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.2.tar.gz
Algorithm	Hash digest
SHA256	`ca6abc7d7007425e40b37676a9444a85ada09ba7508788bafc1d1e8832917677`
MD5	`cac7862b12677f5100aa7a216fcc3cd2`
BLAKE2b-256	`6132a43ace5f508508848c0e3b49c528a2af87ff48054f037a536b0303e3082e`

See more details on using hashes here.

Provenance

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

Publisher: release.yml on reqstool/reqstool-client

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: reqstool-0.12.2.tar.gz
- Subject digest: ca6abc7d7007425e40b37676a9444a85ada09ba7508788bafc1d1e8832917677
- Sigstore transparency entry: 2576316670
- Sigstore integration time: Aug 23, 2026
Source repository:
- Permalink: reqstool/reqstool-client@33c3f2d3ff7700f97b101390398aef98b4603004
- Branch / Tag: refs/heads/main
- Owner: https://github.com/reqstool
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@33c3f2d3ff7700f97b101390398aef98b4603004
- Trigger Event: workflow_dispatch