Installation

Modsmith runs on Windows, macOS and Linux. It is installed with uv, which also brings the Python it needs, so you do not have to install Python yourself.

Install

Windows macOS Linux

1. Install uv. In PowerShell:

   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   

2. Open a new PowerShell window, and install Modsmith:

   uv tool install modsmith-cli
   

Already use pipx? pipx install modsmith-cli works too.

Check that it works

$ modsmith --version
modsmith 0.1.1

If the terminal says it does not know modsmith, open a new one, so it picks up the folder uv installed it to.

Before your first modpack

Modsmith works with the official Minecraft launcher. Install it, sign in, and start it once, so that it creates its game folder. Close it while Modsmith adds, moves or removes installations; Modsmith checks, and asks you to.

Tab completion

Modsmith can complete commands and instance names when you press Tab:

$ modsmith --install-completion

Then open a new terminal.

Upgrade

$ uv tool upgrade modsmith-cli

Modsmith 0.1.0 was installed from a file, under the name modsmith-app. Remove it before you install from PyPI; your instances and settings stay:

$ uv tool uninstall modsmith-app
$ uv tool install modsmith-cli

Uninstall

$ uv tool uninstall modsmith-cli

Your instances and settings stay where they are. To remove them too, see where things go.

Next

Install your first modpack.