Skip to main content

spec-probe

Check code against functional requirements in a spec (.md / .docx / .pdf). Use VS Code Copilot chat (/spec-cover, …) or the spec-probe CLI.


Install

pip install spec-probe
spec-probe-skill --vscode
Step What it does
pip install spec-probe Python package + CLI only
spec-probe-skill --vscode Skills → ~/.copilot/skills/, config + .venv under ~/.config/spec-probe/

Python ≥ 3.11. Reload VS Code after spec-probe-skill.

Optional: sudo apt install ripgrep (faster search on Linux).


Configure

Edit ~/.config/spec-probe/:

  • .env — EXACODE_API_KEY (and other keys if you change LLM jobs in config.json).
  • config.yaml — absolute paths:
input:
  module_path: /abs/path/to/your/app
  spec_path: /abs/path/to/spec.md
  related_modules:
    paths:
      - /abs/path/to/other/service

Codegraph (optional)

Needs Node.js.

spec-probe-codegraph /abs/path/to/module

With related_modules, index the monorepo root. After big changes: codegraph sync /abs/path/to/monorepo-root.


Chat workflow (VS Code Copilot)

Step In chat
Pack /spec-pack
Explore spec parse spec summary / list section …
Verify verify FR … / check requirement: (paste text)
Report file write report (after verify)
Audit /spec-audit

Large spec: parse → a few FRs or one section → verify. Verify/check → chat only; ask for a report when you need files.


CLI (optional)

spec-probe verify --module /abs/app --spec /abs/spec.md --fr FR-001
spec-probe check "The module shall …"
spec-probe parse --spec /abs/spec.md --summary

Paths default from ~/.config/spec-probe/config.yaml when omitted.


License

MIT — see LICENSE. Maintainers: docs/PYPI.md.

Release files for spec-probe 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spec-probe 0.1.5
File Size Uploaded
spec_probe-0.1.5.tar.gz 237.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for spec-probe 0.1.5
File Interpreter ABI Platform
spec_probe-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 492.0 kB

Release files / spec_probe-0.1.5.tar.gz

Download URL spec_probe-0.1.5.tar.gz
Size 237.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ab9d3a8d26d044f71a32fa0b26738b3859fa6889a24505a9f1347572bf0df0f8
BLAKE2b-256 checksum
How to use checksums
e14f64c330f03e7270f68451130983df817138d7cd250026a55a10c394ec8caa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / spec_probe-0.1.5-py3-none-any.whl

Download URL spec_probe-0.1.5-py3-none-any.whl
Size 254.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
298da68b607aa69addbdb701b69aba66c2c6410562ab5e463e02410df179db4f
BLAKE2b-256 checksum
How to use checksums
da97deac0b286adcbb6fab5f848d5059a40efbd29ab9a484b7cafe39a21d0c8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release 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