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-2.0.0.tar.gz (53.9 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-2.0.0-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for modwire_cli-2.0.0.tar.gz
Algorithm Hash digest
SHA256 93aae45a23263d16b17d155b8a2ccba731f8be90ef6af8b7a609c0529fcdeea7
MD5 7ea4df0c811d7dbaef9f3902cb1d3323
BLAKE2b-256 53ceccf19824e2d8d802825e69940f78767e8148664198f9b805aa0d124169f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for modwire_cli-2.0.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-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: modwire_cli-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 24.5 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-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f4d739adfaa6831ad07f1a782059fe5f5e71b456052ee32e2708a1b96b9422b
MD5 969964a8a7ac23072cb7a15f28345e5d
BLAKE2b-256 efb5c45293eccbdd90ea754778994eca1d40b5f44ebe3b7c819f8c29747b4573

See more details on using hashes here.

Provenance

The following attestation bundles were made for modwire_cli-2.0.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

This release

2.0.0 This release

2 files

1.2.0

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