pal-explorer-cli 0.4.0

package/lib/commands/completion.js

@@ -0,0 +1,203 @@
+import chalk from 'chalk';
+
+const BASH_COMPLETION = `
+# pe bash completion
+_pe_completions() {
+  local cur="\${COMP_WORDS[COMP_CWORD]}"
+  local prev="\${COMP_WORDS[COMP_CWORD-1]}"
+
+  local commands="init whoami register recover share download list revoke serve pal invite nearby group sync transfers config device server explorer status log completion web gui-share vfs file remote user schedule chat backup api-keys share-link comment update auth network search connect protocol workspace favorite pin stream uninstall extension ext billing permissions org su federation analytics webhook relay compliance sso rbac scim audit scanner notify cloud-backup dept"
+
+  case "\$prev" in
+    pe)
+      COMPREPLY=( $(compgen -W "\$commands" -- "\$cur") )
+      ;;
+    pal)
+      COMPREPLY=( $(compgen -W "add list remove" -- "\$cur") )
+      ;;
+    group)
+      COMPREPLY=( $(compgen -W "create add remove delete list broadcast" -- "\$cur") )
+      ;;
+    sync)
+      COMPREPLY=( $(compgen -W "push pull status watch list remove diff" -- "\$cur") )
+      ;;
+    file)
+      COMPREPLY=( $(compgen -W "ls tree info copy move rename mkdir delete search open reveal audit" -- "\$cur") )
+      ;;
+    remote)
+      COMPREPLY=( $(compgen -W "browse files download" -- "\$cur") )
+      ;;
+    user)
+      COMPREPLY=( $(compgen -W "list add remove promote" -- "\$cur") )
+      ;;
+    chat)
+      COMPREPLY=( $(compgen -W "send history fetch" -- "\$cur") )
+      ;;
+    comment)
+      COMPREPLY=( $(compgen -W "list add delete" -- "\$cur") )
+      ;;
+    schedule)
+      COMPREPLY=( $(compgen -W "add cancel clear" -- "\$cur") )
+      ;;
+    backup)
+      COMPREPLY=( $(compgen -W "create restore" -- "\$cur") )
+      ;;
+    api-keys)
+      COMPREPLY=( $(compgen -W "create revoke" -- "\$cur") )
+      ;;
+    share-link)
+      COMPREPLY=( $(compgen -W "create list" -- "\$cur") )
+      ;;
+    vfs)
+      COMPREPLY=( $(compgen -W "mount unmount status" -- "\$cur") )
+      ;;
+    config)
+      COMPREPLY=( $(compgen -W "list get set reset" -- "\$cur") )
+      ;;
+    device)
+      COMPREPLY=( $(compgen -W "rename register list" -- "\$cur") )
+      ;;
+    server)
+      COMPREPLY=( $(compgen -W "install config register status add remove list set-primary" -- "\$cur") )
+      ;;
+    transfers)
+      COMPREPLY=( $(compgen -W "cancel pause resume stats" -- "\$cur") )
+      ;;
+    explorer)
+      COMPREPLY=( $(compgen -W "install uninstall" -- "\$cur") )
+      ;;
+    *)
+      COMPREPLY=()
+      ;;
+  esac
+}
+complete -F _pe_completions pe
+`;
+
+const ZSH_COMPLETION = `
+#compdef pe
+
+_pe() {
+  local -a commands subcommands
+
+  commands=(
+    'init:Initialize your identity'
+    'whoami:Display your current identity'
+    'register:Register a handle'
+    'verify:Verify OTP code'
+    'recover:Recover identity from mnemonic'
+    'share:Share a file or folder'
+    'list:List active shares'
+    'revoke:Revoke a share'
+    'serve:Start the sharing daemon'
+    'download:Download from magnet link'
+    'pal:Manage pals'
+    'invite:Generate invite link'
+    'nearby:Discover nearby peers'
+    'group:Manage groups'
+    'sync:Sync a directory with a pal'
+    'transfers:View and manage transfers'
+    'config:View and manage config'
+    'device:Manage devices'
+    'server:Manage headless server'
+    'explorer:Windows Explorer integration'
+    'vfs:Manage virtual filesystem drive'
+    'web:Open web dashboard'
+    'status:System health dashboard'
+    'log:View application logs'
+    'completion:Generate shell completion script'
+    'file:File operations with permissions'
+    'remote:Browse and download from pals'
+    'user:Manage user profiles'
+    'login:Switch active user profile'
+    'schedule:Manage scheduled tasks'
+    'chat:Encrypted chat messages'
+    'backup:Create and restore backups (Pro)'
+    'api-keys:Manage API keys (Pro)'
+    'share-link:Create web share links'
+    'comment:Manage comments on shares'
+    'update:Check for updates'
+    'auth:Authentication commands'
+    'network:Network management'
+    'search:Search files, pals, or groups'
+    'connect:Connect to a pal'
+    'protocol:PAL/1.0 protocol tools'
+    'workspace:Manage workspaces'
+    'favorite:Manage favorites'
+    'pin:Pin shares'
+    'stream:Media streaming'
+    'uninstall:Uninstall Palexplorer'
+    'extension:Manage extensions'
+    'ext:Manage extensions (alias)'
+    'billing:Billing and subscription'
+    'permissions:Manage permissions'
+    'org:Organization management'
+    'su:Switch user context'
+    'federation:Federation settings'
+    'analytics:Usage analytics'
+    'webhook:Manage webhooks'
+    'relay:TURN relay management'
+    'compliance:Compliance tools'
+    'sso:Single sign-on settings'
+    'rbac:Role-based access control'
+    'scim:SCIM provisioning'
+    'audit:Audit log'
+    'scanner:Security scanner'
+    'notify:Notification settings'
+    'cloud-backup:Cloud backup management'
+    'dept:Department management'
+  )
+
+  if (( CURRENT == 2 )); then
+    _describe 'command' commands
+  elif (( CURRENT == 3 )); then
+    case "\$words[2]" in
+      pal) subcommands=('add:Add a pal' 'list:List pals' 'remove:Remove a pal'); _describe 'subcommand' subcommands ;;
+      group) subcommands=('create:Create group' 'add:Add to group' 'remove:Remove from group' 'delete:Delete group' 'list:List groups' 'broadcast:Broadcast message'); _describe 'subcommand' subcommands ;;
+      sync) subcommands=('push:Push local changes' 'pull:Pull remote changes' 'status:Show sync status' 'watch:Watch and auto-push' 'list:List sync pairs' 'remove:Remove sync pair' 'diff:Compare folders'); _describe 'subcommand' subcommands ;;
+      vfs) subcommands=('mount:Mount virtual drive' 'unmount:Unmount drive' 'status:Show status'); _describe 'subcommand' subcommands ;;
+      config) subcommands=('list:Show settings' 'get:Get value' 'set:Set value' 'reset:Reset all'); _describe 'subcommand' subcommands ;;
+      device) subcommands=('rename:Rename device' 'register:Register device' 'list:List devices'); _describe 'subcommand' subcommands ;;
+      server) subcommands=('install:Install service' 'config:Configure' 'register:Register handle' 'status:Check health' 'add:Add server' 'remove:Remove server' 'list:List servers' 'set-primary:Set primary server'); _describe 'subcommand' subcommands ;;
+      transfers) subcommands=('cancel:Cancel transfer' 'pause:Pause transfer' 'resume:Resume transfer' 'stats:Show statistics'); _describe 'subcommand' subcommands ;;
+      explorer) subcommands=('install:Install integration' 'uninstall:Remove integration'); _describe 'subcommand' subcommands ;;
+      file) subcommands=('ls:List directory' 'tree:Show tree' 'info:File properties' 'copy:Copy file' 'move:Move file' 'rename:Rename file' 'mkdir:Create directory' 'delete:Delete file' 'search:Search files' 'open:Open file' 'reveal:Show in explorer' 'audit:Audit log'); _describe 'subcommand' subcommands ;;
+      remote) subcommands=('browse:List pal shares' 'files:List files in share' 'download:Download share'); _describe 'subcommand' subcommands ;;
+      user) subcommands=('list:List profiles' 'add:Add profile' 'remove:Remove profile' 'promote:Promote/demote'); _describe 'subcommand' subcommands ;;
+      chat) subcommands=('send:Send message' 'history:Show history' 'fetch:Fetch new messages'); _describe 'subcommand' subcommands ;;
+      comment) subcommands=('list:List comments' 'add:Add comment' 'delete:Delete comment'); _describe 'subcommand' subcommands ;;
+      schedule) subcommands=('add:Schedule task' 'cancel:Cancel task' 'clear:Clear old tasks'); _describe 'subcommand' subcommands ;;
+      backup) subcommands=('create:Create backup' 'restore:Restore backup'); _describe 'subcommand' subcommands ;;
+      api-keys) subcommands=('create:Create key' 'revoke:Revoke key'); _describe 'subcommand' subcommands ;;
+      share-link) subcommands=('create:Create link' 'list:List links'); _describe 'subcommand' subcommands ;;
+      update) subcommands=('check:Check for updates'); _describe 'subcommand' subcommands ;;
+    esac
+  fi
+}
+
+_pe
+`;
+
+export default function completionCommand(program) {
+  program
+    .command('completion')
+    .description('generate shell completion script')
+    .option('--shell <shell>', 'Shell type: bash or zsh', 'bash')
+    .addHelpText('after', `
+Examples:
+  $ pe completion                   Output bash completion script
+  $ pe completion --shell zsh       Output zsh completion script
+  $ source <(pe completion)         Activate completion in current shell
+`)
+    .action((opts) => {
+      if (opts.shell === 'zsh') {
+        console.log(ZSH_COMPLETION.trim());
+        console.log('');
+        console.log(chalk.gray('# Add to ~/.zshrc or save to a file in your fpath'));
+      } else {
+        console.log(BASH_COMPLETION.trim());
+        console.log('');
+        console.log(chalk.gray('# Add to ~/.bashrc or run: eval "$(pe completion)"'));
+      }
+    });
+}

