fnos-cli 0.2.1 → 0.3.0

package/package.json

@@ -1 +1 @@
-{"name": "fnos-cli", "version": "0.2.1", "description": "CLI client for 飞牛 fnOS system", "main": "src/index.js", "bin": {"fnos": "./bin/fnos"}, "scripts": {"start": "node src/index.js", "test": "mocha test/**/*.test.js"}, "keywords": ["fnos", "cli", "nas"], "author": "", "license": "Apache-2.0", "dependencies": {"commander": "^11.1.0", "fnos": "^0.2.1", "winston": "^3.19.0"}, "devDependencies": {"chai": "^5.3.3", "mocha": "^10.8.2"}}
+{"name":"fnos-cli","version":"0.3.0","description":"CLI client for 飞牛 fnOS system","main":"src/index.js","bin":{"fnos":"./bin/fnos"},"files":["bin/","src/","README.md","CHANGELOG.md","LICENSE","docs/commands.md"],"scripts":{"start":"node src/index.js","test":"npm run test:unit","test:unit":"mocha \"test/unit/**/*.test.js\"","test:smoke":"mocha --timeout 180000 \"test/smoke/**/*.test.js\"","test:all":"npm run test:unit && npm run test:smoke","docs:commands":"node scripts/generate-command-reference.js"},"keywords":["fnos","cli","nas"],"author":"Timandes White","license":"Apache-2.0","engines":{"node":">=18"},"repository":{"type":"git","url":"git+https://github.com/Timandes/fnos-cli.git"},"bugs":{"url":"https://github.com/Timandes/fnos-cli/issues"},"homepage":"https://github.com/Timandes/fnos-cli#readme","publishConfig":{"registry":"https://registry.npmjs.org/"},"dependencies":{"commander":"^11.1.0","fnos":"^0.4.0","winston":"^3.19.0"},"devDependencies":{"chai":"^5.3.3","mocha":"^10.8.2"}}

package/src/commands/auth.js

@@ -1,62 +1,49 @@
-/**
- * Authentication commands (login, logout)
- */
-
-const { Command } = require('commander');
 const settings = require('../utils/settings');
 const { createClient } = require('../utils/client');
