pal-explorer-cli 0.4.11 → 0.4.13

package/extensions/@palexplorer/share-links/extension.json

@@ -13,5 +13,20 @@
     ]
   },
   "config": { "enabled": { "type": "boolean", "default": false } },
+  "help": {
+    "summary": "Generate shareable download links for your shares. Links can be password-protected, set to expire after a date, or limited by download count (Pro).",
+    "usage": "pal share-link create <share-id>",
+    "examples": [
+      "pal share-link create abc123",
+      "pal share-link create abc123 --password secret --expires 2026-04-01",
+      "pal share-link create abc123 --max-downloads 10",
+      "pal share-link list abc123",
+      "pal share-link revoke <link-id>"
+    ],
+    "configReference": {
+      "enabled": "Enable or disable the share links feature (true/false)"
+    },
+    "links": {}
+  },
   "tier": "free"
 }

package/extensions/@palexplorer/sync/extension.json

@@ -13,5 +13,21 @@
     ]
   },
   "config": { "enabled": { "type": "boolean", "default": false } },
+  "help": {
+    "summary": "Manifest-based delta sync — only changed files are transferred. Push local changes, pull remote changes, or watch for auto-sync in real-time.",
+    "usage": "pal sync push <folder> <share-id>",
+    "examples": [
+      "pal sync push ./my-project abc123",
+      "pal sync pull abc123 ./local-copy",
+      "pal sync watch ./my-project abc123",
+      "pal sync diff abc123",
+      "pal sync list",
+      "pal sync resolve abc123 conflicted-file.txt keep_local"
+    ],
+    "configReference": {
+      "enabled": "Enable or disable the sync feature (true/false)"
+    },
+    "links": {}
+  },
   "tier": "free"
 }

package/extensions/@palexplorer/user-mgmt/extension.json

@@ -13,5 +13,20 @@
     ]
   },
   "config": { "enabled": { "type": "boolean", "default": false } },
+  "help": {
+    "summary": "Add multiple users to a single Palexplorer instance. Assign roles (owner/user/guest) to control who can create shares, manage settings, and view activity.",
+    "usage": "pal user add <username>",
+    "examples": [
+      "pal user add alice",
+      "pal user list",
+      "pal user promote alice owner",
+      "pal user remove bob",
+      "pal su alice"
+    ],
+    "configReference": {
+      "enabled": "Enable or disable multi-user management (true/false)"
+    },
+    "links": {}
+  },
   "tier": "free"
 }

package/lib/capabilities.js

@@ -16,7 +16,7 @@ export const CAPABILITIES = {
       maxDownloads: { type: 'number', label: 'Max downloads', min: 1 },
       nonRecursive: { type: 'boolean', label: 'Top-level files only', default: false },
     },
-    cli: 'pe share <path>',
+    cli: 'pal share <path>',
     gui: 'ShareModal',
     tier: 'free',
   },
@@ -24,7 +24,7 @@ export const CAPABILITIES = {
     label: 'Revoke Share',
     description: 'Remove access to a shared file',
     category: 'shares',
-    cli: 'pe revoke <shareId>',
+    cli: 'pal revoke <shareId>',
     gui: 'ShareExplorer (context menu)',
     tier: 'free',
   },
@@ -32,7 +32,7 @@ export const CAPABILITIES = {
     label: 'List Shares',
     description: 'View all active shares',
     category: 'shares',
-    cli: 'pe list',
+    cli: 'pal list',
     gui: 'ShareExplorer',
     tier: 'free',
   },
@@ -45,7 +45,7 @@ export const CAPABILITIES = {
       password: { type: 'string', label: 'Link password' },
       maxDownloads: { type: 'number', label: 'Max downloads', min: 1 },
     },
-    cli: 'pe share-link create',
+    cli: 'pal share-link create',
     gui: 'ShareLinksPage',
     tier: 'free',
   },
@@ -55,7 +55,7 @@ export const CAPABILITIES = {
     label: 'Download',
     description: 'Download from a magnet link or share',
     category: 'transfers',
-    cli: 'pe download <magnet>',
+    cli: 'pal download <magnet>',
     gui: 'TransfersPage (drag & drop or command palette)',
     tier: 'free',
   },
