Metadata-Version: 2.4
Name: theoworks-cli
Version: 0.1.0
Summary: TheoWorks CLI — local-mode `theoworks` / `theo` commands: init a sphinx-needs project, build the needs graph, validate, and report traceability
Author: TheoWorks
License-Expression: Apache-2.0
Project-URL: Homepage, https://theoworks.io
Project-URL: Source, https://gitlab.com/theoworks/theoworks
Keywords: sphinx,sphinx-needs,requirements,ASPICE,traceability
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: theoworks-core>=0.1.0
Requires-Dist: theoworks-sphinx>=0.1.0
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Dynamic: license-file

# theoworks-cli

The [TheoWorks](https://theoworks.io) command-line interface — local-mode tools
for [sphinx-needs](https://sphinx-needs.readthedocs.io) requirements projects.
Installs the `theoworks` (and short `theo`) console scripts.

## Install

```bash
pip install theoworks-cli
```

This pulls in [`theoworks-core`](https://pypi.org/project/theoworks-core/) and
[`theoworks-sphinx`](https://pypi.org/project/theoworks-sphinx/).

## Usage

```bash
# 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](https://theoworks.io).

## License

Apache-2.0. See [LICENSE](LICENSE).
