Skip to main content

umu-commander

umu-commander is a CLI tool to augment umu-launcher as well as help you manage its Proton versions.

This tool does not provide a centralised way of managing your games or utilise template umu-configs. See faugus-launcher or Nero-umu for something more akin to a games launcher, and umu-wrapper for templating functionality.

Proton versions can track and untrack game configs, with the intention of safely removing them once no config (and subsequently application) depends on one.

Vanilla umu config files currently (06/2025) do not support setting environmental variables or runners. This tool adds such functionality with an extra TOML table within said configs, see example_config.toml for an example.

Config

The configuration file lives at ~/.config/umu-commander.toml, which cannot be changed as of now. You can generate one by running the app by itself.

The config schema is as follows:

Name Description
DB_DIR Directory where the Tracking DB is stored.
DB_NAME Tracking DB filename.
DEFAULT_PREFIX_DIR Directory where umu-commander will search for WINE prefixes.
PROTON_PATHS List of directories umu-commander will search for Proton versions.
DEFAULT_UMU_CONFIG_NAME Default name of the umu config created using umu-commander create.
UMU_PROTON_PATH Directory where umu-launcher downloads its UMU-Proton versions.
[DLL_OVERRIDES_OPTIONS] TOML table where all possible DLL overrides are listed.
[LANG_OVERRIDES_OPTIONS] TOML table where all possible LANG overrides are listed.

To add an extra DLL override option, add a line below the table in the form "Label" = "WINE DLL override string". Use the winhttp example as an example. You can add LANG overrides in a similar way.

Verbs

umu-commander needs one of the following verbs specified after the executable name:

Name Description
track Tracks selected config with the selected Proton version.
Also removes it from any other tracking lists.
untrack Removes the selected config from all tracking lists.
users Lists which configs the selected Proton version is tracking.
delete Interactively deletes Proton versions that are currently tracking nothing.
Will not remove the latest UMU-Proton and Proton versions that haven't been used for tracking before.
umu-commander will never delete anything without invoking this verb and confirming.
create Creates an augmented umu config in the current directory.
These configs are compatible with vanilla umu-launcher, although the DLL override functionality won't work.
run Runs a program using the umu config selected.
fix Attempts to fix invalid paths created from moving configs around.

Installation/Usage

Add umu-run to your PATH and then install with pipx by running pipx install umu-commander.
After that you can run umu-commander -h for an explanation of the options, and umu-commander <verb> [<options>] for using the app's functionality.

Return codes

Number Name Description
0 SUCCESS Program executed as intended.
1 DECODING_ERROR Failed to parse a file.
2 INVALID_SELECTION User selected an invalid verb or there are no valid selections.

Metadata

Release files for umu-commander 2.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for umu-commander 2.2.1
File Size Uploaded
umu_commander-2.2.1.tar.gz 16.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for umu-commander 2.2.1
File Interpreter ABI Platform
umu_commander-2.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 30.1 kB

Release files / umu_commander-2.2.1.tar.gz

Download URL umu_commander-2.2.1.tar.gz
Size 16.9 kB
Tags Source
SHA-256 checksum
How to use checksums
caba30a649ecf85de4bed4f6b9e24d9c3be73e343609cf7f62d28c4a3ecce081
BLAKE2b-256 checksum
How to use checksums
0de9c6f1d9e0054e08e73a984ae9d2f6e4f25a474796ec6192b91a43bd82259f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / umu_commander-2.2.1-py3-none-any.whl

Download URL umu_commander-2.2.1-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
074b6f52ec659066eeab027cfe5bfd524a240b0a92e7ebff94d62e573199670a
BLAKE2b-256 checksum
How to use checksums
2ff998641fc6bc67e244bb0bd27145f19554cea894a923b412ddbb398326563f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

2.2.1 This release

2 release files

2.2.0

2 release files

2.1.6

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.7.0

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.4.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page