summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcopilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>2026-02-04 14:08:50 +0000
committercopilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>2026-02-04 14:08:50 +0000
commita1164d396c54c8a7a3d17746b12c6e62816ed344 (patch)
tree47e9ce27bd46ec2c4ee57fa7dae21b5f63d8699d /README.md
parent06d1b194d4ce46524bc03628ecdf15fa2e135e5f (diff)
downloaddecky-installer-a1164d396c54c8a7a3d17746b12c6e62816ed344.tar.gz
decky-installer-a1164d396c54c8a7a3d17746b12c6e62816ed344.zip
Refactor CLI to use subcommands for better semantics
Co-authored-by: tranch <5999732+tranch@users.noreply.github.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md
index 53f0122..390f529 100644
--- a/README.md
+++ b/README.md
@@ -17,23 +17,38 @@ A local mirror version of the Decky Installer for Steam Deck. This repository al
2. Place the downloaded file in a convenient location on your Steam Deck.
3. Run the script or launch the desktop file to start the Decky Installer.
+### Command Structure
+
+The `decky_client.py` script uses subcommands for different operations:
+
+```bash
+# Install a plugin (default operation)
+python3 decky_client.py install [options]
+
+# Configure custom store URL
+python3 decky_client.py configure-store <url>
+
+# Get configured store URL
+python3 decky_client.py get-store
+```
+
### Custom Store Configuration
The installer now supports configuring custom plugin store URLs:
#### Configure a Custom Store URL
```bash
-python3 decky_client.py --configure-store "https://your-custom-store.com/plugins"
+python3 decky_client.py configure-store "https://your-custom-store.com/plugins"
```
#### Get the Currently Configured Store URL
```bash
-python3 decky_client.py --get-store
+python3 decky_client.py get-store
```
#### Install from a Custom Store
```bash
-python3 decky_client.py --target-id 42 --store-url "https://your-custom-store.com/plugins"
+python3 decky_client.py install --target-id 42 --store-url "https://your-custom-store.com/plugins"
```
## Mock Server for Testing
@@ -47,7 +62,7 @@ python3 mock_decky_server.py --auto-confirm
### Test with the Mock Server
```bash
-python3 decky_client.py --target-id 42
+python3 decky_client.py install --target-id 42
```
The mock server implements the following Decky Loader backend routes: