mons

Install and manage mods for Celeste.

mons [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

add

Register an existing Celeste (or Everest) install.

mons add [OPTIONS] NAME PATH

Options

--overlay <overlay>

Overlay this install on top of PATH.

Arguments

NAME

Required argument

PATH

Required argument

help

Display help text for a command.

mons help [OPTIONS] [COMMAND]...

Arguments

COMMAND

Optional argument(s)

install

Install Everest.

VERSIONSPEC can be a branch name, build number, or version number.

mons can install ‘main’ and ‘olympus-build’ artifacts.

If VERSIONSPEC is not supplied, mons will attempt to determine the branch that is currently installed, and install the latest build from that branch.

mons install [OPTIONS] NAME [SOURCE]

Options

--latest

Install latest available build, branch-ignorant.

--src

Build and install from source folder.

--no-build

Use with --src to install without building.

--configuration <OPTION>

Configuration/Framework to build for.

--publish, --no-publish

Invoke the ‘Publish’ target when building.

--launch

Launch Celeste after installing.

Arguments

NAME

Required argument

SOURCE

Optional argument

launch

Launch the game associated with an install.

Any additional arguments are passed to the launched process.

mons launch [OPTIONS] NAME [ARGS]...

Options

--wait

Wait for game process to exit.

Game Arguments

--console

Attach output of game process (implies --wait).

--vanilla

Launch Celeste without Everest.

Arguments

NAME [ARGS]...

Required argument

list

List existing installs.

mons list [OPTIONS]

Options

-v, --verbose

Enable verbose logging.

mods

Manage Everest mods

Full Reference

mons mods [OPTIONS] COMMAND [ARGS]...

remove

Remove an existing install.

mons remove [OPTIONS] NAME

Options

--force

Skip confirmation prompt.

Arguments

NAME

Required argument

rename

Rename a Celeste install.

mons rename [OPTIONS] OLD NEW

Arguments

OLD

Required argument

NEW

Required argument

set-path

Change the path of an existing install.

mons set-path [OPTIONS] NAME PATH

Arguments

NAME

Required argument

PATH

Required argument

show

Display information for a specific install.

mons show [OPTIONS] NAME

Options

-v, --verbose

Enable verbose logging.

Arguments

NAME

Required argument

uninstall

Uninstall Everest from an overlay install.

mons uninstall [OPTIONS] NAME

Arguments

NAME

Required argument

use

Set the default install for mons commands.

To un-set, run export MONS_DEFAULT_INSTALL=

mons use [OPTIONS] NAME

Options

-e, --eval

Print export MONS_DEFAULT_INSTALL={NAME} to stdout.

Arguments

NAME

Required argument