Metadata-Version: 2.4
Name: modwire-cli
Version: 2.0.0
Summary: Command-line interface for the Modwire ecosystem.
Author: Tomasz Szpak
License-Expression: MIT
Project-URL: Homepage, https://github.com/modwire/modwire-cli
Project-URL: Repository, https://github.com/modwire/modwire-cli
Project-URL: Issues, https://github.com/modwire/modwire-cli/issues
Keywords: cli,modwire
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: modwire-architecture<8,>=7
Requires-Dist: modwire-extraction<3,>=2
Requires-Dist: pydantic-yaml>=1.7
Requires-Dist: rich>=13
Requires-Dist: wireup>=2.12.0
Provides-Extra: dev
Requires-Dist: build>=1.3; extra == "dev"
Requires-Dist: pytest>=9; extra == "dev"
Requires-Dist: ruff>=0.14; extra == "dev"
Requires-Dist: twine>=6; extra == "dev"
Dynamic: license-file

# modwire-cli

The command-line interface for the Modwire ecosystem.

## Install

```sh
pip install modwire-cli
```

## Usage

```sh
modwire init
modwire report --language python
```

By default, Modwire reads its configuration from `.modwire/architecture.yaml`
and analyses the current directory. Override either path when needed:

```sh
modwire report --language typescript --dot-dir path/to/.modwire --architecture-root path/to/source
```

Use `--summary` for a compact module → layer map that omits individual source files:

```sh
modwire report --language python --summary
```

The original option-only command remains supported for existing automation:

```sh
modwire --language python
```

To check this repository's architecture:

```sh
uv run modwire report --language python
```

<!-- generated:public-api:start -->
## Command reference

Provide `modwire init` for setup and `modwire report` for architecture feedback.

Existing `modwire --language <language>` automation continues to run reports.

| Command | Purpose |
| --- | --- |
| `modwire init` | Create `.modwire/` guidance and a strict architecture template. |
| `modwire report --language <language>` | Analyse the configured project and render violations. |
| `modwire --language <language>` | Backwards-compatible form of `report`. |

Use `--summary` with `report` to render module-to-layer membership without files.
<!-- generated:public-api:end -->

## Development

```sh
uv sync --all-groups
uv run pytest
uv run ruff check .
uv build
```

The README command reference is generated from the public CLI docstring:

```sh
make docs
make verify
```
