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

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

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

Configure

Edit files in ~/.config/spec-probe/:

1. API Keys & LLM (.env)

The default config.json uses GitHub Copilot (gpt-6-luna, gemini-3.8-flash) for search, rescue, and final review jobs, and Exacode for other pipeline jobs.

GitHub Copilot Token

To obtain and save your token automatically via GitHub Device Flow:

spec-probe-copilot-login

1. Open the URL shown in terminal: https://github.com/login/device
2. Enter the 8-character user code and click Authorize GitHub Copilot.
3. The token is automatically saved to COPILOT_GITHUB_TOKEN in ~/.config/spec-probe/.env.
4. Verify your setup:

   spec-probe-copilot-test
   

Alternative methods:

• GitHub CLI (gh): If already authenticated via gh auth login, spec-probe automatically falls back to gh auth token. You can also run:

  spec-probe-copilot-login --token "$(gh auth token)"
  

• Manual .env: Set directly in ~/.config/spec-probe/.env:

  COPILOT_GITHUB_TOKEN="gho_xxxxxxxxxxxxxxxxxxxx"
  

Exacode (OpenAI-compatible internal gateway)

Set in ~/.config/spec-probe/.env:

EXACODE_API_KEY=your_key_here
EXACODE_BASE_URL=https://api.example.com/exacode/v1

2. Paths (config.yaml)

Specify 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)

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.