Skip to content

Getting Started

This tutorial walks you through installing axm and running your first command.

Prerequisites

  • Python 3.12+
  • uv (recommended) or pip

Installation

Install the CLI with the plugins you need:

Bash
uv pip install axm
Bash
uv pip install axm[init,audit]
Bash
uv pip install axm[all]
Bash
uv pip install axm[mcp]

Step 1: Check Available Commands

Bash
axm

Without any plugins, axm will show which packages you can install. With plugins:

Bash
axm init_scaffold my-project  # scaffold a new project
axm init_check .              # check project conformity
axm audit .                   # run quality checks

Step 2: Optional Dependencies

Extra Provides Commands
init axm-init axm init_scaffold, axm init_check, axm init_reserve
audit axm-audit axm audit
bib axm-bib axm-bib search, axm-bib pdf, axm-bib resolve
mcp axm-mcp axm-mcp (MCP server for AI agents)
all Everything above All commands

Next Steps