Developer tools

Project commands expect to run from the directory containing pyproject.toml. Use --debug on any command to display the underlying external commands and additional diagnostic messages.

Synchronize the environment

ma up

This runs uv sync and uses .venv as the project environment.

Use --reset to remove .venv before synchronization:

ma up --reset

If the project exposes a command through project.scripts, install the working tree as an editable uv tool:

ma up --tool

The options can be combined:

ma up --reset --tool

Install development tools

ma tools

This installs the Ruff command used by ma style. Upgrade uv and reinstall the configured tools with:

ma tools --upgrade

Run Ruff

ma style

The command runs ruff check --fix. It performs lint checks and applies available fixes; it does not run ruff format.

Build or serve documentation

Start the MkDocs development server and open it in a browser:

ma docs

Build the site into site/ without starting a server:

ma docs --build

MkDocs and the configured theme must be present in the project environment. Projects created by the current default template include them in the docs dependency group.

Run tests

ma tests

See Local testing for matrix configuration and environment selection.