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.

umu-commander will look for your installed Proton versions using a predetermined list of directories, if you notice some versions missing, the listed can be edited within the configuration.py file in the src directory.

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.1.tar.gz (14.1 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.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: umu_commander-1.5.1.tar.gz
  • Upload date:
  • Size: 14.1 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.1.tar.gz
Algorithm Hash digest
SHA256 be90348c6c93ae598ee96a3c84a8ef3127e36c060a8c746864558e6c549e6748
MD5 72bfb390c8fe101e0553b97e751177be
BLAKE2b-256 4a1ee309cf881fa9b1ba6fb7318db524277dda8d193f96daf73d12f0371e7b53

See more details on using hashes here.

File details

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

File metadata

  • Download URL: umu_commander-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 11.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 388ff1951cc84a5b4ac8de1b86c70d94a0a4e08713f4d11b81ea579fbf63f015
MD5 897f583a0ac2d901420ad09727e38738
BLAKE2b-256 d2f9e4fca4d44af09dee1b5831ba1125a27469684f327248ce35a9251af22c54

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