Skip to content

Install

MuchAdo runs on macOS (Apple Silicon) today. Linux and Windows are planned; see What works today.

1. The application

uv tool install muchado      # or: pipx install muchado

This gives you the muchado command. It is small, and on its own it cannot edit anything yet — it needs the payload.

2. The payload

The payload holds the editors, the document engine and the fonts. Ask for it explicitly:

muchado payload install

The public payload origin is not up yet

Until it is, that command will tell you it cannot reach the origin and point you at the alternative. If you have built the artifacts yourself, or been given them, install from the directory instead:

muchado payload install --from /path/to/artifacts

Building them yourself is documented in Build the payload.

Installation is not just unpacking. Some of the payload's files record absolute paths and have to be generated on your machine, so the last step of the install runs a font indexer locally. This is why the payload cannot simply be a zip file someone else made.

Check what you have

muchado payload status

Where things live

macOS ~/Library/Application Support/MuchAdo/
Linux $XDG_DATA_HOME/muchado/, or ~/.local/share/muchado/

The payload sits under payload/<version>/ there. Nothing else on your system is touched.

To point MuchAdo at a payload somewhere else — a local build, say — set MUCHADO_PAYLOAD to its directory. That overrides everything else, which is what makes development possible without reinstalling.

Remove it

muchado payload remove