Skip to main content

umu-commander is an interactive CLI tool to help you manage umu.

Project description

umu-commander

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

Proton versions can track and untrack directories, with the intention of safely removing them once no game depends on one.

Vanilla umu config files currently (06/2025) do not support setting environmental variables. 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
PROTON_PATHS List of directories umu-commander will search for Proton versions.
UMU_PROTON_PATH Directory where umu-launcher downloads its UMU-Proton versions.
DB_NAME Tracking DB filename.
DB_DIR Directory where the Tracking DB is stored.
UMU_CONFIG_NAME Name of the umu config created using umu-commander create.
DEFAULT_PREFIX_DIR Directory where umu-commander will search for WINE prefixes.
[DLL_OVERRIDES_OPTIONS] TOML table where all possible DLL overrides are listed.

To add an extra DLL override option, add a line below the table in the form "Label" = "WINE override string". Use the winhttp example as a template.

Verbs

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

Name Description
track Tracks current directory with the selected Proton version.
Also removes it from any other tracking lists.
untrack Removes the current directory from all tracking lists.
users Lists which directories 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 in the current directory.

Installation/Usage

Add umu-run to your PATH and then install with pipx by running pipx install umu-commander. After that you can use umu-commander by running umu-commander <verb>.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

umu_commander-1.5.6.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

umu_commander-1.5.6-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file umu_commander-1.5.6.tar.gz.

File metadata

  • Download URL: umu_commander-1.5.6.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for umu_commander-1.5.6.tar.gz
Algorithm Hash digest
SHA256 bf16afd43c074e9295d4880158b2017c9a8387a85d5702fd15549cb76fbf8f95
MD5 e49ce22a5807810f280192090334e055
BLAKE2b-256 2c43933cff694c45d823dfd224c3829073b74a3969a04230f067c522d762eb36

See more details on using hashes here.

File details

Details for the file umu_commander-1.5.6-py3-none-any.whl.

File metadata

  • Download URL: umu_commander-1.5.6-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for umu_commander-1.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ff2dd21aa924d6489aa5352e8c1e65f38a3b41a9674bafbd0093b53d6298d154
MD5 02870028c54769e664cb2f0235483e66
BLAKE2b-256 8eef39f6772f7de7c88c1986cc587b3358a3cd60e01059c9c008daf1634dc22b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page