theoworks-cli 0.1.0

TheoWorks CLI — local-mode `theoworks` / `theo` commands: init a sphinx-needs project, build the needs graph, validate, and report traceability

theoworks-cli

The TheoWorks command-line interface — local-mode tools for sphinx-needs requirements projects. Installs the theoworks (and short theo) console scripts.

Install

pip install theoworks-cli

This pulls in theoworks-core and theoworks-sphinx.

Usage

# Scaffold a new sphinx-needs project (pick a starter pack)
theoworks init my-project --name "My Project" --pack aspice

# Build the needs graph (needs-graph.json) for a project
theoworks serve my-project

# Validate needs against the project's pack schema (CI shift-left; exits non-zero on errors)
theoworks validate my-project

# Traceability & coverage report (optionally as JSON)
theoworks trace my-project
theoworks trace my-project --json report.json

# Version
theoworks --version

All commands run locally and offline — no network calls, no server. The hosted multi-user editor is a separate product; see theoworks.io.

License

Apache-2.0. See LICENSE.