package/lib/commands/compliance.js

@@ -0,0 +1,218 @@
+import chalk from 'chalk';
+
+const SUPPORTED_MODULES = [
+  'gdpr', 'hipaa', 'soc2', 'pci', 'financial', 'fedramp',
+  'cmmc', 'iso27001', 'dora', 'itar', 'ccpa', 'ferpa',
+];
+
+export default function complianceCommand(program) {
+  const cmd = program
+    .command('compliance')
+    .description('manage compliance modules (GDPR, HIPAA, etc.)')
+    .addHelpText('after', `
+Examples:
+  $ pe compliance status                     Show enabled compliance modules
+  $ pe compliance enable gdpr                Enable GDPR compliance
+  $ pe compliance disable hipaa              Disable HIPAA compliance
+  $ pe compliance consent grant <pubkey>     Record GDPR consent
+  $ pe compliance consent revoke <pubkey>    Revoke GDPR consent
+  $ pe compliance erasure <pubkey>           GDPR right to erasure
+  $ pe compliance export <pubkey>            GDPR data subject access request
+
+Supported modules: ${SUPPORTED_MODULES.join(', ')}
+`)
+    .action(() => {
+      cmd.outputHelp();
+    });
+
+  cmd
+    .command('status')
+    .description('show which compliance modules are enabled')
+    .action(async () => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const cfg = extConfig.get('ext.compliance') || {};
+        const enabled = cfg.enabledModules || [];
+
+        console.log('');
+        console.log(chalk.cyan.bold('Compliance Modules'));
+        console.log('');
+        for (const mod of SUPPORTED_MODULES) {
+          const active = enabled.includes(mod);
+          const icon = active ? chalk.green('●') : chalk.gray('○');
+          console.log(`  ${icon} ${active ? chalk.white(mod.toUpperCase()) : chalk.gray(mod.toUpperCase())}`);
+        }
+        console.log('');
+      } catch (err) {
+        console.log(chalk.red(`Failed to get status: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('enable <module>')
+    .description('enable a compliance module')
+    .action(async (mod) => {
+      try {
+        const module = mod.toLowerCase();
+        if (!SUPPORTED_MODULES.includes(module)) {
+          console.log(chalk.red(`Unknown module "${mod}". Supported: ${SUPPORTED_MODULES.join(', ')}`));
+          process.exitCode = 1;
+          return;
+        }
+
+        const extConfig = (await import('../utils/config.js')).default;
+        const cfg = extConfig.get('ext.compliance') || {};
+        const enabled = cfg.enabledModules || [];
+
+        if (enabled.includes(module)) {
+          console.log(chalk.yellow(`${module.toUpperCase()} is already enabled.`));
+          return;
+        }
+
+        enabled.push(module);
+        extConfig.set('ext.compliance', { ...cfg, enabledModules: enabled });
+        console.log(chalk.green(`✔ Enabled ${module.toUpperCase()} compliance module`));
+      } catch (err) {
+        console.log(chalk.red(`Failed to enable module: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('disable <module>')
+    .description('disable a compliance module')
+    .action(async (mod) => {
+      try {
+        const module = mod.toLowerCase();
+        if (!SUPPORTED_MODULES.includes(module)) {
+          console.log(chalk.red(`Unknown module "${mod}". Supported: ${SUPPORTED_MODULES.join(', ')}`));
+          process.exitCode = 1;
+          return;
+        }
+
+        const extConfig = (await import('../utils/config.js')).default;
+        const cfg = extConfig.get('ext.compliance') || {};
+        const enabled = cfg.enabledModules || [];
+
+        if (!enabled.includes(module)) {
+          console.log(chalk.yellow(`${module.toUpperCase()} is not enabled.`));
+          return;
+        }
+
+        extConfig.set('ext.compliance', {
+          ...cfg,
+          enabledModules: enabled.filter(m => m !== module),
+        });
+        console.log(chalk.green(`✔ Disabled ${module.toUpperCase()} compliance module`));
+      } catch (err) {
+        console.log(chalk.red(`Failed to disable module: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  const consent = cmd
+    .command('consent')
+    .description('manage GDPR consent records')
+    .action(() => {
+      consent.outputHelp();
+    });
+
+  consent
+    .command('grant <publicKey>')
+    .description('record GDPR consent for a user')
+    .action(async (publicKey) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.compliance-gdpr') || {};
+
+        store[`consent:${publicKey}`] = {
+          status: 'granted',
+          timestamp: new Date().toISOString(),
+        };
+        extConfig.set('ext_store.compliance-gdpr', store);
+
+        console.log(chalk.green(`✔ Consent granted for ${chalk.white(publicKey.slice(0, 16))}...`));
+      } catch (err) {
+        console.log(chalk.red(`Failed to grant consent: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  consent
+    .command('revoke <publicKey>')
+    .description('revoke GDPR consent for a user')
+    .action(async (publicKey) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.compliance-gdpr') || {};
+
+        store[`consent:${publicKey}`] = {
+          status: 'revoked',
+          timestamp: new Date().toISOString(),
+        };
+        extConfig.set('ext_store.compliance-gdpr', store);
+
+        console.log(chalk.green(`✔ Consent revoked for ${chalk.white(publicKey.slice(0, 16))}...`));
+      } catch (err) {
+        console.log(chalk.red(`Failed to revoke consent: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('erasure <publicKey>')
+    .description('GDPR right to erasure — mark user data for deletion')
+    .action(async (publicKey) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.compliance-gdpr') || {};
+
+        store[`erasure:${publicKey}`] = {
+          status: 'pending',
+          requestedAt: new Date().toISOString(),
+        };
+        store[`consent:${publicKey}`] = {
+          status: 'revoked',
+          timestamp: new Date().toISOString(),
+        };
+        extConfig.set('ext_store.compliance-gdpr', store);
+
+        console.log(chalk.green(`✔ Erasure request recorded for ${chalk.white(publicKey.slice(0, 16))}...`));
+        console.log(chalk.gray('  User data marked for deletion. Consent auto-revoked.'));
+      } catch (err) {
+        console.log(chalk.red(`Failed to record erasure: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('export <publicKey>')
+    .description('GDPR data subject access request — export user data')
+    .action(async (publicKey) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.compliance-gdpr') || {};
+
+        const consentRecord = store[`consent:${publicKey}`];
+        const erasureRecord = store[`erasure:${publicKey}`];
+
+        const exportData = {
+          publicKey,
+          exportedAt: new Date().toISOString(),
+          consent: consentRecord || null,
+          erasure: erasureRecord || null,
+        };
+
+        const filename = `gdpr-export-${publicKey.slice(0, 8)}-${Date.now()}.json`;
+        const fs = await import('fs');
+        fs.writeFileSync(filename, JSON.stringify(exportData, null, 2));
+
+        console.log(chalk.green(`✔ Data exported for ${chalk.white(publicKey.slice(0, 16))}...`));
+        console.log(`  File: ${chalk.white(filename)}`);
+      } catch (err) {
+        console.log(chalk.red(`Failed to export data: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+}

package/lib/commands/config.js

@@ -0,0 +1,136 @@
+import chalk from 'chalk';
+import config from '../utils/config.js';
+
+const KNOWN_KEYS = {
+  port: 'Local seeder port (default: auto)',
+  downloadDir: 'Download folder (default: ~/Downloads/Palexplorer)',
+  max_connections: 'Max P2P connections',
+  bandwidth_cap: 'Upload bandwidth cap in KB/s (0 = unlimited)',
+  bandwidth_up: 'Upload bandwidth limit in KB/s',
+  bandwidth_down: 'Download bandwidth limit in KB/s',
+  discovery_servers: 'Discovery server URLs (comma-separated list)',
+  announce_interval: 'DHT announce interval in seconds',
+  logLevel: 'Log level: debug, info, warn, error, silent',
+};
+
+export default function configCommand(program) {
+  const cmd = program
+    .command('config')
+    .description('view and manage Palexplorer configuration')
+    .addHelpText('after', `
+Examples:
+  $ pe config list                  Show all settings
+  $ pe config get theme             Get a specific setting
+  $ pe config set theme dark        Set a value
+  $ pe config reset theme           Reset to default
+`);
+
+  cmd
+    .command('list')
+    .description('show all current settings')
+    .action(() => {
+      const settings = config.get('settings') || {};
+      if (program.opts().json) {
+        console.log(JSON.stringify({ settings, knownKeys: KNOWN_KEYS }, null, 2));
+        return;
+      }
+      console.log('');
+      console.log(chalk.cyan('Current Settings:'));
+      const SENSITIVE_KEYS = new Set(['apiKey', 'api_key', 'token', 'secret', 'password', 'privateKey']);
+      if (Object.keys(settings).length === 0) {
+        console.log(chalk.gray('  (no custom settings — all defaults active)'));
+      } else {
+        for (const [k, v] of Object.entries(settings)) {
+          const desc = KNOWN_KEYS[k] ? chalk.gray(` — ${KNOWN_KEYS[k]}`) : '';
+          const display = SENSITIVE_KEYS.has(k) ? '***' : v;
+          console.log(`  ${chalk.white(k)} = ${chalk.yellow(display)}${desc}`);
+        }
+      }
+      console.log('');
+      console.log(chalk.gray('Known keys:'));
+      for (const [k, desc] of Object.entries(KNOWN_KEYS)) {
+        console.log(`  ${chalk.white(k.padEnd(22))} ${chalk.gray(desc)}`);
+      }
+    });
+
+  cmd
+    .command('get <key>')
+    .description('get a single config value')
+    .action((key) => {
+      const settings = config.get('settings') || {};
+      if (!(key in settings)) {
+        if (program.opts().json) {
+          console.log(JSON.stringify({ key, value: null, isDefault: true }, null, 2));
+          return;
+        }
+        console.log(chalk.gray(`'${key}' is not set (using default).`));
+        return;
+      }
+      if (program.opts().json) {
+        console.log(JSON.stringify({ key, value: settings[key] }, null, 2));
+        return;
+      }
+      console.log(`${key} = ${chalk.yellow(settings[key])}`);
+    });
+
+  cmd
+    .command('set <key> <value>')
+    .description('set a config value')
+    .action((key, value) => {
+      const DANGEROUS_KEYS = ['__proto__', 'constructor', 'prototype'];
+      if (!key || !key.trim()) {
+        console.log(chalk.red(`Rejected: config key cannot be empty.`));
+        process.exitCode = 1;
+        return;
+      }
+      const keyParts = key.split('.');
+      if (DANGEROUS_KEYS.some(d => keyParts.includes(d)) || key.startsWith('__')) {
+        console.log(chalk.red(`Rejected: '${key}' is not a valid config key.`));
+        process.exitCode = 1;
+        return;
+      }
+      if (!(key in KNOWN_KEYS)) {
+        console.log(chalk.yellow(`Warning: unknown config key '${key}'. Known keys: ${Object.keys(KNOWN_KEYS).join(', ')}`));
+      }
+      const settings = config.get('settings') || {};
+      settings[key] = value;
+      config.set('settings', settings);
+      console.log(chalk.green(`✔ ${key} = ${value}`));
+    });
+
+  cmd
+    .command('reset [key]')
+    .description('reset a single key or all settings to defaults')
+    .action((key) => {
+      if (key && key.trim()) {
+        const settings = config.get('settings') || {};
+        if (!(key in settings)) {
+          console.log(chalk.gray(`'${key}' is not set.`));
+          return;
+        }
+        delete settings[key];
+        config.set('settings', settings);
+        console.log(chalk.green(`✔ '${key}' reset to default.`));
+      } else {
+        config.set('settings', {});
+        console.log(chalk.green('✔ All settings reset to defaults.'));
+      }
+    });
+
+  // Running `pe config` without subcommand shows list
+  cmd.action(() => {
+    const settings = config.get('settings') || {};
+    console.log('');
+    console.log(chalk.cyan('Current Settings:'));
+    if (Object.keys(settings).length === 0) {
+      console.log(chalk.gray('  (no custom settings — all defaults active)'));
+    } else {
+      for (const [k, v] of Object.entries(settings)) {
+        console.log(`  ${chalk.white(k)} = ${chalk.yellow(v)}`);
+      }
+    }
+    console.log('');
+    console.log(chalk.gray('Use `pe config set <key> <value>` to change a setting.'));
+    console.log(chalk.gray('Use `pe config list` to see all known keys.'));
+  });
+}

package/lib/commands/connect.js

@@ -0,0 +1,44 @@
+import chalk from 'chalk';
+import { connect, disconnect, getConnectionState } from '../core/connectionManager.js';
+
+export default function connectCommand(program) {
+  program
+    .command('connect')
+    .description('connect to the Palexplorer network')
+    .action(async () => {
+      const current = getConnectionState();
+      if (current.status === 'connected') {
+        console.log(chalk.yellow('Already connected.'));
+        return;
+      }
+
+      console.log(chalk.blue('Connecting to Palexplorer network...'));
+      const result = await connect({
+        onProgress: (step, progress) => {
+          console.log(chalk.gray(`  [${progress}%] ${step}`));
+        },
+      });
+
+      if (result.connectedCount > 0) {
+        console.log(chalk.green(`\nConnected to ${result.connectedCount} server(s).`));
+      } else {
+        console.log(chalk.yellow('\nWarning: No servers reachable.'));
+        process.exitCode = 1;
+      }
+    });
+
+  program
+    .command('disconnect')
+    .description('disconnect from the Palexplorer network')
+    .action(async () => {
+      const current = getConnectionState();
+      if (current.status === 'disconnected') {
+        console.log(chalk.yellow('Already disconnected.'));
+        return;
+      }
+
+      console.log(chalk.blue('Disconnecting...'));
+      await disconnect();
+      console.log(chalk.green('Disconnected from network.'));
+    });
+}