Metadata-Version: 2.4
Name: axm
Version: 0.2.0
Summary: AXM CLI — thin autodiscovery wrapper for the AXM ecosystem
Project-URL: Homepage, https://github.com/axm-protocols/axm
Project-URL: Documentation, https://axm-protocols.github.io/axm/
Project-URL: Repository, https://github.com/axm-protocols/axm.git
Project-URL: Issues, https://github.com/axm-protocols/axm/issues
Author-email: Gabriel Jarry <gabriel@axm-protocols.io>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: cyclopts>=4.5.1
Provides-Extra: all
Requires-Dist: axm-audit; extra == 'all'
Requires-Dist: axm-bib; extra == 'all'
Requires-Dist: axm-init; extra == 'all'
Requires-Dist: axm-mcp; extra == 'all'
Provides-Extra: audit
Requires-Dist: axm-audit; extra == 'audit'
Provides-Extra: bib
Requires-Dist: axm-bib; extra == 'bib'
Provides-Extra: init
Requires-Dist: axm-init; extra == 'init'
Provides-Extra: mcp
Requires-Dist: axm-mcp; extra == 'mcp'
Description-Content-Type: text/markdown

  AXM Logo

  AXM CLI — Unified command-line interface for the AXM ecosystem

  Python 3.12+

---

## Features

- 🔌 **Autodiscovery** — automatically finds commands from installed AXM packages via entry points
- 🧩 **Modular** — install only what you need (`axm[init]`, `axm[audit]`, `axm[bib]`, `axm[mcp]`)
- 🛠️ **Shared interface** — provides `AXMTool`/`ToolResult` and `HookAction`/`HookResult` for ecosystem development
- 📦 **Minimal** — only depends on `cyclopts`, everything else is optional

## Installation

```bash
uv add axm              # CLI shell only
uv add axm[init]        # + scaffolding & project checks
uv add axm[audit]       # + code quality audits
uv add axm[bib]         # + bibliography tools
uv add axm[mcp]         # + MCP server (for AI agents)
uv add axm[all]         # everything
```


Or with pip

```bash
pip install axm              # CLI shell only
pip install axm[init]        # + scaffolding & project checks
pip install axm[audit]       # + code quality audits
pip install axm[bib]         # + bibliography tools
pip install axm[mcp]         # + MCP server (for AI agents)
pip install axm[all]         # everything
```


## Usage

```bash
axm                          # shows available commands
axm init_scaffold my-project # if axm-init is installed
axm init_check .             # check project conformity
axm audit .                  # if axm-audit is installed
```

## How It Works

Each AXM package declares commands via `pyproject.toml`:

```toml
# axm-init/pyproject.toml
[project.entry-points."axm.commands"]
init_scaffold = "axm_init.cli:scaffold"
init_check    = "axm_init.cli:check"
init_reserve  = "axm_init.cli:reserve"
```

The `axm` CLI discovers these at startup and exposes them as subcommands.

## Package Structure

```
axm/
├── src/axm/
│   ├── cli.py         # Autodiscovery wrapper (~80 lines)
│   ├── hooks/
│   │   ├── base.py    # HookAction Protocol + HookResult (lifecycle hooks)
│   │   └── __init__.py
│   ├── tools/
│   │   ├── base.py    # AXMTool Protocol + ToolResult (shared interface)
│   │   └── __init__.py
│   └── __init__.py
└── tests/
    ├── hooks/
    │   └── test_base.py
    ├── tools/
    │   └── test_base.py
    ├── test_cli.py
    └── test_version.py
```

## Development

```bash
git clone https://github.com/axm-protocols/axm.git
cd axm
uv sync --all-groups
uv run pytest
```

## License

Apache License 2.0
