req-agent (npm)

Thin Node launcher for the Python Requirements Agent.

The agent itself is a Python package (requirements-agent on PyPI).
npm cannot run the Spec Circuit pipeline natively — this package only exposes the same CLI via npx / global npm install.

Prerequisites

• Node.js 18+
• Python 3.9+
• pip install requirements-agent (or auto-attempted on npm install)

Install

# once Python package is on PyPI:
npm install -g req-agent

# or one-shot
npx req-agent --help

From this repo (dev):

cd Requirement_Agent
pip install -e ".[dev]"
cd npm && npm install && npm link
req-agent --help

Usage

Same as the Python CLI:

npx req-agent init
npx req-agent models
npx req-agent docs --open
npx req-agent run --profile mock --title "SSO" --design "..." --out ./out

Bundled docs (also under node_modules/req-agent/docs/ after install):

• docs/HOW_TO_USE.md — setup + usage
• docs/requirements-agent-architecture.html — interactive architecture

Or from the Python package: req-agent docs --copy ./docs

Publish to npm

Prefer the repo release script (syncs version + PyPI + npm):

cd ..   # Requirement_Agent/
./scripts/publish.sh 0.2.0

Or npm only:

cd npm
npm login   # once
npm publish --access public

Package name: req-agent (change in package.json if taken).

Publish the real agent to PyPI (required)

cd ..   # Requirement_Agent/
pip install build twine
python -m build
twine upload dist/*

Without PyPI, npm users must install from git/path:

pip install -e /path/to/Requirement_Agent