parrot-blackbox 1.0.1 → 1.0.2

package/README.md

@@ -110,8 +110,14 @@ and pending backups.
 ## Managing cloud accounts (rclone remotes)
 
 Every MEGA / Google Drive login becomes one rclone remote = one pool account.
-`parrot-blackbox` manages them for you — you never need to use the raw rclone
-menu except for advanced edits.
+There are **two ways** to connect them:
+
+- **Guided (recommended):** `parrot-blackbox` creates the rclone remote *for
+  you* — no menus. `parrot-blackbox remote add mega` prompts for the remote
+  name, email, password and optional 2FA, then registers it.
+- **Manual:** configure remote(s) yourself with the raw `rclone config` — the
+  **complete step-by-step walkthrough of every prompt and every letter is
+  documented below** in the next section.
 
 **Add** (guided — creates the remote AND saves it in the pool):
 ```bash
@@ -150,6 +156,249 @@ passwords, and the allocator's manifests are safe to share.
 
 ---
 
+## 📖 The full `rclone config` manual walkthrough (every letter, every prompt)
+
+> The wizard's *"Configure rclone myself, then register the remote"* path (and
+> the `parrot-blackbox remote config` command) open rclone's interactive menu.
+> This is that menu, explained **prompt by prompt** so you never get lost.
+> The quick alternative that skips all of this: `parrot-blackbox remote add mega`
+> (or `gdrive`) creates the remote for you automatically.
+
+### 1. The main menu — what each letter does
+
+```
+Current remotes:
+
+Name                 Type
+====                 ====
+mega                 mega
+
+e) Edit existing remote
+n) New remote
+d) Delete remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+e/n/d/r/c/s/q>
+```
+
+| Letter | Word | What it does |
+|---|---|---|
+| `e` | **Edit** | Change an **existing** remote's login (email / password / 2FA) or storage type |
+| `n` | **New** | **Create a brand-new remote** → the flow below |
+| `d` | **Delete** | Remove a remote from the config — rclone asks `y` to confirm |
+| `r` | **Rename** | Give an existing remote a different name |
+| `c` | **Copy** | Duplicate an existing remote under a new name (handy for a 2nd account of the same type) |
+| `s` | **Set config password** | Lock the whole `rclone.conf` with a passphrase (optional; skip unless you want it) |
+| `q` | **Quit** | Leave the menu → you return to parrot-blackbox |
+
+> **The letters you'll use most:** `n` (new remote), `e` (fix a wrong password),
+> `d` (remove an account you don't use), `q` (done).
+
+---
+
+### 2. Adding a MEGA remote (storage number **39**)
+
+Start the menu with `n`, then follow exactly:
+
+```
+e/n/d/r/c/s/q> n                          ⬅ type the letter n and press Enter
+Enter name for new remote.
+name> mega-account-1                       ⬅ type the remote name and press Enter
+```
+
+> **What the name is:** a label for this login. Use something meaningful per
+> account, e.g. `mega-account-1`, `mega-2`, `mega-main`. You'll type this exact
+> name into parrot-blackbox later.
+
+```
+Option Storage.
+Type of storage to configure.
+...long numbered list of 68 providers...
+Storage> 39                                ⬅ type 39 for Mega and press Enter
+```
+
+> **The storage number for each provider:**
+> | Provider | Number to type | (what it says in the list) |
+> |---|---|---|
+> | **Mega** (the one you use) | **`39`** | `39 / Mega - Tier 2 \ (mega)` |
+> | **Google Drive** | **`24`** | `24 / Google Drive - Tier 1 \ (drive)` |
+
+Next rclone asks for login details — this means **the email + password of the
+cloud account** you want to back up to:
+
+```
+Option user.
+User name.
+Enter a value.
+user> info.donartkins.ke@gmail.com         ⬅ type the account's EMAIL and press Enter
+
+Option pass.
+Password.
+Choose an alternative below.
+y) Yes, type in my own password
+g) Generate random password
+y/g> y                                     ⬅ type y to enter your own password
+
+Enter the password:
+password: ********                          ⬅ type the account PASSWORD (invisible)
+Confirm the password:
+password: ********                          ⬅ type it again to confirm
+```
+
+> **What this means:** `user` = the **email address** of your MEGA account.
+> `pass` = that account's **password**. rclone encrypts it before saving it —
+> you'll see `*** ENCRYPTED ***` later.
+
+After the password, optional but present for accounts that have it:
+
+```
+Option 2fa.
+The 2FA code of your MEGA account if the account is set up with one
+Enter a value. Press Enter to leave empty.
+2fa>                                     ⬅ if you use 2FA on this MEGA account, enter the
+                                              current 6-digit code here; if not, press Enter
+```
+---
+
+### 3. Advanced config — ⚠️ **SAY NO** (this is the mistake you kept making)
+
+rclone then asks `Edit advanced config?` **twice**. You almost always want
+**`n` (No)** here — parrot-blackbox works fine with the defaults:
+
+```
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n                                  ⬅ type n and press Enter   ✅ SAY NO
+```
+
+If you mistakenly choose `y`, rclone will march you through `debug`,
+`hard_delete`, `use_https`, `encoding`, `description`… — you can press **Enter**
+on every single one to accept defaults, then it asks `Edit advanced config?`
+again → answer `n` the second time. But the easy path is simply **`n` the
+first time**.
+
+When it finishes you get a confirmation:
+
+```
+Configuration complete.
+Options:
+- type: mega
+- user: info.donartkins.ke@gmail.com
+- pass: *** ENCRYPTED ***
+Keep this "mega-account-1" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y                                 ⬅ type y to save this remote
+```
+
+> **Important:** this confirmation `y` ("keep this remote") is DIFFERENT from
+> the advanced-config prompt. Here you DO want `y` — it saves the remote you
+> just created.
+
+---
+
+### 4. Adding a Google Drive remote (storage number **24**)
+
+Same `n` flow, but the two differences are the storage number and the auth step:
+
+```
+e/n/d/r/c/s/q> n                          ⬅ n for new
+name> gdrive-account-1                    ⬅ the remote name
+Storage> 24                               ⬅ 24 = Google Drive
+
+-- rclone then prints a big "Use auto config?" section --
+Use auto config?
+y) Yes
+n) No
+y/n> y                                    ⬅ y (opens your browser automatically)
+```
+
+rclone opens a **browser page asking you to sign in to Google** and grant
+access — log in, allow, done. Back in the terminal:
+
+```
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n                                    ⬅ ✅ NO
+
+Keep this "gdrive-account-1" remote?
+y) Yes this is OK (default)
+y/e/d> y                                  ⬅ y to keep it
+```
+
+> If the browser doesn't open (headless), choose the manual option rclone gives
+> you and paste the printed verification code into `http://localhost:53682` —
+> but on your desktop the browser usually just opens.
+
+---
+
+### 5. After you quit (`q`) — register the remotes
+
+You arrive back in parrot-blackbox with the message
+`Starting rclone config — follow its prompts, then come back.` Once rclone's
+menu is closed (`q`), the wizard automatically shows the remotes it found and
+lets you pick which to register into the pool:
+
+```
+Select which rclone remotes to add to the backup pool:   ⬅ tick your new names
+```
+
+Each one is then tagged with its provider as you type it into rclone. If you
+quit the wizard before registering, that's fine — either re-run
+`parrot-blackbox` or:
+
+```bash
+parrot-blackbox account add mega mega-account-1     # provider + the remote name you chose in rclone
+parrot-blackbox remote list                         # confirm it's now registered
+```
+
+---
+
+### 6. Editing / renaming / deleting a remote later (the `e` `r` `d` letters)
+
+Fix a wrong password, rename, or delete an old account:
+
+```
+e/n/d/r/c/s/q> e                             ⬅ e = Edit an existing remote
+Choose a number from below ...               ⬅ pick the remote to edit
+Edit remote
+u) Update current
+y) Yes type in my own password
+g) Generate random password
+q) Quit config
+u> y                                         ⬅ choose what to change (u = update this field)
+Name or type of remote > user                ⬅ which field: user, pass, 2fa, type, ...
+user> new@email.com                          ⬅ the new value
+```
+
+Rename:
+```
+e/n/d/r/c/s/q> r                             ⬅ r = Rename
+Old name> mega-account-1                     ⬅ current name
+New name> mega-backup-1                      ⬅ new name
+```
+
+Delete:
+```
+e/n/d/r/c/s/q> d                             ⬅ d = Delete
+Choose a number from below ...               ⬅ pick the remote
+y) Yes this is OK
+e) Edit this remote
+y/e> y                                       ⬅ y confirms permanent deletion
+```
+
+> Any rename/delete also must be mirrored in parrot-blackbox's pool:
+> `parrot-blackbox remote list` shows what's registered, and
+> `parrot-blackbox remote remove <name>` removes an entry from BOTH rclone and
+> the pool in one go.
+
+---
+
 ## Commands
 
 | Command | What it does |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parrot-blackbox",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "parrot-blackbox — crash-proof, multi-cloud backup & recovery automation for Parrot OS. Daily/weekly off-disk backups with automatic catch-up, smart storage across many MEGA + Google Drive accounts, Timeshift snapshot backups and one-command restore.",
   "type": "module",
   "main": "src/cli.js",