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 help you manage Proton versions used by umu, as well as create enhanced launch configs.

Proton versions can be tracked and untracked, with the intention of being safely removable once no game depends on a specific one.
What directories each Proton version is being used by is tracked within tracking.json inside your umu Proton directory by default.

Vanilla umu configuration files currently do not support setting environmental variables, this tool adds such functionality by adding an extra TOML table in the umu config itself. An example config is available under the name example_config.toml.

Config

The configuration file lives at ~/.config/umu-commander.toml. Within it, you can edit the following:

  • PROTON_PATHS: List of directories umu-commander will search for Proton versions.
  • UMU_PROTON_PATH: Directory where umu itself 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 run.
  • DEFAULT_PREFIX_DIR: Directory where WINE prefixes are scanned.
  • [DLL_OVERRIDES_OPTIONS]: Category to list possible DLL overrides in "Label" = "Override string" format.

Verbs

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

  • track: Adds the current directory to a specified Proton version's list of users.
    • If the directory is already in another list, it will be removed from it.
    • The create verb will automatically track the current directory.
    • This will not update any existing configs.
  • untrack: Removes the current directory from all tracking lists.
  • users: Lists each Proton version's users.
  • delete: Interactively deletes any Proton version in the tracking database with no users.
    • This will actually remove the Proton directories, use at your own risk.
    • If a Proton version has not been tracked before, it will not be removed, neither will the latest umu Proton.
    • umu-commander will not delete anything without invoking this verb and receiving confirmation.
  • create: Creates a custom configuration file in the current directory.
  • run: Uses the config in the current directory to run the program.
    • This is NOT equivalent to umu-run --config <config_name>, as vanilla umu configs do not support setting environment variables as of 07/2025.

Installation/Usage

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

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.2.tar.gz (14.2 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.2-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: umu_commander-1.5.2.tar.gz
  • Upload date:
  • Size: 14.2 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.2.tar.gz
Algorithm Hash digest
SHA256 1d1c7ea291d95ded31d42e49692f1e7f39d8465dd16703ed3da19df9fb72b8c9
MD5 d5df7e6fab1cd6f87fb156e1ab854457
BLAKE2b-256 a3c64ae106dc9cee6563d1bc8831ba0de56dc780f8098da080c28b4b3b256954

See more details on using hashes here.

File details

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

File metadata

  • Download URL: umu_commander-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 11.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fc8c3f635aa506ba07be5ed955426dadff76d9d37f62e9f9702891193681639
MD5 4b2bbdcc2c902e60520a48678586af1e
BLAKE2b-256 8ba8f33793885ae681cf49a37c505a384186f305c05a248adbc1d3a0b4b429e2

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