Requirements Agent
Self-contained Spec Circuit requirements agent: multi-persona BMAD review → quality score → gap-driven refine → BRD → Markdown/PDF.
No FastAPI / Mongo dependency. Configure LLMs in JSON, agent settings in YAML, run from CLI or Textual TUI.
Docs (shipped in the package):
req-agent docs # paths to bundled files
req-agent docs --open # architecture HTML in browser
req-agent docs --copy ./docs
- HOW_TO_USE.md — full setup + usage
- requirements-agent-architecture.html — interactive architecture
Install & init
cd Requirement_Agent
pip install -e ".[dev]"
# Scaffold config in the current directory
req-agent init
# Or into ~/.config/requirements-agent/
req-agent init --global
npm launcher (optional)
The agent is Python. For npx / npm discoverability there is a thin wrapper in npm/:
cd npm && npm install && npm link
npx req-agent --help
Publish PyPI for the real package; publish npm only as the launcher (see npm/README.md).
One-shot release (same version on both registries; assumes you already ran twine/npm login):
./scripts/publish.sh # current pyproject version
./scripts/publish.sh 0.2.0 # bump + publish
./scripts/publish.sh --dry-run # build only
init writes:
| File | Purpose |
|---|---|
requirements-agent.yaml |
Agent settings (context, prompts, export, active LLM profile) |
llms.json |
Named LLM profiles (multiple models/providers) |
.env.example |
Env var cheat-sheet for API keys |
Configure LLMs (llms.json)
{
"default": "azure-gpt4o",
"models": {
"azure-gpt4o": {
"provider": "azure",
"model": "gpt-4o",
"deployment": "gpt-4o",
"endpoint": "https://YOUR.openai.azure.com/",
"api_key_env": "RA_AZURE_API_KEY",
"temperature": 0.3
},
"ollama-llama": {
"provider": "ollama",
"model": "llama3.2",
"endpoint": "http://127.0.0.1:11434/v1"
},
"mock": { "provider": "mock", "model": "mock" }
}
}
List profiles: req-agent models
Configure agent (requirements-agent.yaml)
llm:
models_file: ./llms.json
active: azure-gpt4o # or override with --profile
context:
providers: [folder]
folder_paths: [./docs]
prompts:
personas:
architect:
system_extra: "Emphasize zero-trust boundaries."
export:
default_format: both
out_dir: ./out
Examples: config.example.yaml, llms.example.json. Legacy TOML still loads if present.
Env overrides: RA_CONFIG, RA_LLMS_JSON, RA_LLM_PROFILE, RA_LLM_PROVIDER, RA_LLM_MODEL, RA_API_KEY / OPENAI_API_KEY / RA_AZURE_*.
CLI
# Preferred: open the shell, set everything in chat
req-agent start
# optional: -p azure-gpt5.4
# Inside the shell:
# /title Identity Hub SSO
# /brief ./brief.md
# /ref ./contracts/
# /analyse (also /run)
# /exit
# Same as start (flags are optional shortcuts)
req-agent run
req-agent run -t "Identity Hub SSO" -f ./brief.md --docs ./contracts/ -p azure-gpt5.4
# Headless / CI
req-agent run --title "..." --design-file brief.md --profile mock --plain --out ./out
# Continue against an existing report
req-agent chat -t "Identity Hub SSO" -f brief.md -r ./out/02-requirements-report.md --docs ./contracts/
# Or from the shell: /open ./out/02-requirements-report.md
req-agent refine --title "..." --design-file brief.md --report ./out/02-requirements-report.md \
--list-sections
req-agent refine --title "..." --design-file brief.md --report ./out/02-requirements-report.md \
--section "Non-functional" --message "Add p95 latency and availability targets"
# updates the same file immediately; optional --out to write elsewhere
req-agent refine -r ./out/02-requirements-report.md -t "..." -f brief.md -i # interactive picker
req-agent consolidate --title "..." --design-file brief.md --report ./out/01-refined.md \
--out ./out/02-requirements-report.md
req-agent export --report ./out/02-requirements-report.md --out ./out/report --format both
Context injection
| Provider | v1 |
|---|---|
| folder | --attach / --context-dir / folder_paths |
| rag | Stub (phase 2) |
| mcp | Stub (phase 2) |
Personas
Eight BMAD roles (vendored bmad-core-spec): orchestrator → analyst → pm → po → architect → dev → qa → sm.
Metadata
Release files for requirements-agent 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| requirements_agent-1.0.2.tar.gz | 112.5 kB | Without provenance | Details for requirements_agent-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| requirements_agent-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for requirements_agent-1.0.2-py3-none-any.whl |
Total release size: 245.4 kB
Release files / requirements_agent-1.0.2.tar.gz
| Download URL | requirements_agent-1.0.2.tar.gz |
|---|---|
| Size | 112.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f943b7d109afc8f82863bef4dd41c58971c2563d8ab4aa9dccedaf4a155aa8a7
|
|
BLAKE2b-256 checksum How to use checksums |
b9b013ae9e5c836a75c0e01cc5546142b460ec2d2bae1018d3f30931627f1089
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / requirements_agent-1.0.2-py3-none-any.whl
| Download URL | requirements_agent-1.0.2-py3-none-any.whl |
|---|---|
| Size | 132.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
55bc4bdbefd03e61e8bebb89cbcf3f8670d2cf8b609244004dfabd4e5d5fe9bf
|
|
BLAKE2b-256 checksum How to use checksums |
1fc0e675d95b60a3fd4100d3461da76d7e2458f04dc7e0859e330edfcc3b100a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for requirements-agent 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.