docs: add profiles command

jrson83 · Oct 31, 2023 · 717dea5 · 717dea5
1 parent 1e6cb03
commit 717dea5
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 7 deletions.
diff --git a/docs/src/cli/commands.md b/docs/src/cli/commands.md
@@ -83,7 +83,7 @@ savescum ftp --ip=192.168.178.69 test
 
 # outputs
 ℹ Running connection test ...
-✔ Connection succeeded
+✔ Connection established successfully.
 
 # or
 savescum ftp --ip=192.168.179.69 --port=21 --no-sound --debug test
@@ -92,7 +92,36 @@ savescum ftp --ip=192.168.179.69 --port=21 --no-sound --debug test
 ℹ Running connection test ...
   - Connecting to ftp://[email protected]:21
 
-✔ Connection succeeded
+✔ Connection established successfully.
+```
+:::
+
+---
+
+## `savescum ftp profiles`
+
+Lists PSN profiles/accounts from PS4/PS5 FTP server.
+
+### Usage
+
+```sh
+savescum ftp [options] profiles [options]
+```
+
+::: details Click to view usage example
+```sh
+savescum ftp --ip=192.168.178.69 profiles
+
+# outputs
+ℹ Getting profiles ...
+✔ Profiles operation completed successfully.
+
+ℹ Found 2 profiles:
+  ➜ ID: 1bexx117
+    Username: chiaki
+
+  ➜ ID: 1ceaa172
+    Username: AHunterMustHunt
 ```
 :::
 
@@ -119,7 +148,7 @@ backup --profile-id=1ceaa172 --cusa=CUSA00207 --sdimg=sdimg_SPRJ0005 --debug
   ├── Remote Path: /user/home/1ceaa172/savedata/CUSA00207/sdimg_SPRJ0005
   └── Local Path: C:\Users\jrson\savescum\1ceaa172\CUSA00207\1683605652684\sdimg_SPRJ0005
 
-✔ Backup completed
+✔ Backup operation completed successfully.
 ```
 :::
 
@@ -145,7 +174,7 @@ restore --profile-id=1ceaa172 --cusa=CUSA00207 --sdimg=sdimg_SPRJ0005 --debug
   ├── Local Path: C:\Users\jrson\savescum\1ceaa172\CUSA00207\1683605652684\sdimg_SPRJ0005
   └── Remote Path: /user/home/1ceaa172/savedata/CUSA00207/sdimg_SPRJ0005
 
-✔ Restore completed
+✔ Restore operation completed successfully.
 ```
 :::
 

diff --git a/docs/src/cli/index.md b/docs/src/cli/index.md
@@ -57,6 +57,6 @@ Global Options:
   -V, --version            output the version number
 
   Example:
-    $ savescum ftp --ip=192.168.179.69 test
-    $ savescum ftp --ip=192.168.179.69 --port=21 --no-sound --debug test
+    $ savescum ftp --ip=192.168.178.39 test
+    $ savescum ftp --ip=192.168.178.39 --port=21 --no-sound --debug test
 ```
diff --git a/docs/src/guide/index.md b/docs/src/guide/index.md
@@ -27,7 +27,7 @@ backup --profile-id=1ceaa172 --cusa=CUSA00207 --sdimg=sdimg_SPRJ0005 --debug
   ├── Remote Path: /user/home/1ceaa172/savedata/CUSA00207/sdimg_SPRJ0005
   └── Local Path: C:\Users\jrson\savescum\1ceaa172\CUSA00207\1683605652684\sdimg_SPRJ0005
 
-✔ Backup completed
+✔ Backup operation completed successfully.
 ```
 
 ## Webinterface