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.1.tar.gz (271.3 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.1-py3-none-any.whl (161.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reqstool-0.12.1.tar.gz
  • Upload date:
  • Size: 271.3 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.1.tar.gz
Algorithm Hash digest
SHA256 f2dcbb72b380f6cb9c7ee28d9f04387f56767448a1d7d00ad003eab112f8e433
MD5 f65e6f1b90e803242b5ce33a1628edca
BLAKE2b-256 cb0d1420a4a562ca711da34f11f12a699df1f7e2c91d16e4a7748f30735bd51d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: reqstool-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 161.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e009848b560d12423b6b8fe8307148dc80d00b4a9e48a2e00c55074f45639b3
MD5 d0008d2ed1fb8b5413cd56564a161637
BLAKE2b-256 d13762ecff8f43978fe457f766a1623a23ecdfba843e80be44a73022a3b293e5

See more details on using hashes here.

Provenance

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

This release

0.12.1 This release

2 files

0.12.0

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