@@ -68,7 +68,7 @@ export const CAPABILITIES = {
     options: {
       method: { type: 'enum', values: ['handle', 'publicKey', 'inviteLink'], label: 'Add method' },
     },
-    cli: 'pe pal add <identifier>',
+    cli: 'pal pal add <identifier>',
     gui: 'AddPalModal',
     tier: 'free',
     gaps: ['GUI does not support invite link method'],
@@ -76,14 +76,14 @@ export const CAPABILITIES = {
   'pal.remove': {
     label: 'Remove Pal',
     category: 'people',
-    cli: 'pe pal remove <handle>',
+    cli: 'pal pal remove <handle>',
     gui: 'PalsPage (context menu)',
     tier: 'free',
   },
   'pal.list': {
     label: 'List Pals',
     category: 'people',
-    cli: 'pe pal list',
+    cli: 'pal pal list',
     gui: 'PalsPage',
     tier: 'free',
   },
@@ -92,14 +92,14 @@ export const CAPABILITIES = {
   'group.create': {
     label: 'Create Group',
     category: 'people',
-    cli: 'pe group create <name>',
+    cli: 'pal group create <name>',
     gui: 'GroupModal',
     tier: 'free',
   },
   'group.list': {
     label: 'List Groups',
     category: 'people',
-    cli: 'pe group list',
+    cli: 'pal group list',
     gui: 'GroupsPage',
     tier: 'free',
   },
@@ -112,7 +112,7 @@ export const CAPABILITIES = {
     options: {
       watch: { type: 'boolean', label: 'Watch for changes', default: false },
     },
-    cli: 'pe sync push <dir> <pal>',
+    cli: 'pal sync push <dir> <pal>',
     gui: 'SyncPage',
     tier: 'free',
   },
@@ -120,7 +120,7 @@ export const CAPABILITIES = {
     label: 'Pull Sync',
     description: 'Pull a directory from a pal',
     category: 'transfers',
-    cli: 'pe sync pull <dir> <pal>',
+    cli: 'pal sync pull <dir> <pal>',
     gui: 'SyncPage',
     tier: 'free',
   },
@@ -129,7 +129,7 @@ export const CAPABILITIES = {
   'chat.send': {
     label: 'Send Message',
     category: 'social',
-    cli: 'pe chat send <pal> <message>',
+    cli: 'pal chat send <pal> <message>',
     gui: 'ChatPage',
     tier: 'free',
   },
@@ -142,7 +142,7 @@ export const CAPABILITIES = {
     options: {
       qr: { type: 'boolean', label: 'Generate QR code' },
     },
-    cli: 'pe invite --qr',
+    cli: 'pal invite --qr',
     gui: null,
     tier: 'free',
     gaps: ['No QR generation in GUI'],
@@ -153,7 +153,7 @@ export const CAPABILITIES = {
     label: 'Browse Remote Pal',
     description: 'Browse files on a remote pal',
     category: 'shares',
-    cli: 'pe remote browse <pal>',
+    cli: 'pal remote browse <pal>',
     gui: 'RemoteBrowser (not linked from nav)',
     tier: 'free',
     gaps: ['RemoteBrowser exists but not accessible from nav'],
@@ -164,7 +164,7 @@ export const CAPABILITIES = {
     label: 'Start Stream',
     description: 'Stream media from a share',
     category: 'transfers',
-    cli: 'pe stream <shareId>',
+    cli: 'pal stream <shareId>',
     gui: 'StreamPage',
     tier: 'pro',
   },
@@ -173,14 +173,14 @@ export const CAPABILITIES = {
   'identity.init': {
     label: 'Create Identity',
     category: 'system',
-    cli: 'pe init <name>',
+    cli: 'pal init <name>',
     gui: 'SetupWizard',
     tier: 'free',
   },
   'identity.register': {
     label: 'Register Handle',
     category: 'system',
-    cli: 'pe register <handle>',
+    cli: 'pal register <handle>',
     gui: 'SettingsPage',
     tier: 'free',
   },
@@ -188,7 +188,7 @@ export const CAPABILITIES = {
     label: 'Recover Identity',
     description: 'Restore from recovery phrase',
     category: 'system',
-    cli: 'pe recover',
+    cli: 'pal recover',
     gui: null,
     tier: 'free',
     gaps: ['No recovery phrase restore flow in GUI'],
@@ -198,7 +198,7 @@ export const CAPABILITIES = {
   'device.list': {
     label: 'List Devices',
     category: 'system',
-    cli: 'pe device list',
+    cli: 'pal device list',
     gui: 'SettingsPage (partial)',
     tier: 'free',
     gaps: ['No dedicated device management page'],
@@ -208,7 +208,7 @@ export const CAPABILITIES = {
   'billing.status': {
     label: 'Billing Status',
     category: 'system',
-    cli: 'pe billing status',
+    cli: 'pal billing status',
     gui: 'SettingsPage (partial)',
     tier: 'pro',
   },
@@ -217,7 +217,7 @@ export const CAPABILITIES = {
   'extension.install': {
     label: 'Install Extension',
     category: 'system',
-    cli: 'pe extension install <name>',
+    cli: 'pal extension install <name>',
     gui: 'ExtensionsPage',
     tier: 'free',
   },
@@ -226,7 +226,7 @@ export const CAPABILITIES = {
   'favorite.add': {
     label: 'Favorite Share',
     category: 'shares',
-    cli: 'pe favorite add <shareId>',
+    cli: 'pal favorite add <shareId>',
     gui: 'SharesPage (star UI, no filter view)',
     tier: 'free',
     gaps: ['No dedicated favorites view/filter'],
@@ -237,7 +237,7 @@ export const CAPABILITIES = {
     label: 'Search',
     description: 'Search files, shares, and pals',
     category: 'shares',
-    cli: 'pe search <query>',
+    cli: 'pal search <query>',
     gui: 'SearchPage + top bar search',
     tier: 'free',
   },

package/lib/commands/analytics.js

@@ -1,175 +1,175 @@
-import chalk from 'chalk';
-
-export default function analyticsCommand(program) {
-  const cmd = program
-    .command('analytics')
-    .description('transfer analytics and reporting (Pro)')
-    .addHelpText('after', `
-Examples:
-  $ pe analytics metrics                 Show transfer metrics (default: week)
-  $ pe analytics metrics --period month  Monthly metrics
-  $ pe analytics report --format csv     Generate CSV report
-  $ pe analytics top-shares              Show most downloaded shares
-  $ pe analytics storage-trends          Show 30-day storage trends
-  $ pe analytics dashboard               Open web dashboard
-`)
-    .action(() => { cmd.outputHelp(); });
-
-  cmd
-    .command('metrics')
-    .description('show transfer metrics')
-    .option('--period <period>', 'time period: day, week, month', 'week')
-    .action(async (opts) => {
-      try {
-        const extConfig = (await import('../utils/config.js')).default;
-        const store = extConfig.get('ext_store.reporting-dashboard') || {};
-        const metrics = store.reportingMetrics || {};
-        const periodMs = { day: 86400000, week: 604800000, month: 2592000000 };
-        const cutoff = Date.now() - (periodMs[opts.period] || periodMs.week);
-        const transfers = (metrics.transfers || []).filter(t => new Date(t.timestamp).getTime() > cutoff);
-
-        console.log(chalk.bold(`Transfer Metrics (${opts.period})\n`));
-        console.log(`  Total transfers:  ${chalk.white(transfers.length)}`);
-        const totalBytes = transfers.reduce((sum, t) => sum + (t.bytes || 0), 0);
-        console.log(`  Total data:       ${chalk.white(formatBytes(totalBytes))}`);
-        const avgSpeed = transfers.length > 0 ? totalBytes / transfers.reduce((sum, t) => sum + (t.duration || 1), 0) : 0;
-        console.log(`  Avg speed:        ${chalk.white(formatBytes(avgSpeed) + '/s')}`);
-        console.log(`  Shares created:   ${chalk.white((metrics.sharesCreated || []).filter(s => new Date(s.timestamp).getTime() > cutoff).length)}`);
-      } catch (err) {
-        console.log(chalk.red(`Failed to get metrics: ${err.message}`));
-        process.exitCode = 1;
-      }
-    });
-
-  cmd
-    .command('report')
-    .description('generate a transfer report')
-    .option('--format <format>', 'output format: json, csv, pdf', 'json')
-    .option('-o, --output <path>', 'output file path')
-    .action(async (opts) => {
-      try {
-        const fs = await import('fs');
-        const path = await import('path');
-        const extConfig = (await import('../utils/config.js')).default;
-        const store = extConfig.get('ext_store.reporting-dashboard') || {};
-        const metrics = store.reportingMetrics || {};
-
-        const data = {
-          generatedAt: new Date().toISOString(),
-          format: opts.format,
-          transfers: metrics.transfers || [],
-          sharesCreated: metrics.sharesCreated || [],
-        };
-
-        let content;
-        if (opts.format === 'csv') {
-          const rows = (data.transfers || []).map(t => `${t.timestamp},${t.bytes},${t.duration},${t.peer || ''}`);
-          content = 'timestamp,bytes,duration,peer\n' + rows.join('\n');
-        } else {
-          content = JSON.stringify(data, null, 2);
-        }
-
-        const outPath = opts.output || `palexplorer-report-${new Date().toISOString().slice(0, 10)}.${opts.format}`;
-        const resolved = path.resolve(outPath);
-        fs.writeFileSync(resolved, content, 'utf8');
-        console.log(chalk.green(`✔ Report generated: ${resolved}`));
-      } catch (err) {
-        console.log(chalk.red(`Report failed: ${err.message}`));
-        process.exitCode = 1;
-      }
-    });
-
-  cmd
-    .command('top-shares')
-    .description('show most downloaded shares')
-    .option('--limit <n>', 'number of shares to show', '10')
-    .action(async (opts) => {
-      try {
-        const extConfig = (await import('../utils/config.js')).default;
-        const store = extConfig.get('ext_store.reporting-dashboard') || {};
-        const metrics = store.reportingMetrics || {};
-        const shares = metrics.topShares || [];
-        const limit = parseInt(opts.limit, 10) || 10;
-
-        if (shares.length === 0) {
-          console.log(chalk.dim('No share data available yet.'));
-          return;
-        }
-
-        console.log(chalk.bold(`Top ${Math.min(limit, shares.length)} Shares\n`));
-        const sorted = shares.sort((a, b) => (b.downloads || 0) - (a.downloads || 0)).slice(0, limit);
-        for (let i = 0; i < sorted.length; i++) {
-          console.log(`  ${chalk.dim(`${i + 1}.`)} ${chalk.cyan(sorted[i].name)} — ${chalk.white(sorted[i].downloads || 0)} downloads`);
-        }
-      } catch (err) {
-        console.log(chalk.red(`Failed: ${err.message}`));
-        process.exitCode = 1;
-      }
-    });
-
-  cmd
-    .command('storage-trends')
-    .description('show 30-day storage usage trends')
-    .option('--days <n>', 'number of days', '30')
-    .action(async (opts) => {
-      try {
-        const extConfig = (await import('../utils/config.js')).default;
-        const store = extConfig.get('ext_store.reporting-dashboard') || {};
-        const metrics = store.reportingMetrics || {};
-        const trends = metrics.storageTrends || {};
-        const days = parseInt(opts.days, 10) || 30;
-
-        const entries = Object.entries(trends).sort().slice(-days);
-        if (entries.length === 0) {
-          console.log(chalk.dim('No storage trend data available yet.'));
-          return;
-        }
-
-        console.log(chalk.bold(`Storage Trends (last ${entries.length} days)\n`));
-        for (const [date, bytes] of entries) {
-          console.log(`  ${chalk.dim(date)} ${chalk.white(formatBytes(bytes))}`);
-        }
-      } catch (err) {
-        console.log(chalk.red(`Failed: ${err.message}`));
-        process.exitCode = 1;
-      }
-    });
-
-  cmd
-    .command('dashboard')
-    .description('open the analytics web dashboard')
-    .action(async () => {
-      try {
-        const extConfig = (await import('../utils/config.js')).default;
-        const extConf = extConfig.get('ext.reporting-dashboard') || {};
-        const port = extConf.dashboardPort;
-        if (!port) {
-          console.log(chalk.yellow('Dashboard port not configured. Set it with:'));
-          console.log(chalk.dim('  pe ext config reporting-dashboard dashboardPort 9090'));
-          process.exitCode = 1;
-          return;
-        }
-        const portNum = parseInt(port, 10);
-        if (!Number.isInteger(portNum) || portNum < 1 || portNum > 65535) {
-          console.error('Invalid analytics port');
-          return;
-        }
-        const url = `http://127.0.0.1:${portNum}`;
-        console.log(chalk.green(`Dashboard: ${chalk.cyan(url)}`));
-        const { exec } = await import('child_process');
-        const opener = process.platform === 'win32' ? 'start' : process.platform === 'darwin' ? 'open' : 'xdg-open';
-        exec(`${opener} ${url}`);
-      } catch (err) {
-        console.log(chalk.red(`Failed: ${err.message}`));
-        process.exitCode = 1;
-      }
-    });
-}
-
-function formatBytes(bytes) {
-  if (bytes === 0) return '0 B';
-  const k = 1024;
-  const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
-}
+import chalk from 'chalk';
+
+export default function analyticsCommand(program) {
+  const cmd = program
+    .command('analytics')
+    .description('transfer analytics and reporting (Pro)')
+    .addHelpText('after', `
+Examples:
+  $ pal analytics metrics                 Show transfer metrics (default: week)
+  $ pal analytics metrics --period month  Monthly metrics
+  $ pal analytics report --format csv     Generate CSV report
+  $ pal analytics top-shares              Show most downloaded shares
+  $ pal analytics storage-trends          Show 30-day storage trends
+  $ pal analytics dashboard               Open web dashboard
+`)
+    .action(() => { cmd.outputHelp(); });
+
+  cmd
+    .command('metrics')
+    .description('show transfer metrics')
+    .option('--period <period>', 'time period: day, week, month', 'week')
+    .action(async (opts) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.reporting-dashboard') || {};
+        const metrics = store.reportingMetrics || {};
+        const periodMs = { day: 86400000, week: 604800000, month: 2592000000 };
+        const cutoff = Date.now() - (periodMs[opts.period] || periodMs.week);
+        const transfers = (metrics.transfers || []).filter(t => new Date(t.timestamp).getTime() > cutoff);
+
+        console.log(chalk.bold(`Transfer Metrics (${opts.period})\n`));
+        console.log(`  Total transfers:  ${chalk.white(transfers.length)}`);
+        const totalBytes = transfers.reduce((sum, t) => sum + (t.bytes || 0), 0);
+        console.log(`  Total data:       ${chalk.white(formatBytes(totalBytes))}`);
+        const avgSpeed = transfers.length > 0 ? totalBytes / transfers.reduce((sum, t) => sum + (t.duration || 1), 0) : 0;
+        console.log(`  Avg speed:        ${chalk.white(formatBytes(avgSpeed) + '/s')}`);
+        console.log(`  Shares created:   ${chalk.white((metrics.sharesCreated || []).filter(s => new Date(s.timestamp).getTime() > cutoff).length)}`);
+      } catch (err) {
+        console.log(chalk.red(`Failed to get metrics: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('report')
+    .description('generate a transfer report')
+    .option('--format <format>', 'output format: json, csv, pdf', 'json')
+    .option('-o, --output <path>', 'output file path')
+    .action(async (opts) => {
+      try {
+        const fs = await import('fs');
+        const path = await import('path');
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.reporting-dashboard') || {};
+        const metrics = store.reportingMetrics || {};
+
+        const data = {
+          generatedAt: new Date().toISOString(),
+          format: opts.format,
+          transfers: metrics.transfers || [],
+          sharesCreated: metrics.sharesCreated || [],
+        };
+
+        let content;
+        if (opts.format === 'csv') {
+          const rows = (data.transfers || []).map(t => `${t.timestamp},${t.bytes},${t.duration},${t.peer || ''}`);
+          content = 'timestamp,bytes,duration,peer\n' + rows.join('\n');
+        } else {
+          content = JSON.stringify(data, null, 2);
+        }
+
+        const outPath = opts.output || `palexplorer-report-${new Date().toISOString().slice(0, 10)}.${opts.format}`;
+        const resolved = path.resolve(outPath);
+        fs.writeFileSync(resolved, content, 'utf8');
+        console.log(chalk.green(`✔ Report generated: ${resolved}`));
+      } catch (err) {
+        console.log(chalk.red(`Report failed: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('top-shares')
+    .description('show most downloaded shares')
+    .option('--limit <n>', 'number of shares to show', '10')
+    .action(async (opts) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.reporting-dashboard') || {};
+        const metrics = store.reportingMetrics || {};
+        const shares = metrics.topShares || [];
+        const limit = parseInt(opts.limit, 10) || 10;
+
+        if (shares.length === 0) {
+          console.log(chalk.dim('No share data available yet.'));
+          return;
+        }
+
+        console.log(chalk.bold(`Top ${Math.min(limit, shares.length)} Shares\n`));
+        const sorted = shares.sort((a, b) => (b.downloads || 0) - (a.downloads || 0)).slice(0, limit);
+        for (let i = 0; i < sorted.length; i++) {
+          console.log(`  ${chalk.dim(`${i + 1}.`)} ${chalk.cyan(sorted[i].name)} — ${chalk.white(sorted[i].downloads || 0)} downloads`);
+        }
+      } catch (err) {
+        console.log(chalk.red(`Failed: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('storage-trends')
+    .description('show 30-day storage usage trends')
+    .option('--days <n>', 'number of days', '30')
+    .action(async (opts) => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const store = extConfig.get('ext_store.reporting-dashboard') || {};
+        const metrics = store.reportingMetrics || {};
+        const trends = metrics.storageTrends || {};
+        const days = parseInt(opts.days, 10) || 30;
+
+        const entries = Object.entries(trends).sort().slice(-days);
+        if (entries.length === 0) {
+          console.log(chalk.dim('No storage trend data available yet.'));
+          return;
+        }
+
+        console.log(chalk.bold(`Storage Trends (last ${entries.length} days)\n`));
+        for (const [date, bytes] of entries) {
+          console.log(`  ${chalk.dim(date)} ${chalk.white(formatBytes(bytes))}`);
+        }
+      } catch (err) {
+        console.log(chalk.red(`Failed: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+
+  cmd
+    .command('dashboard')
+    .description('open the analytics web dashboard')
+    .action(async () => {
+      try {
+        const extConfig = (await import('../utils/config.js')).default;
+        const extConf = extConfig.get('ext.reporting-dashboard') || {};
+        const port = extConf.dashboardPort;
+        if (!port) {
+          console.log(chalk.yellow('Dashboard port not configured. Set it with:'));
+          console.log(chalk.dim('  pal ext config reporting-dashboard dashboardPort 9090'));
+          process.exitCode = 1;
+          return;
+        }
+        const portNum = parseInt(port, 10);
+        if (!Number.isInteger(portNum) || portNum < 1 || portNum > 65535) {
+          console.error('Invalid analytics port');
+          return;
+        }
+        const url = `http://127.0.0.1:${portNum}`;
+        console.log(chalk.green(`Dashboard: ${chalk.cyan(url)}`));
+        const { exec } = await import('child_process');
+        const opener = process.platform === 'win32' ? 'start' : process.platform === 'darwin' ? 'open' : 'xdg-open';
+        exec(`${opener} ${url}`);
+      } catch (err) {
+        console.log(chalk.red(`Failed: ${err.message}`));
+        process.exitCode = 1;
+      }
+    });
+}
+
+function formatBytes(bytes) {
+  if (bytes === 0) return '0 B';
+  const k = 1024;
+  const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
+}