-const { logger } = require('../utils/logger');
-
-/**
- * Register login command
- * @param {Command} program - Commander program instance
- */
-function registerLoginCommand(program) {
-  program
-    .command('login')
-    .description('Login to fnOS system and save credentials')
-    .requiredOption('-e, --endpoint <endpoint>', 'Server endpoint (e.g., nas-9.timandes.net:5666)')
-    .requiredOption('-u, --username <username>', 'Username')
-    .requiredOption('-p, --password <password>', 'Password')
-    .action(async (options) => {
-      try {
-        const { endpoint, username, password } = options;
+const { errorMessage } = require('../utils/errors');
+const { registerAuthenticationOptions } = require('./options');
 
-        logger.info('Logging in...');
-        const client = await createClient({ endpoint, username, password, timeout: 60, saveCredentials: true });
-        logger.info('Login successful! Credentials saved.');
-        client.close();
-        process.exit(0);
-      } catch (error) {
-        logger.error(`Login failed: ${error.message}`);
-        process.exit(3);
-      }
-    });
+function registerLoginCommand(program, dependencies = {}) {
+  const create = dependencies.createClient || createClient;
+  const stderr = dependencies.stderr || console.error;
+  const command = program.command('login').description('Login to fnOS and save credentials');
+  registerAuthenticationOptions(command, true);
+  command.action(async (options) => {
+    let client;
+    try {
+      client = await create({
+        endpoint: options.endpoint,
+        username: options.username,
+        password: options.password,
+        timeout: 60,
+        saveCredentials: true,
+        twofaCode: options.twofaCode,
+        trustDevice: options.trustDevice,
+        verifySsl: options.verifySsl
+      });
+      process.exitCode = 0;
+    } catch (error) {
+      stderr(`Error: ${errorMessage(error)}`);
+      process.exitCode = error.exitCode || 1;
+    } finally {
+      if (client) client.close();
+    }
+  });
 }
 
-/**
- * Register logout command
- * @param {Command} program - Commander program instance
- */
-function registerLogoutCommand(program) {
-  program
-    .command('logout')
-    .description('Logout and clear saved credentials')
-    .action(() => {
-      try {
-        const credentials = settings.getCredentials();
-        if (credentials && (credentials.endpoint || credentials.username)) {
-          settings.clearCredentials();
-          console.log('Logged out successfully. Credentials cleared.');
-        } else {
-          console.log('No saved credentials found.');
-        }
-        process.exit(0);
-      } catch (error) {
-        logger.error(`Logout failed: ${error.message}`);
-        process.exit(1);
-      }
-    });
+function registerLogoutCommand(program, dependencies = {}) {
+  const store = dependencies.settings || settings;
+  const stdout = dependencies.stdout || console.log;
+  program.command('logout').description('Logout and clear saved credentials').action(() => {
+    const credentials = store.getCredentials();
+    if (credentials && (credentials.endpoint || credentials.username)) {
+      store.clearCredentials();
+      stdout('Logged out successfully. Credentials cleared.');
+    } else {
+      stdout('No saved credentials found.');
+    }
+    process.exitCode = 0;
+  });
 }
 
-module.exports = { registerLoginCommand, registerLogoutCommand };
+module.exports = { registerLoginCommand, registerLogoutCommand };

package/src/commands/catalog/applications.js

@@ -0,0 +1,30 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const applicationsCatalog = {
+  docker: {
+    className: 'DockerManager',
+    commands: {
+      listComposes: command('listComposes', 'List Docker Compose projects'),
+      listContainers: command('listContainers', 'List Docker containers', [
+        { name: 'all', flag: '--all <boolean>', type: 'boolean', defaultValue: true, description: 'Include stopped containers' }
+      ]),
+      stats: command('stats', 'Get Docker container statistics'),
+      getSystemSettings: command('getSystemSettings', 'Get Docker system settings'),
+      listImageDownloads: command('listImageDownloads', 'List Docker image downloads'),
+      listImages: command('listImages', 'List Docker images'),
+      listNetworks: command('listNetworks', 'List Docker networks'),
+      listRegistryRepositories: command('listRegistryRepositories', 'List Docker registry repositories', [
+        { name: 'keyword', flag: '--keyword <keyword>', type: 'string', defaultValue: '', description: 'Search keyword' },
+        { name: 'page', flag: '--page <integer>', type: 'integer', min: 1, defaultValue: 1, description: 'Page number' },
+        { name: 'pageSize', flag: '--page-size <integer>', type: 'integer', min: 1, defaultValue: 20, description: 'Items per page' }
+      ])
+    }
+  }
+};
+
+module.exports = { applicationsCatalog };

package/src/commands/catalog/identity-security.js

@@ -0,0 +1,52 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const identitySecurityCatalog = {
+  user: {
+    className: 'User',
+    commands: {
+      info: command('getInfo', 'Get user information'),
+      listUG: command('listUserGroups', 'List users and groups'),
+      groupUsers: command('groupUsers', 'Get user grouping information'),
+      isAdmin: command('isAdmin', 'Check whether the current user is an administrator'),
+      listTokens: command('listTokens', 'List authentication tokens'),
+      getMyTwofaConfig: command('getMyTwofaConfig', 'Get current user two-factor configuration'),
+      getGlobalTwofaConfig: command('getGlobalTwofaConfig', 'Get global two-factor configuration'),
+      getUserTwofaConfig: command('getUserTwofaConfig', 'Get a user two-factor configuration', [
+        { name: 'uid', flag: '--uid <integer>', type: 'integer', min: 0, required: true, description: 'User ID' }
+      ]),
+      getActiveState: command('getActiveState', 'Get current user active state'),
+      getGroupInfo: command('getGroupInfo', 'Get group information', [
+        { name: 'group', flag: '--group <group>', type: 'string', required: true, description: 'Group name' }
+      ]),
+      listGroups: command('listGroups', 'List groups'),
+      listLoginDevices: command('listLoginDevices', 'List login devices'),
+      getPreference: command('getPreference', 'Get a user preference', [
+        { name: 'name', flag: '--name <name>', type: 'string', required: true, description: 'Preference name' }
+      ])
+    }
+  },
+  ipblock: {
+    className: 'IPBlocker',
+    commands: {
+      listAllowedAddresses: command('listAllowedAddresses', 'List allowed IP addresses'),
+      getAutoBlockRule: command('getAutoBlockRule', 'Get automatic IP blocking rule'),
+      listDeniedAddresses: command('listDeniedAddresses', 'List denied IP addresses')
+    }
+  },
+  security: {
+    className: 'Security',
+    commands: {
+      getFirewall: command('getFirewall', 'Get firewall configuration'),
+      getProcessTraffic: command('getProcessTraffic', 'Get process traffic data', [
+        { name: 'processes', flag: '--processes <json>', type: 'json-record-array', required: true, description: 'Process objects as a JSON array' }
+      ])
+    }
+  }
+};
+
+module.exports = { identitySecurityCatalog };

package/src/commands/catalog/index.js

@@ -0,0 +1,21 @@
+const { monitoringCatalog } = require('./monitoring');
+const { storageCatalog } = require('./storage');
+const { systemCatalog } = require('./system');
+const { identitySecurityCatalog } = require('./identity-security');
+const { networkSharingCatalog } = require('./network-sharing');
+const { applicationsCatalog } = require('./applications');
+
+const COMMAND_CATALOG = Object.freeze({
+  ...monitoringCatalog,
+  ...storageCatalog,
+  ...systemCatalog,
+  ...identitySecurityCatalog,
+  ...networkSharingCatalog,
+  ...applicationsCatalog
+});
+
+const DOMAIN_COUNT = Object.keys(COMMAND_CATALOG).length;
+const COMMAND_COUNT = Object.values(COMMAND_CATALOG)
+  .reduce((count, domain) => count + Object.keys(domain.commands).length, 0);
+
+module.exports = { COMMAND_CATALOG, DOMAIN_COUNT, COMMAND_COUNT };

package/src/commands/catalog/monitoring.js

@@ -0,0 +1,40 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const monitoringCatalog = {
+  resmon: {
+    className: 'ResourceMonitor',
+    commands: {
+      cpu: command('cpu', 'Get CPU resource monitoring information', [], 'first'),
+      gpu: command('gpu', 'Get GPU resource monitoring information', [], 'first'),
+      mem: command('memory', 'Get memory resource monitoring information', [], 'first'),
+      disk: command('disk', 'Get disk resource monitoring information', [], 'first'),
+      net: command('net', 'Get network resource monitoring information', [], 'first'),
+      gen: command('general', 'Get general resource monitoring information', [
+        { name: 'items', flag: '--items <items>', type: 'csv', defaultValue: null, description: 'Comma-separated monitoring items' }
+      ], 'first'),
+      npu: command('npu', 'Get NPU resource monitoring information', [], 'first'),
+      processes: command('processes', 'List monitored processes', [], 'first'),
+      serviceProcesses: command('serviceProcesses', 'List monitored service processes', [], 'first'),
+      systemFan: command('systemFan', 'Get system fan monitoring information', [], 'first')
+    }
+  },
+  event: {
+    className: 'EventLogger',
+    commands: {
+      commonList: command('commonList', 'List common event log entries')
+    }
+  },
+  notify: {
+    className: 'Notify',
+    commands: {
+      unreadTotal: command('unreadTotal', 'Get unread notification total')
+    }
+  }
+};
+
+module.exports = { monitoringCatalog };

package/src/commands/catalog/network-sharing.js

@@ -0,0 +1,81 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const networkSharingCatalog = {
+  network: {
+    className: 'Network',
+    commands: {
+      list: command('list', 'List network information', [
+        { name: 'type', flag: '--type <integer>', type: 'integer', allowedValues: [0, 1], defaultValue: 0, description: 'Network list type: 0 or 1' }
+      ]),
+      detect: command('detect', 'Detect a network interface', [
+        { name: 'ifName', flag: '--if-name <name>', legacyFlags: ['--ifName <name>'], type: 'string', required: true, description: 'Network interface name' }
+      ]),
+      getGateway: command('getGateway', 'Get gateway information'),
+      getMultiGatewayStatus: command('getMultiGatewayStatus', 'Get multi-gateway status'),
+      getNicPerformanceMode: command('getNicPerformanceMode', 'Get NIC performance mode'),
+      getInfo: command('getInfo', 'Get network interface information', [
+        { name: 'ifName', flag: '--if-name <name>', legacyFlags: ['--ifName <name>'], type: 'string', required: true, description: 'Network interface name' }
+      ]),
+      getSshStatus: command('getSshStatus', 'Get SSH service status')
+    }
+  },
+  share: {
+    className: 'Share',
+    commands: {
+      smbOpt: command('smbOpt', 'Get SMB options'),
+      dlnaOptions: command('dlnaOptions', 'Get DLNA options'),
+      dlnaShareOptions: command('dlnaShareOptions', 'Get DLNA share options'),
+      ftpOptions: command('ftpOptions', 'Get FTP options'),
+      ftpShareOptions: command('ftpShareOptions', 'Get FTP share options'),
+      nfsOptions: command('nfsOptions', 'Get NFS options'),
+      nfsShareOptions: command('nfsShareOptions', 'Get NFS share options'),
+      smbShareOptions: command('smbShareOptions', 'Get SMB share options'),
+      webdavOptions: command('webdavOptions', 'Get WebDAV options'),
+      webdavShareOptions: command('webdavShareOptions', 'Get WebDAV share options'),
+      getLinkDefaults: command('getLinkDefaults', 'Get share link defaults'),
+      getDefaultLink: command('getDefaultLink', 'Get the default share link'),
+      listLinks: command('listLinks', 'List share links', [
+        { name: 'isAdmin', flag: '--is-admin <boolean>', type: 'boolean', defaultValue: false, description: 'Use administrator view' },
+        { name: 'keyword', flag: '--keyword <keyword>', type: 'string', defaultValue: '', description: 'Search keyword' },
+        { name: 'page', flag: '--page <integer>', type: 'integer', min: 1, defaultValue: 1, description: 'Page number' },
+        { name: 'pageSize', flag: '--page-size <integer>', type: 'integer', min: 1, defaultValue: 100, description: 'Items per page' },
+        { name: 'sortColumn', flag: '--sort-column <column>', type: 'string', defaultValue: 'createdTime', description: 'Sort column' },
+        { name: 'sortType', flag: '--sort-type <type>', type: 'string', defaultValue: 'DESC', description: 'Sort direction' }
+      ]),
+      getLinkPermission: command('getLinkPermission', 'Get share link permission')
+    }
+  },
+  iscsi: {
+    className: 'IscsiManager',
+    commands: {
+      getConfig: command('getConfig', 'Get iSCSI configuration'),
+      listInitiators: command('listInitiators', 'List iSCSI initiators'),
+      listLuns: command('listLuns', 'List iSCSI LUNs'),
+      listLunUsergroups: command('listLunUsergroups', 'List iSCSI LUN user groups', [
+        { name: 'lunName', flag: '--lun-name <name>', type: 'string', defaultValue: '', description: 'LUN name filter' },
+        { name: 'wwn', flag: '--wwn <wwn>', type: 'string', defaultValue: '', description: 'WWN filter' }
+      ]),
+      listTargets: command('listTargets', 'List iSCSI targets')
+    }
+  },
+  netsvr: {
+    className: 'NetworkServer',
+    commands: {
+      listCertificates: command('listCertificates', 'List server certificates'),
+      getConnectionConfig: command('getConnectionConfig', 'Get connection configuration'),
+      getConnectionStatus: command('getConnectionStatus', 'Get connection status'),
+      listDdnsProviders: command('listDdnsProviders', 'List DDNS providers'),
+      listDdnsRecords: command('listDdnsRecords', 'List DDNS records', [
+        { name: 'page', flag: '--page <integer>', type: 'integer', min: 1, defaultValue: 1, description: 'Page number' },
+        { name: 'pageSize', flag: '--page-size <integer>', type: 'integer', min: 1, defaultValue: 200, description: 'Items per page' }
+      ])
+    }
+  }
+};
+
+module.exports = { networkSharingCatalog };

package/src/commands/catalog/storage.js

@@ -0,0 +1,107 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const storageCatalog = {
+  store: {
+    className: 'Store',
+    commands: {
+      general: command('general', 'Get storage general information'),
+      calcSpace: command('calculateSpace', 'Calculate storage space information'),
+      listDisk: command('listDisks', 'List disk information', [
+        {
+          name: 'noHotSpare',
+          flag: '--no-hot-spare <boolean>',
+          legacyFlags: ['--noHotSpare <boolean>'],
+          readNames: ['noHotSpare', 'hotSpare'],
+          type: 'boolean',
+          defaultValue: true,
+          description: 'Exclude hot spare disks'
+        }
+      ]),
+      diskSmart: command('getDiskSmart', 'Get disk SMART information', [
+        { name: 'disk', flag: '--disk <disk>', type: 'string', required: true, description: 'Disk device name' }
+      ]),
+      state: command('getState', 'Get storage state information', [
+        { name: 'name', flag: '--name <names>', type: 'csv', defaultValue: [], description: 'Comma-separated array names' },
+        { name: 'uuid', flag: '--uuid <uuids>', type: 'csv', defaultValue: [], description: 'Comma-separated array UUIDs' }
+      ]),
+      getUserStorage: command('getUserStorage', 'Get user storage information', [
+        { name: 'spaceInfo', flag: '--space-info <boolean>', type: 'boolean', defaultValue: false, description: 'Include space information' },
+        { name: 'storInfo', flag: '--stor-info <boolean>', type: 'boolean', defaultValue: false, description: 'Include storage information' },
+        { name: 'quotaInfo', flag: '--quota-info <boolean>', type: 'boolean', defaultValue: false, description: 'Include quota information' }
+      ]),
+      getCacheDeviceState: command('getCacheDeviceState', 'Get cache device state'),
+      getDiskIdleTime: command('getDiskIdleTime', 'Get disk idle time'),
+      getDiskWakeup: command('getDiskWakeup', 'Get disk wake-up state'),
+      getRemovableConfig: command('getRemovableConfig', 'Get removable device configuration'),
+      listCacheDevices: command('listCacheDevices', 'List cache devices'),
+      listRemovableDevices: command('listRemovableDevices', 'List removable devices')
+    }
+  },
+  file: {
+    className: 'File',
+    commands: {
+      ls: command('list', 'List files and directories', [
+        { name: 'path', flag: '--path <path>', type: 'string', defaultValue: null, description: 'Directory path' }
+      ]),
+      mkdir: command('mkdir', 'Create a directory', [
+        { name: 'path', flag: '--path <path>', type: 'string', required: true, description: 'Directory path' }
+      ]),
+      rm: command('remove', 'Remove files or directories', [
+        { name: 'files', flag: '--files <files>', type: 'csv', required: true, description: 'Comma-separated file paths' },
+        {
+          name: 'moveToTrashbin',
+          flag: '--move-to-trashbin <boolean>',
+          legacyFlags: ['--moveToTrashbin <boolean>'],
+          type: 'boolean',
+          defaultValue: true,
+          description: 'Move removed files to trash'
+        },
+        { name: 'details', flag: '--details <json>', type: 'json', defaultValue: null, description: 'File detail object as JSON' }
+      ]),
+      getAcl: command('getAcl', 'Get file ACL information', [
+        { name: 'files', flag: '--files <files>', type: 'csv', required: true, description: 'Comma-separated vol-prefixed paths' }
+      ]),
+      listAppDirectories: command('listAppDirectories', 'List application directories'),
+      listFavorites: command('listFavorites', 'List favorite files'),
+      listDirectoryEntries: command('listDirectoryEntries', 'List directory entries'),
+      listRecent: command('listRecent', 'List recent files'),
+      listShared: command('listShared', 'List shared files'),
+      listSharedByOthers: command('listSharedByOthers', 'List files shared by others'),
+      listTeamTrashBins: command('listTeamTrashBins', 'List team trash bins'),
+      listTrash: command('listTrash', 'List trash entries')
+    }
+  },
+  backup: {
+    className: 'BackupManager',
+    commands: {
+      listTasks: command('listTasks', 'List backup tasks', [
+        { name: 'direction', flag: '--direction <integer>', type: 'integer', required: true, allowedValues: [0, 1], description: 'Backup direction: 0 or 1' }
+      ])
+    }
+  },
+  download: {
+    className: 'DownloadCenter',
+    commands: {
+      getDefaultSaveDirectory: command('getDefaultSaveDirectory', 'Get the default download directory'),
+      getStatistics: command('getStatistics', 'Get download statistics'),
+      queryTasks: command('queryTasks', 'Query download tasks', [
+        { name: 'stateFilter', flag: '--state-filter <integer>', type: 'integer', min: 0, defaultValue: 65535, description: 'Task state bit mask' },
+        { name: 'initFlag', flag: '--init-flag <boolean>', type: 'boolean', defaultValue: true, description: 'Include initialization data' }
+      ])
+    }
+  },
+  mount: {
+    className: 'MountManager',
+    commands: {
+      listMounts: command('listMounts', 'List mounted resources'),
+      getSettings: command('getSettings', 'Get mount settings')
+    }
+  }
+};
+
+module.exports = { storageCatalog };

package/src/commands/catalog/system.js

@@ -0,0 +1,51 @@
+const command = (method, description, options = [], timeoutPosition = 'last') => ({
+  method,
+  description,
+  timeoutPosition,
+  options
+});
+
+const systemCatalog = {
+  sysinfo: {
+    className: 'SystemInfo',
+    commands: {
+      getHostName: command('getHostName', 'Get host name information'),
+      getTrimVersion: command('getTrimVersion', 'Get Trim version information'),
+      getMachineId: command('getMachineId', 'Get machine ID information'),
+      getHardwareInfo: command('getHardwareInfo', 'Get hardware information'),
+      getUptime: command('getUptime', 'Get system uptime information'),
+      getReservedPartition: command('getReservedPartition', 'Get reserved partition information')
+    }
+  },
+  sac: {
+    className: 'SAC',
+    commands: {
+      upsStatus: command('upsStatus', 'Get UPS status information'),
+      getEmailConfig: command('getEmailConfig', 'Get email notification configuration'),
+      listEmailProviders: command('listEmailProviders', 'List email notification providers')
+    }
+  },
+  license: {
+    className: 'LicenseManager',
+    commands: {
+      list: command('list', 'List installed software licenses', [
+        { name: 'page', flag: '--page <integer>', type: 'integer', min: 1, defaultValue: 1, description: 'Page number' },
+        { name: 'pageSize', flag: '--page-size <integer>', type: 'integer', min: 1, defaultValue: 200, description: 'Items per page' }
+      ])
+    }
+  },
+  liveupdate: {
+    className: 'LiveUpdate',
+    commands: {
+      getStatus: command('getStatus', 'Get live update status')
+    }
+  },
+  sysrestore: {
+    className: 'SystemRestore',
+    commands: {
+      getInfo: command('getInfo', 'Get system restore information')
+    }
+  }
+};
+
+module.exports = { systemCatalog };