fnos-cli 0.1.0 → 0.2.0

package/README.md

@@ -59,7 +59,27 @@ fnos login -e nas-9.timandes.net:5666 -u SystemMonitor -p yourpassword
 
 登录成功后，凭证会保存在 `~/.fnos/settings.json` 文件中，后续命令无需重复输入。
 
-### 2. 使用命令
+### 2. 使用命令行凭证参数
+
+除了使用 `login` 保存凭证外，您还可以直接在命令中提供连接参数：
+
+```bash
+fnos <command> -e <endpoint> -u <username> -p <password>
+```
+
+例如：
+
+```bash
+fnos resmon.cpu -e nas-9.timandes.net:5666 -u SystemMonitor -p yourpassword
+```
+
+**注意事项**：
+- 三个参数（`-e`、`-u`、`-p`）必须同时提供，不能只提供部分参数
+- 使用命令行参数提供的凭证**不会**保存到配置文件中，适合临时使用
+- 如果未提供这三个参数，会自动使用已保存的凭证（需要先执行 `login`）
+- 这种方式适合自动化脚本或临时连接到不同服务器
+
+### 3. 使用命令
 
 登录后即可执行各种命令：
 
@@ -120,6 +140,38 @@ fnos resmon.cpu -v > output.json 2>log.txt
 fnos resmon.cpu 2>/dev/null
 ```
 
+### 认证参数
+
+所有命令（`login` 和 `logout` 除外）都支持以下可选的认证参数：
+
+| 参数 | 说明 |
+|------|------|
+| `-e, --endpoint <endpoint>` | 服务器端点（例如：nas-9.timandes.net:5666） |
+| `-u, --username <username>` | 用户名 |
+| `-p, --password <password>` | 密码 |
+
+**使用规则**：
+
+1. **三个参数必须同时提供**：如果提供任何一个参数，必须同时提供另外两个参数
+2. **临时使用不保存**：通过命令行参数提供的凭证不会被保存到配置文件
+3. **优先使用命令行参数**：如果同时提供了命令行参数和配置文件中有保存的凭证，优先使用命令行参数
+4. **回退到配置文件**：如果未提供这三个参数，会自动使用 `login` 保存的凭证
+
+**示例**：
+
+```bash
+# 使用命令行参数（临时使用，不保存）
+fnos resmon.cpu -e nas-9.timandes.net:5666 -u SystemMonitor -p yourpassword
+
+# 错误示例：只提供部分参数
+fnos resmon.cpu -e nas-9.timandes.net:5666
+# Error: When using -e/--endpoint, you must also provide -u/--username and -p/--password.
+
+# 使用已保存的凭证（需要先执行 login）
+fnos login -e nas-9.timandes.net:5666 -u SystemMonitor -p yourpassword
+fnos resmon.cpu  # 不需要再提供参数
+```
+
 ### 资源监控命令
 
 | 命令 | 说明 |

package/package.json

@@ -1,3 +1 @@
-{
-  "name": "fnos-cli",
-  "version": "0.1.0", "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.0", "winston": "^3.19.0"}, "devDependencies": {"chai": "^5.3.3", "mocha": "^10.8.2"}}
+{"name": "fnos-cli", "version": "0.2.0", "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.0", "winston": "^3.19.0"}, "devDependencies": {"chai": "^5.3.3", "mocha": "^10.8.2"}}

package/src/commands/auth.js

@@ -23,7 +23,7 @@ function registerLoginCommand(program) {
         const { endpoint, username, password } = options;
 
         logger.info('Logging in...');
-        const client = await createClient({ endpoint, username, password, timeout: 60 });
+        const client = await createClient({ endpoint, username, password, timeout: 60, saveCredentials: true });
         logger.info('Login successful! Credentials saved.');
         client.close();
         process.exit(0);
@@ -44,8 +44,9 @@ function registerLogoutCommand(program) {
     .description('Logout and clear saved credentials')
     .action(() => {
       try {
-        if (settings.exists()) {
-          settings.clear();
+        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.');

package/src/commands/index.js

@@ -6,6 +6,7 @@ const { COMMAND_MAPPING } = require('../constants');
 const { createClient, getSDKInstance } = require('../utils/client');
 const { formatOutput } = require('../utils/formatter');
 const { logger } = require('../utils/logger');
+const { resolveCredentials } = require('../utils/auth-helper');
 
 /**
  * Register all dynamic commands based on COMMAND_MAPPING
@@ -21,6 +22,11 @@ function registerCommands(program) {
       const cmd = program.command(fullCommandName)
         .description(commandConfig.description);
 
+      // Add authentication parameters
+      cmd.option('-e, --endpoint <endpoint>', 'Server endpoint (e.g., nas-9.timandes.net:5666)');
+      cmd.option('-u, --username <username>', 'Username');
+      cmd.option('-p, --password <password>', 'Password');
+
       // Add parameters
       if (commandConfig.params) {
         commandConfig.params.forEach(param => {
@@ -51,8 +57,23 @@ function registerCommands(program) {
             }
           }
 
-          // Create client (will use saved credentials from settings)
+          // Resolve credentials (command line or settings file)
+          let credentials;
+          try {
+            credentials = resolveCredentials(options, program);
+          } catch (error) {
+            if (error.message === 'PARTIAL_CREDENTIALS') {
+              // Display friendly error message
+              console.error('Error: When using -e/--endpoint, you must also provide -u/--username and -p/--password.');
+              console.error('Usage: fnos %s -e <endpoint> -u <username> -p <password>', fullCommandName);
+              process.exit(1);
+            }
+            throw error;
+          }
+
+          // Create client with resolved credentials
           const client = await createClient({
+            credentials,
             timeout: 60
           });
 

package/src/index.js

@@ -16,7 +16,7 @@ const program = new Command();
 program
   .name('fnos')
   .description('CLI client for 飞牛 fnOS system')
-  .version('1.0.0');
+  .version('0.2.0');
 
 // Global options
 program

package/src/utils/auth-helper.js

@@ -0,0 +1,68 @@
+/**
+ * Authentication helper for credential validation and resolution
+ */
+
+const settings = require('./settings');
+
+/**
+ * Check if partial credentials are provided
+ * @param {Object} options - Command line options
+ * @returns {boolean} - True if at least one but not all three parameters are provided
+ */
+function hasPartialCredentials(options) {
+  const { endpoint, username, password } = options;
+  const provided = [endpoint, username, password].filter(Boolean);
+  return provided.length > 0 && provided.length < 3;
+}
+
+/**
+ * Validate command line credentials completeness
+ * @param {Object} options - Command line options
+ * @returns {Object} - { isValid: boolean, hasCredentials: boolean }
+ * @throws {Error} - If partial credentials are provided
+ */
+function validateCommandLineCredentials(options) {
+  if (hasPartialCredentials(options)) {
+    throw new Error('PARTIAL_CREDENTIALS');
+  }
+
+  const hasCredentials = options.endpoint && options.username && options.password;
+  return { isValid: true, hasCredentials };
+}
+
+/**
+ * Resolve and return the final credentials to use
+ * @param {Object} options - Command line options
+ * @returns {Object} - Credentials object
+ * @throws {Error} - If no valid credentials are found or partial credentials are provided
+ */
+function resolveCredentials(options) {
+  const validation = validateCommandLineCredentials(options);
+
+  if (validation.hasCredentials) {
+    // Use command line credentials (do NOT save to settings)
+    return {
+      endpoint: options.endpoint,
+      username: options.username,
+      password: options.password,
+      source: 'command_line'
+    };
+  }
+
+  // Read from settings file
+  const credentials = settings.getCredentials();
+  if (!credentials || !credentials.endpoint || !credentials.username || !credentials.password) {
+    throw new Error('No valid credentials found. Please use "fnos login" or provide -e/-u/-p options.');
+  }
+
+  return {
+    ...credentials,
+    source: 'settings_file'
+  };
+}
+
+module.exports = {
+  hasPartialCredentials,
+  validateCommandLineCredentials,
+  resolveCredentials
+};

package/src/utils/client.js

@@ -9,16 +9,23 @@ const { logger } = require('./logger');
 /**
  * Create authenticated FnosClient
  * @param {Object} options - Options object
- * @param {string} options.endpoint - Server endpoint
- * @param {string} options.username - Username
- * @param {string} options.password - Password
- * @param {number} options.timeout - Connection timeout in seconds
+ * @param {Object} [options.credentials] - Direct credentials object (endpoint, username, password, etc.)
+ * @param {string} [options.endpoint] - Server endpoint (legacy)
+ * @param {string} [options.username] - Username (legacy)
+ * @param {string} [options.password] - Password (legacy)
+ * @param {number} [options.timeout] - Connection timeout in seconds
+ * @param {boolean} [options.saveCredentials] - Whether to save credentials to settings (default: false)
  * @returns {Promise<FnosClient>} Authenticated client
  */
 async function createClient(options = {}) {
-  const { endpoint, username, password, timeout = 60 } = options;
+  const { credentials, endpoint, username, password, timeout = 60, saveCredentials = false } = options;
 
-  // Get credentials from settings if not provided
+  // Use provided credentials object
+  if (credentials) {
+    return await createClientWithCredentials(credentials, timeout, saveCredentials);
+  }
+
+  // Legacy support: build credentials from individual parameters
   const savedCredentials = settings.getCredentials();
   const finalEndpoint = endpoint || savedCredentials?.endpoint;
   const finalUsername = username || savedCredentials?.username;
@@ -28,41 +35,56 @@ async function createClient(options = {}) {
     throw new Error('Missing credentials. Please run "fnos login" first or provide -e, -u, -p parameters.');
   }
 
+  return await createClientWithCredentials(
+    {
+      endpoint: finalEndpoint,
+      username: finalUsername,
+      password: finalPassword,
+      token: savedCredentials?.token,
+      longToken: savedCredentials?.longToken,
+      secret: savedCredentials?.secret
+    },
+    timeout,
+    saveCredentials
+  );
+}
+
+/**
+ * Create authenticated client with credentials
+ * @param {Object} credentials - Credentials object
+ * @param {string} credentials.endpoint - Server endpoint
+ * @param {string} credentials.username - Username
+ * @param {string} credentials.password - Password
+ * @param {number} timeout - Connection timeout in seconds
+ * @param {boolean} saveToSettings - Whether to save credentials to settings
+ * @returns {Promise<FnosClient>} Authenticated client
+ */
+async function createClientWithCredentials(credentials, timeout, saveToSettings) {
+  const { endpoint, username, password } = credentials;
+
   // Create client
   const client = new FnosClient();
-  logger.info(`Connecting to ${finalEndpoint}...`);
+  logger.info(`Connecting to ${endpoint}...`);
 
   // Connect
-  await client.connect(finalEndpoint, timeout * 1000);
+  await client.connect(endpoint, timeout * 1000);
   logger.info('Connected successfully');
 
-  // Try to login with token first
-  // if (savedCredentials?.token && savedCredentials?.secret && !endpoint && !username && !password) {
-  //   try {
-  //     logger.info('Logging in with saved token...');
-  //     await client.loginViaToken(savedCredentials.token, savedCredentials.longToken, savedCredentials.secret);
-  //     logger.info('Logged in successfully with token');
-  //     return client;
-  //   } catch (error) {
-  //     logger.warn('Token login failed, falling back to password login:', error.message);
-  //   }
-  // }
-
   // Login with password
-  if (!finalPassword) {
+  if (!password) {
     throw new Error('Password required. Please run "fnos login" first or provide -p parameter.');
   }
 
   logger.info('Logging in...');
-  const loginResult = await client.login(finalUsername, finalPassword);
+  const loginResult = await client.login(username, password);
   logger.info('Logged in successfully');
 
-  // Save credentials if they were provided via command line
-  if (endpoint || username || password) {
+  // Save credentials only if explicitly requested (e.g., from login command)
+  if (saveToSettings) {
     settings.saveCredentials({
-      endpoint: finalEndpoint,
-      username: finalUsername,
-      password: finalPassword,
+      endpoint,
+      username,
+      password,
       token: loginResult.token,
       longToken: loginResult.longToken,
       secret: loginResult.secret

package/src/utils/settings.js

@@ -63,6 +63,23 @@ class Settings {
     }
   }
 
+  /**
+   * Clear only authentication credentials, preserving other settings
+   */
+  clearCredentials() {
+    const existingSettings = this.load();
+    if (!existingSettings) {
+      return;
+    }
+
+    // Remove only auth-related fields, keep other settings
+    const authFields = ['endpoint', 'username', 'password', 'token', 'longToken', 'secret'];
+    authFields.forEach(field => delete existingSettings[field]);
+
+    // Always save the file (even if empty), to preserve the settings.json file
+    this.save(existingSettings);
+  }
+
   /**
    * Check if settings file exists
    * @returns {boolean} True if settings file exists