pal-explorer-cli 0.4.12 → 0.4.14

package/lib/utils/help.js

@@ -1,357 +1,357 @@
-export const HelpRegistry = {
-  general: {
-    title: "Palexplorer",
-    description: "Decentralized P2P file sharing from the command line. Share files, folders, and drives directly with your pals — no cloud required."
-  },
-  commands: {
-    init: {
-      summary: "Create a new identity",
-      details: "Generates an Ed25519 keypair and a 24-word recovery phrase. Required before any other command.",
-      subcommands: {},
-      examples: [
-        "pe init alice",
-        "pe init bob --force"
-      ]
-    },
-    whoami: {
-      summary: "Display your current identity",
-      details: "Shows your name, handle, public key, device ID, and creation date.",
-      subcommands: {},
-      examples: [
-        "pe whoami"
-      ]
-    },
-    register: {
-      summary: "Register a handle on the discovery network",
-      details: "Claims a unique @handle via direct signature or email OTP verification.",
-      subcommands: {},
-      examples: [
-        "pe register alice",
-        "pe register alice --email a@b.com"
-      ]
-    },
-    verify: {
-      summary: "Complete OTP email verification",
-      details: "Finishes the email-based handle registration started by `pe register --email`.",
-      subcommands: {},
-      examples: [
-        "pe verify 123456"
-      ]
-    },
-    recover: {
-      summary: "Recover identity from mnemonic phrase",
-      details: "Restores your Ed25519 keypair from the 24-word BIP-39 phrase shown during `pe init`.",
-      subcommands: {},
-      examples: [
-        "pe recover word1 word2 ... word24",
-        "pe recover word1 word2 ... word24 -n alice"
-      ]
-    },
-    share: {
-      summary: "Share a file, folder, or drive via P2P",
-      details: "Adds a resource to your share list. Use `pe serve` to start seeding. Supports public (global) and private (encrypted) shares.",
-      subcommands: {},
-      options: {
-        "-v, --visibility <type>": "Share visibility: global or private (default: global)",
-        "-w, --with <pals...>": "Specific pals to share with",
-        "--with-group <group>": "Share with all members of a group"
-      },
-      examples: [
-        "pe share ./photos",
-        "pe share ./docs -v private -w alice",
-        "pe share ./project --with-group team",
-        "pe share ./file.zip"
-      ]
-    },
-    list: {
-      summary: "List shared resources",
-      details: "Shows all active shares with their visibility, ID, path, and type.",
-      subcommands: {},
-      options: {
-        "--by-drive": "Group shares by drive letter"
-      },
-      examples: [
-        "pe list",
-        "pe list --by-drive"
-      ]
-    },
-    revoke: {
-      summary: "Revoke access to a shared resource",
-      details: "Removes a share entirely, or removes a specific recipient and rotates encryption keys.",
-      subcommands: {},
-      options: {
-        "--pal <palId>": "Remove a specific pal (triggers key rotation)"
-      },
-      examples: [
-        "pe revoke abc123",
-        "pe revoke ./photos",
-        "pe revoke abc123 --pal alice"
-      ]
-    },
-    serve: {
-      summary: "Start the sharing daemon",
-      details: "Seeds all active shares via WebTorrent. Supports foreground, daemon, and web dashboard modes. Auto-resumes incomplete downloads.",
-      subcommands: {},
-      options: {
-        "--daemon": "Run as background daemon",
-        "--stop": "Stop a running daemon",
-        "--web": "Start web dashboard alongside seeder",
-        "--web-port <port>": "Web dashboard port (default: 8585)"
-      },
-      examples: [
-        "pe serve",
-        "pe serve --daemon",
-        "pe serve --stop",
-        "pe serve --web",
-        "pe serve --web --web-port 9090"
-      ]
-    },
-    download: {
-      summary: "Download a file from a magnet link",
-      details: "Downloads via WebTorrent. For private shares, provide the encrypted share key for automatic decryption.",
-      subcommands: {},
-      options: {
-        "--key <encryptedShareKey>": "Encrypted share key for private share decryption"
-      },
-      examples: [
-        'pe download "magnet:?xt=urn:btih:..."',
-        'pe download "magnet:?xt=..." --key abc123'
-      ]
-    },
-    pal: {
-      summary: "Manage your list of pals (friends)",
-      details: "Add pals by @handle, invite link, or raw public key. Remove pals with automatic key rotation for affected shares.",
-      subcommands: {
-        add: "Add a pal by @handle, invite link (pal://...), or public key",
-        list: "List all your pals",
-        remove: "Remove a pal (rotates affected share keys)"
-      },
-      examples: [
-        "pe pal add @alice",
-        "pe pal add pal://... bob",
-        "pe pal add abc123def456 carol",
-        "pe pal list",
-        "pe pal remove @alice"
-      ]
-    },
-    invite: {
-      summary: "Generate a magic invite link",
-      details: "Creates a pal:// link containing your public key, handle, and name. Share it with anyone to let them add you.",
-      subcommands: {},
-      options: {
-        "--qr": "Render the invite as a QR code in the terminal"
-      },
-      examples: [
-        "pe invite",
-        "pe invite --qr"
-      ]
-    },
-    nearby: {
-      summary: "Discover nearby pals on the LAN",
-      details: "Uses mDNS (Bonjour) to find other Palexplorer users on the local network.",
-      subcommands: {},
-      options: {
-        "--add": "Auto-add discovered pals",
-        "--time <seconds>": "Scan duration (default: 10)"
-      },
-      examples: [
-        "pe nearby",
-        "pe nearby --add",
-        "pe nearby --time 30"
-      ]
-    },
-    group: {
-      summary: "Manage sharing groups",
-      details: "Create named groups of pals for easy bulk sharing with `pe share --with-group`.",
-      subcommands: {
-        create: "Create a new group",
-        add: "Add a pal to a group",
-        remove: "Remove a pal from a group",
-        list: "List all groups and members",
-        delete: "Delete a group"
-      },
-      examples: [
-        "pe group create team",
-        "pe group add team @alice",
-        "pe group remove team @alice",
-        "pe group list",
-        "pe group delete team"
-      ]
-    },
-    sync: {
-      summary: "Sync a directory with a pal",
-      details: "Builds a file manifest and sends it to a pal via the discovery server. Supports one-time and continuous (watch) modes.",
-      subcommands: {},
-      options: {
-        "--watch": "Watch for changes and continuously sync",
-        "--list": "List all sync pairs",
-        "--remove <id>": "Remove a sync pair"
-      },
-      examples: [
-        "pe sync ./project @alice",
-        "pe sync --watch ./docs @bob",
-        "pe sync --list",
-        "pe sync --remove <id>"
-      ]
-    },
-    transfers: {
-      summary: "View and manage file transfers",
-      details: "Shows active and completed transfers. Supports pause, resume, and cancel operations.",
-      subcommands: {
-        cancel: "Remove a transfer from tracking",
-        pause: "Pause a transfer",
-        resume: "Resume a paused transfer"
-      },
-      options: {
-        "--history": "Show completed transfers"
-      },
-      examples: [
-        "pe transfers",
-        "pe transfers --history",
-        "pe transfers cancel <magnet>",
-        "pe transfers pause <magnet>",
-        "pe transfers resume <magnet>"
-      ]
-    },
-    config: {
-      summary: "View and manage configuration",
-      details: "Get, set, list, and reset configuration values like port, storage path, bandwidth cap, and discovery URL.",
-      subcommands: {
-        list: "Show all current settings and known keys",
-        get: "Get a single config value",
-        set: "Set a config value",
-        reset: "Clear all custom settings"
-      },
-      examples: [
-        "pe config list",
-        "pe config get theme",
-        "pe config set theme dark",
-        "pe config reset"
-      ]
-    },
-    device: {
-      summary: "View and manage this device",
-      details: "Rename your device, register it with the discovery server, or list all devices under a handle.",
-      subcommands: {
-        rename: "Set a unique name for this device",
-        register: "Register device with the discovery server",
-        list: "List all devices registered under a handle"
-      },
-      examples: [
-        "pe device",
-        "pe device list @alice",
-        'pe device rename "My Laptop"',
-        "pe device register alice"
-      ]
-    },
-    server: {
-      summary: "Provision and manage server nodes",
-      details: "Install pe serve as a system service, configure server parameters, register with discovery, and check status. Supports Windows (schtasks), Linux (systemd), and macOS (launchd).",
-      subcommands: {
-        install: "Install as a background service (cross-platform)",
-        config: "Set server-specific operational parameters",
-        register: "Register this server node with the discovery network",
-        status: "Check server health and network connectivity"
-      },
-      examples: [
-        "pe server install",
-        "pe server status",
-        "pe server config port 8080",
-        "pe server register mynode"
-      ]
-    },
-    explorer: {
-      summary: "Manage file manager integration",
-      details: "Adds or removes a 'Share with Pal' context menu entry in Windows Explorer, macOS Finder, or Linux Nautilus.",
-      subcommands: {
-        install: "Install context menu for your platform",
-        uninstall: "Remove context menu entry"
-      },
-      examples: [
-        "pe explorer install",
-        "pe explorer uninstall"
-      ]
-    },
-    status: {
-      summary: "Show system health dashboard",
-      details: "Displays identity, daemon status, active shares, transfers, and discovery server connectivity at a glance.",
-      subcommands: {},
-      examples: [
-        "pe status"
-      ]
-    },
-    log: {
-      summary: "View application logs",
-      details: "Shows recent log entries from ~/.pal/logs/pal.log. Supports filtering by level and real-time tailing.",
-      subcommands: {},
-      options: {
-        "--tail": "Follow new log entries in real-time",
-        "--level <level>": "Filter by level (debug/info/warn/error)",
-        "-n, --lines <count>": "Number of recent lines to show (default: 20)"
-      },
-      examples: [
-        "pe log",
-        "pe log --tail",
-        "pe log --level error",
-        "pe log -n 50"
-      ]
-    },
-    completion: {
-      summary: "Generate shell completion script",
-      details: "Outputs a completion script for bash or zsh. Source it in your shell profile for tab completion.",
-      subcommands: {},
-      options: {
-        "--shell <shell>": "Shell type: bash or zsh (default: bash)"
-      },
-      examples: [
-        "pe completion",
-        "pe completion --shell zsh",
-        "source <(pe completion)"
-      ]
-    },
-    web: {
-      summary: "Open the web dashboard",
-      details: "Opens the web dashboard in your default browser. Requires `pe serve --web` to be running first.",
-      subcommands: {},
-      options: {
-        "--port <port>": "Web dashboard port (default: 8585)",
-        "--url-only": "Just print the URL without opening browser"
-      },
-      examples: [
-        "pe web",
-        "pe web --url-only",
-        "pe web --port 9090"
-      ]
-    },
-    vfs: {
-      summary: "Manage the virtual filesystem drive",
-      details: "Mounts your shared files as a virtual drive letter via WebDAV. Requires WinFSP on Windows or FUSE on Linux/macOS.",
-      subcommands: {
-        mount: "Mount virtual drive (default P:)",
-        unmount: "Unmount virtual drive",
-        status: "Show mount status and listed shares"
-      },
-      examples: [
-        "pe vfs mount",
-        "pe vfs mount S",
-        "pe vfs unmount",
-        "pe vfs status"
-      ]
-    }
-  },
-  gui: {
-    transfers: "The Transfer Manager shows all active uploads (seeding) and downloads. You can pause or cancel transfers here.",
-    inbox: "View and accept share invitations from your pals. Clicking 'Download' will add the resource to your Transfers.",
-    pals: "Manage your social circle. Search for friends by their verified email handles."
-  }
-};
-
-export const getHelp = (topic) => {
-  const parts = topic.split('.');
-  let current = HelpRegistry;
-  for (const part of parts) {
-    if (current[part]) current = current[part];
-    else return null;
-  }
-  return current;
-};
+export const HelpRegistry = {
+  general: {
+    title: "Palexplorer",
+    description: "Decentralized P2P file sharing from the command line. Share files, folders, and drives directly with your pals — no cloud required."
+  },
+  commands: {
+    init: {
+      summary: "Create a new identity",
+      details: "Generates an Ed25519 keypair and a 24-word recovery phrase. Required before any other command.",
+      subcommands: {},
+      examples: [
+        "pal init alice",
+        "pal init bob --force"
+      ]
+    },
+    whoami: {
+      summary: "Display your current identity",
+      details: "Shows your name, handle, public key, device ID, and creation date.",
+      subcommands: {},
+      examples: [
+        "pal whoami"
+      ]
+    },
+    register: {
+      summary: "Register a handle on the discovery network",
+      details: "Claims a unique @handle via direct signature or email OTP verification.",
+      subcommands: {},
+      examples: [
+        "pal register alice",
+        "pal register alice --email a@b.com"
+      ]
+    },
+    verify: {
+      summary: "Complete OTP email verification",
+      details: "Finishes the email-based handle registration started by `pal register --email`.",
+      subcommands: {},
+      examples: [
+        "pal verify 123456"
+      ]
+    },
+    recover: {
+      summary: "Recover identity from mnemonic phrase",
+      details: "Restores your Ed25519 keypair from the 24-word BIP-39 phrase shown during `pal init`.",
+      subcommands: {},
+      examples: [
+        "pal recover word1 word2 ... word24",
+        "pal recover word1 word2 ... word24 -n alice"
+      ]
+    },
+    share: {
+      summary: "Share a file, folder, or drive via P2P",
+      details: "Adds a resource to your share list. Use `pal serve` to start seeding. Supports public (global) and private (encrypted) shares.",
+      subcommands: {},
+      options: {
+        "-v, --visibility <type>": "Share visibility: global or private (default: global)",
+        "-w, --with <pals...>": "Specific pals to share with",
+        "--with-group <group>": "Share with all members of a group"
+      },
+      examples: [
+        "pal share ./photos",
+        "pal share ./docs -v private -w alice",
+        "pal share ./project --with-group team",
+        "pal share ./file.zip"
+      ]
+    },
+    list: {
+      summary: "List shared resources",
+      details: "Shows all active shares with their visibility, ID, path, and type.",
+      subcommands: {},
+      options: {
+        "--by-drive": "Group shares by drive letter"
+      },
+      examples: [
+        "pal list",
+        "pal list --by-drive"
+      ]
+    },
+    revoke: {
+      summary: "Revoke access to a shared resource",
+      details: "Removes a share entirely, or removes a specific recipient and rotates encryption keys.",
+      subcommands: {},
+      options: {
+        "--pal <palId>": "Remove a specific pal (triggers key rotation)"
+      },
+      examples: [
+        "pal revoke abc123",
+        "pal revoke ./photos",
+        "pal revoke abc123 --pal alice"
+      ]
+    },
+    serve: {
+      summary: "Start the sharing daemon",
+      details: "Seeds all active shares via WebTorrent. Supports foreground, daemon, and web dashboard modes. Auto-resumes incomplete downloads.",
+      subcommands: {},
+      options: {
+        "--daemon": "Run as background daemon",
+        "--stop": "Stop a running daemon",
+        "--web": "Start web dashboard alongside seeder",
+        "--web-port <port>": "Web dashboard port (default: 8585)"
+      },
+      examples: [
+        "pal serve",
+        "pal serve --daemon",
+        "pal serve --stop",
+        "pal serve --web",
+        "pal serve --web --web-port 9090"
+      ]
+    },
+    download: {
+      summary: "Download a file from a magnet link",
+      details: "Downloads via WebTorrent. For private shares, provide the encrypted share key for automatic decryption.",
+      subcommands: {},
+      options: {
+        "--key <encryptedShareKey>": "Encrypted share key for private share decryption"
+      },
+      examples: [
+        'pal download "magnet:?xt=urn:btih:..."',
+        'pal download "magnet:?xt=..." --key abc123'
+      ]
+    },
+    pal: {
+      summary: "Manage your list of pals (friends)",
+      details: "Add pals by @handle, invite link, or raw public key. Remove pals with automatic key rotation for affected shares.",
+      subcommands: {
+        add: "Add a pal by @handle, invite link (pal://...), or public key",
+        list: "List all your pals",
+        remove: "Remove a pal (rotates affected share keys)"
+      },
+      examples: [
+        "pal pal add @alice",
+        "pal pal add pal://... bob",
+        "pal pal add abc123def456 carol",
+        "pal pal list",
+        "pal pal remove @alice"
+      ]
+    },
+    invite: {
+      summary: "Generate a magic invite link",
+      details: "Creates a pal:// link containing your public key, handle, and name. Share it with anyone to let them add you.",
+      subcommands: {},
+      options: {
+        "--qr": "Render the invite as a QR code in the terminal"
+      },
+      examples: [
+        "pal invite",
+        "pal invite --qr"
+      ]
+    },
+    nearby: {
+      summary: "Discover nearby pals on the LAN",
+      details: "Uses mDNS (Bonjour) to find other Palexplorer users on the local network.",
+      subcommands: {},
+      options: {
+        "--add": "Auto-add discovered pals",
+        "--time <seconds>": "Scan duration (default: 10)"
+      },
+      examples: [
+        "pal nearby",
+        "pal nearby --add",
+        "pal nearby --time 30"
+      ]
+    },
+    group: {
+      summary: "Manage sharing groups",
+      details: "Create named groups of pals for easy bulk sharing with `pal share --with-group`.",
+      subcommands: {
+        create: "Create a new group",
+        add: "Add a pal to a group",
+        remove: "Remove a pal from a group",
+        list: "List all groups and members",
+        delete: "Delete a group"
+      },
+      examples: [
+        "pal group create team",
+        "pal group add team @alice",
+        "pal group remove team @alice",
+        "pal group list",
+        "pal group delete team"
+      ]
+    },
+    sync: {
+      summary: "Sync a directory with a pal",
+      details: "Builds a file manifest and sends it to a pal via the discovery server. Supports one-time and continuous (watch) modes.",
+      subcommands: {},
+      options: {
+        "--watch": "Watch for changes and continuously sync",
+        "--list": "List all sync pairs",
+        "--remove <id>": "Remove a sync pair"
+      },
+      examples: [
+        "pal sync ./project @alice",
+        "pal sync --watch ./docs @bob",
+        "pal sync --list",
+        "pal sync --remove <id>"
+      ]
+    },
+    transfers: {
+      summary: "View and manage file transfers",
+      details: "Shows active and completed transfers. Supports pause, resume, and cancel operations.",
+      subcommands: {
+        cancel: "Remove a transfer from tracking",
+        pause: "Pause a transfer",
+        resume: "Resume a paused transfer"
+      },
+      options: {
+        "--history": "Show completed transfers"
+      },
+      examples: [
+        "pal transfers",
+        "pal transfers --history",
+        "pal transfers cancel <magnet>",
+        "pal transfers pause <magnet>",
+        "pal transfers resume <magnet>"
+      ]
+    },
+    config: {
+      summary: "View and manage configuration",
+      details: "Get, set, list, and reset configuration values like port, storage path, bandwidth cap, and discovery URL.",
+      subcommands: {
+        list: "Show all current settings and known keys",
+        get: "Get a single config value",
+        set: "Set a config value",
+        reset: "Clear all custom settings"
+      },
+      examples: [
+        "pal config list",
+        "pal config get theme",
+        "pal config set theme dark",
+        "pal config reset"
+      ]
+    },
+    device: {
+      summary: "View and manage this device",
+      details: "Rename your device, register it with the discovery server, or list all devices under a handle.",
+      subcommands: {
+        rename: "Set a unique name for this device",
+        register: "Register device with the discovery server",
+        list: "List all devices registered under a handle"
+      },
+      examples: [
+        "pal device",
+        "pal device list @alice",
+        'pal device rename "My Laptop"',
+        "pal device register alice"
+      ]
+    },
+    server: {
+      summary: "Provision and manage server nodes",
+      details: "Install pal serve as a system service, configure server parameters, register with discovery, and check status. Supports Windows (schtasks), Linux (systemd), and macOS (launchd).",
+      subcommands: {
+        install: "Install as a background service (cross-platform)",
+        config: "Set server-specific operational parameters",
+        register: "Register this server node with the discovery network",
+        status: "Check server health and network connectivity"
+      },
+      examples: [
+        "pal server install",
+        "pal server status",
+        "pal server config port 8080",
+        "pal server register mynode"
+      ]
+    },
+    explorer: {
+      summary: "Manage file manager integration",
+      details: "Adds or removes a 'Share with Pal' context menu entry in Windows Explorer, macOS Finder, or Linux Nautilus.",
+      subcommands: {
+        install: "Install context menu for your platform",
+        uninstall: "Remove context menu entry"
+      },
+      examples: [
+        "pal explorer install",
+        "pal explorer uninstall"
+      ]
+    },
+    status: {
+      summary: "Show system health dashboard",
+      details: "Displays identity, daemon status, active shares, transfers, and discovery server connectivity at a glance.",
+      subcommands: {},
+      examples: [
+        "pal status"
+      ]
+    },
+    log: {
+      summary: "View application logs",
+      details: "Shows recent log entries from ~/.pal/logs/pal.log. Supports filtering by level and real-time tailing.",
+      subcommands: {},
+      options: {
+        "--tail": "Follow new log entries in real-time",
+        "--level <level>": "Filter by level (debug/info/warn/error)",
+        "-n, --lines <count>": "Number of recent lines to show (default: 20)"
+      },
+      examples: [
+        "pal log",
+        "pal log --tail",
+        "pal log --level error",
+        "pal log -n 50"
+      ]
+    },
+    completion: {
+      summary: "Generate shell completion script",
+      details: "Outputs a completion script for bash or zsh. Source it in your shell profile for tab completion.",
+      subcommands: {},
+      options: {
+        "--shell <shell>": "Shell type: bash or zsh (default: bash)"
+      },
+      examples: [
+        "pal completion",
+        "pal completion --shell zsh",
+        "source <(pal completion)"
+      ]
+    },
+    web: {
+      summary: "Open the web dashboard",
+      details: "Opens the web dashboard in your default browser. Requires `pal serve --web` to be running first.",
+      subcommands: {},
+      options: {
+        "--port <port>": "Web dashboard port (default: 8585)",
+        "--url-only": "Just print the URL without opening browser"
+      },
+      examples: [
+        "pal web",
+        "pal web --url-only",
+        "pal web --port 9090"
+      ]
+    },
+    vfs: {
+      summary: "Manage the virtual filesystem drive",
+      details: "Mounts your shared files as a virtual drive letter via WebDAV. Requires WinFSP on Windows or FUSE on Linux/macOS.",
+      subcommands: {
+        mount: "Mount virtual drive (default P:)",
+        unmount: "Unmount virtual drive",
+        status: "Show mount status and listed shares"
+      },
+      examples: [
+        "pal vfs mount",
+        "pal vfs mount S",
+        "pal vfs unmount",
+        "pal vfs status"
+      ]
+    }
+  },
+  gui: {
+    transfers: "The Transfer Manager shows all active uploads (seeding) and downloads. You can pause or cancel transfers here.",
+    inbox: "View and accept share invitations from your pals. Clicking 'Download' will add the resource to your Transfers.",
+    pals: "Manage your social circle. Search for friends by their verified email handles."
+  }
+};
+
+export const getHelp = (topic) => {
+  const parts = topic.split('.');
+  let current = HelpRegistry;
+  for (const part of parts) {
+    if (current[part]) current = current[part];
+    else return null;
+  }
+  return current;
+};