| Name | umu-commander JSON |
| Version |
1.6.0
JSON |
| download |
| home_page | None |
| Summary | umu-commander is an interactive CLI tool to help you manage umu. |
| upload_time | 2025-08-09 09:12:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
umu
umu-launcher
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## 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.<br/>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.<br/>Will not remove the latest UMU-Proton and Proton versions that haven't been used for tracking before.<br/>umu-commander will never delete anything without invoking this verb and confirming. |
| `create` | Creates an augmented umu config in the current directory.<br/>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. |
Raw data
{
"_id": null,
"home_page": null,
"name": "umu-commander",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "umu, umu-launcher",
"author": null,
"author_email": "Mpaxlamitsounas <worldstudy123@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/70/fd/a7c55acaf3e1acb9f54860c9c57f942e286fd13ba3308c4d4aaf84042d3f/umu_commander-1.6.0.tar.gz",
"platform": null,
"description": "## umu-commander\n### umu-commander is an interactive CLI tool to augment umu-launcher as well as help you manage its Proton versions.\n\nProton versions can track and untrack directories, with the intention of safely removing them once no game depends on one.\n\nVanilla 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.\n\n### Config\nThe 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.\n\nThe config schema is as follows:\n\n| Name | Description |\n|:--------------------------|:-------------------------------------------------------------------|\n| `PROTON_PATHS` | List of directories umu-commander will search for Proton versions. |\n| `UMU_PROTON_PATH` | Directory where umu-launcher downloads its UMU-Proton versions. |\n| `DB_NAME` | Tracking DB filename. |\n| `DB_DIR` | Directory where the Tracking DB is stored. |\n| `UMU_CONFIG_NAME` | Name of the umu config created using umu-commander create. |\n| `DEFAULT_PREFIX_DIR` | Directory where umu-commander will search for WINE prefixes. |\n| `[DLL_OVERRIDES_OPTIONS]` | TOML table where all possible DLL overrides are listed. |\n\nTo 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.\n\n### Verbs\numu-commander needs one of the following verbs specified after the executable name:\n\n| Name | Description |\n|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `track` | Tracks current directory with the selected Proton version.<br/>Also removes it from any other tracking lists. |\n| `untrack` | Removes the current directory from all tracking lists. |\n| `users` | Lists which directories the selected Proton version is tracking. |\n| `delete` | Interactively deletes Proton versions that are currently tracking nothing.<br/>Will not remove the latest UMU-Proton and Proton versions that haven't been used for tracking before.<br/>umu-commander will never delete anything without invoking this verb and confirming. |\n| `create` | Creates an augmented umu config in the current directory.<br/>These configs are compatible with vanilla umu-launcher, although the DLL override functionality won't work. |\n| `run` | Runs a program using the umu config in the current directory. |\n\n### Installation/Usage\nAdd 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>`. \n\n### Return codes\n| Number | Name | Description |\n|:-------|:--------------------|:----------------------------------------------------------------|\n| 0 | `SUCCESS` | Program executed as intended. |\n| 1 | `DECODING_ERROR` | Failed to parse a file. |\n| 2 | `INVALID_SELECTION` | User selected an invalid verb or there are no valid selections. |\n",
"bugtrack_url": null,
"license": null,
"summary": "umu-commander is an interactive CLI tool to help you manage umu.",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://github.com/Mpaxlamitsounas/umu-commander",
"Issues": "https://github.com/Mpaxlamitsounas/umu-commander/issues"
},
"split_keywords": [
"umu",
" umu-launcher"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8541907d265eaf28a6db10b2a06da707985f348700c8feeffa8e736726d7df63",
"md5": "74ec40a0f2c04bf1b74922edff2b4fe0",
"sha256": "587927a4fa9bdfee3b0cd1571858ab13503abd793ba6486a752f6c22b5ebd167"
},
"downloads": -1,
"filename": "umu_commander-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74ec40a0f2c04bf1b74922edff2b4fe0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 11551,
"upload_time": "2025-08-09T09:12:29",
"upload_time_iso_8601": "2025-08-09T09:12:29.833902Z",
"url": "https://files.pythonhosted.org/packages/85/41/907d265eaf28a6db10b2a06da707985f348700c8feeffa8e736726d7df63/umu_commander-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "70fda7c55acaf3e1acb9f54860c9c57f942e286fd13ba3308c4d4aaf84042d3f",
"md5": "38d03a429bebbc99a6f2b96c30edbc9d",
"sha256": "f21bbc44bc201faa77f580f9821f721a9f924a64defc5d84bfcd0b17215217c2"
},
"downloads": -1,
"filename": "umu_commander-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "38d03a429bebbc99a6f2b96c30edbc9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 17592,
"upload_time": "2025-08-09T09:12:30",
"upload_time_iso_8601": "2025-08-09T09:12:30.931203Z",
"url": "https://files.pythonhosted.org/packages/70/fd/a7c55acaf3e1acb9f54860c9c57f942e286fd13ba3308c4d4aaf84042d3f/umu_commander-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-09 09:12:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mpaxlamitsounas",
"github_project": "umu-commander",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "umu-commander"
}
