From d1af672a85a67eabde693f76b133829c47f1e48f Mon Sep 17 00:00:00 2001 From: laz <thelazorne@protonmail.com> Date: Fri, 9 Aug 2024 09:16:35 +0200 Subject: [PATCH] cli commands --- .../wiki_development/general/cli-guide.md | 67 ++++++++++++++----- .../testing/cooker-testing.md | 12 ++-- 2 files changed, 59 insertions(+), 20 deletions(-) diff --git a/wiki-rtd/docs/wiki_development/general/cli-guide.md b/wiki-rtd/docs/wiki_development/general/cli-guide.md index 85d6647..75a2251 100644 --- a/wiki-rtd/docs/wiki_development/general/cli-guide.md +++ b/wiki-rtd/docs/wiki_development/general/cli-guide.md @@ -1,6 +1,8 @@ -# RetroDECK CLI Commmands +# RetroDECK CLI Commmands & Arguments -## How do I run RetroDECK CLI commands? +This page showcases many of the commands and arguments you can run via CLI. + +## How do I run RetroDECK CLI arguments? Open a Linux terminal on your desktop (on the Steam Deck you need to be in desktop mode). Depending on what terminal application you have installed the naming of the application can be different.<br> @@ -24,7 +26,7 @@ flatpak run net.retrodeck-retrodeck --reset-all Where the argument `--reset-all` replaced `[ARGUMENTS]` and `[FLATPAK-RUN-OPTION]`was not needed to it was removed. -## CLI argument list +### General CLI argument list `-h` or `--help` - Prints all the available arguments. @@ -40,34 +42,69 @@ Where the argument `--reset-all` replaced `[ARGUMENTS]` and `[FLATPAK-RUN-OPTION `--reset-retrodeck` - Resets the entirety of RetroDECK to default settings! -## General flatpak commands -<br> -Here follows some general flatpak commands that could be useful: <br> +## Other commands - -## Install RetroDECK from CLI +### Install RetroDECK from CLI If you want to install RetroDECK from CLI type: + +**Install as a user app:** + ``` -flatpak install Flathub net.retrodeck.retrodeck +flatpak install --user -y net.retrodeck.retrodeck +``` + +**Install as a system app:** + + +``` +flatpak install --system -y net.retrodeck.retrodeck +``` + +### Uninstall RetroDECK from CLI + +If you want to uninstall RetroDECK from CLI type: + +``` +flatpak remove -y net.retrodeck.retrodeck ``` ### Update all flatpaks from CLI -If you want to update all installed flatpaks from CLI type:<br> +If you want to update all installed flatpaks from CLI type: + ``` -flatpak update +flatpak update -y ``` -Then answer `y` on the input prompt. ### Update only RetroDECK from CLI -If you just want to update RetroDECK type: <br> +If you just want to update RetroDECK type: ``` -flatpak update net.retrodeck.retrodeck +flatpak update net.retrodeck.retrodeck -y ``` -Then answer `y` on the input prompt. +## Development CLI Arguments + +**Note:** that these arguments are for development and testing only and should not be used by a normal user. + +`--test-upgrade <version>` - Post-update test command for cooker builds and debugging. Should not be used + +`uuddlrlrstart` - Enables the `Developer Options Menu` and `Experimental Features` + +### Post-update test command + +If you want to trigger the upgrade script again between a version upgrade to try something out. + +Do the following command + +`flatpak run net.retrodeck.retrodeck --test-upgrade <version>` + +Example: + +`flatpak run net.retrodeck.retrodeck --test-upgrade 0.8.0b` + +This will trigger all the post-updates from `0.8.0b` to the current version you got installed. diff --git a/wiki-rtd/docs/wiki_development/testing/cooker-testing.md b/wiki-rtd/docs/wiki_development/testing/cooker-testing.md index dfdcbf0..9c99366 100644 --- a/wiki-rtd/docs/wiki_development/testing/cooker-testing.md +++ b/wiki-rtd/docs/wiki_development/testing/cooker-testing.md @@ -72,14 +72,16 @@ All logs will be saved in the new `retrodeck/logs` folder Thank you! ❤️ -## Trigger post-update manually +## T.I.P: Trigger post-update manually If you want to trigger the upgrade script again between a version upgrade to try something out. -Go to and edit the cfg file: +Do the following command -`~/.var/app/net.retrodeck.retrodeck/config/retrodeck/retrodeck.cfg` +`flatpak run net.retrodeck.retrodeck --test-upgrade <version>` -Find the `version=` value and change it to an older versions value and press save. +Example: -Next time you start RetroDECK the post-update should trigger again. +`flatpak run net.retrodeck.retrodeck --test-upgrade 0.8.0b` + +This will trigger all the post-updates from `0.8.0b` to the current version you got installed.