Skip to main content

modwire-cli

The command-line interface for the Modwire ecosystem.

Install

pip install modwire-cli

Usage

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:

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:

modwire report --language python --summary

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

modwire --language python

To check this repository's architecture:

uv run modwire report --language python

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.

Development

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

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

make docs
make verify

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modwire_cli-1.2.0.tar.gz (53.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

modwire_cli-1.2.0-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file modwire_cli-1.2.0.tar.gz.

File metadata

  • Download URL: modwire_cli-1.2.0.tar.gz
  • Upload date:
  • Size: 53.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for modwire_cli-1.2.0.tar.gz
Algorithm Hash digest
SHA256 1c2ec871a0d807083deb3f4bc048e6392b873e7be7ff17c7532ba568d40842c8
MD5 5f2cec493a4921ff2d03d25cdc3d31bf
BLAKE2b-256 5a87e0786751d1c9451c7368756957353e4789d63336a4d5400ded9a5b756f8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for modwire_cli-1.2.0.tar.gz:

Publisher: release.yml on modwire/modwire-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file modwire_cli-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: modwire_cli-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for modwire_cli-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 499f579ca7c17f7da2f61bf9986c2dfedcba8c2113b9d3c985e53a0a3ef35f03
MD5 2272aa8b415781ec946c5f1174a727be
BLAKE2b-256 1edcedf94ad753da22929252d64db9d775f8de7956122f0cac3daade751abfdc

See more details on using hashes here.

Provenance

The following attestation bundles were made for modwire_cli-1.2.0-py3-none-any.whl:

Publisher: release.yml on modwire/modwire-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.0.0

2 files

This release

1.2.0 This release

2 files

1.1.0

2 files

1.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page