Commands#

Every command explains itself with --help. These pages show the same help, with examples.

Start an instance#

Command	What it does
`modsmith install`	Install a modpack as a new instance in the official launcher.
`modsmith create`	Create an empty instance, with or without a mod loader.
`modsmith import`	Manage an installation you made in the official launcher as an instance.

Command	What it does
`modsmith add`	Add mods, resource packs or shaders to an instance, with what they need.
`modsmith remove`	Remove projects you added, and the dependencies nothing else needs.
`modsmith update`	Update an instance’s pack, and the projects you added to it.
`modsmith enable`	Turn mods, resource packs or shaders back on.
`modsmith disable`	Turn mods, resource packs or shaders off, without removing them.
`modsmith pin`	Keep projects you added at their current release.
`modsmith unpin`	Let pinned projects update again.
`modsmith adopt`	Recognise files you put in an instance, so they can be updated and removed.

Command	What it does
`modsmith list`	List your instances.
`modsmith show`	List the mods, resource packs and shaders in an instance.
`modsmith search`	Search for mods, modpacks, resource packs or shaders.
`modsmith info`	Show a project’s details, its newest releases and what changed last.
`modsmith loaders`	List a mod loader’s versions for a Minecraft version.

Command	What it does
`modsmith move`	Rename an instance or move its folder, and update its launcher installation.
`modsmith delete`	Delete an instance’s folder, worlds included, and its launcher installation.

Command	What it does
`modsmith config`	Show and change settings. With no command, show them all.

These go before the command, as in modsmith --verbose update.

--instances-dir path: Use this instances folder for this run. The instances_dir setting sets it for every run.
--game-dir path: Use this game directory for this run. The game_dir setting sets it for every run.
--verbose, -v: Show more detail. Repeat for more.
--color auto|always|never: When to use colour. NO_COLOR also turns it off. Defaults to auto.
--version: Show the version and exit.
--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.

Code	Meaning
`0`	It worked, or you answered no and nothing changed
`1`	Something went wrong; the message says what
`2`	The command or its options were not right; see `--help`
`130`	Stopped with Ctrl+C; nothing was left half done