byteplan-cli 1.3.3 → 1.3.5

package/README.md

@@ -12,8 +12,37 @@ npm install -g byteplan-cli
 
 ### Login
 
+登录并保存凭据（一次登录，后续无需重复）：
+
 ```bash
+# 首次登录（需要提供账号密码）
 byteplan login -u <phone> -p <password>
+
+# 使用已保存的凭据刷新 Token（无需账号密码）
+byteplan login
+
+# 覆盖已有凭据（直接传新账号密码即可）
+byteplan login -u <new_phone> -p <new_password>
+```
+
+### Config
+
+检查当前配置状态：
+
+```bash
+byteplan config
+```
+
+输出示例：
+```json
+{
+  "configured": true,
+  "user": "18256485741",
+  "env": "uat",
+  "hasToken": true,
+  "tokenExpired": false,
+  "message": "Configuration is valid."
+}
 ```
 
 ### User Commands
@@ -89,17 +118,31 @@ byteplan skills install -d ~/.claude/commands
 
 ## Configuration
 
-Credentials are stored in `~/.byteplan/.env`:
+`byteplan login` 会将凭据持久化保存到 `~/.byteplan/.env`，后续命令无需重复登录。
+
+**保存的内容**：
 
 ```env
-BP_ENV=uat
-BP_USER=<phone>
-BP_PASSWORD=<password>
-ACCESS_TOKEN=<token>
-REFRESH_TOKEN=<refresh_token>
-TOKEN_EXPIRES_IN=<timestamp>
+BP_ENV=uat                      # 环境 (uat/prod)
+BP_USER=<phone>                 # 手机号（用于自动重登）
+BP_PASSWORD=<password>          # 密码（用于自动重登）
+ACCESS_TOKEN=<token>            # 当前访问令牌
+REFRESH_TOKEN=<refresh_token>   # 刷新令牌
+TOKEN_EXPIRES_IN=<timestamp>    # Token 过期时间戳
 ```
 
+**Token 自动刷新**：
+
+- Token 有效期默认 2 小时
+- CLI 检测到 Token 即将过期（剩余 < 5 分钟）时，会自动用保存的账号密码重新登录
+- 无需手动干预，命令会自动执行
+
+**安全性说明**：
+
+- 凭据以明文存储在本地 `.env` 文件中
+- 请勿在共享环境中使用，或确保 `~/.byteplan/` 目录权限受限
+- 如需清除凭据：`rm ~/.byteplan/.env`
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "byteplan-cli",
-  "version": "1.3.3",
+  "version": "1.3.5",
   "description": "BytePlan CLI - Command line tool for BytePlan API",
   "keywords": [
     "byteplan",

package/src/api.js

@@ -115,7 +115,7 @@ function saveCredentials(data) {
   const lines = [];
   lines.push('BP_ENV=' + currentEnv);
   lines.push('BP_USER=' + data.username);
-  lines.push('BP_PASSWORD=' + data.password);
+  lines.push('BP_PASSWORD="' + data.password + '"');  // 用双引号包裹，防止 # 等特殊字符被解析为注释
   if (data.accessToken) {
     lines.push('ACCESS_TOKEN=' + data.accessToken);
   }

package/src/cli.js

@@ -6,6 +6,9 @@
 
 import { Command } from 'commander';
 import { createRequire } from 'module';
+import { homedir } from 'os';
+import { join } from 'path';
+import { existsSync, readFileSync } from 'fs';
 import {
   login,
   loginWithEnv,
@@ -23,6 +26,9 @@ import { skillsCmd } from './commands/skills.js';
 const require = createRequire(import.meta.url);
 const { version } = require('../package.json');
 
+const configDir = join(homedir(), '.byteplan');
+const envFile = join(configDir, '.env');
+
 function printJSON(data) {
   console.log(JSON.stringify(data, null, 2));
 }
@@ -32,6 +38,36 @@ function printError(error) {
   process.exit(1);
 }
 
+// 检查是否已有配置
+function checkExistingConfig() {
+  if (!existsSync(envFile)) {
+    return null;
+  }
+
+  const content = readFileSync(envFile, 'utf-8');
+  const lines = content.split('\n');
+  const config = {};
+
+  for (const line of lines) {
+    if (line.startsWith('BP_USER=')) {
+      config.user = line.split('=')[1];
+    }
+    if (line.startsWith('BP_ENV=')) {
+      config.env = line.split('=')[1];
+    }
+    if (line.startsWith('ACCESS_TOKEN=')) {
+      config.hasToken = true;
+    }
+    if (line.startsWith('TOKEN_EXPIRES_IN=')) {
+      const expiresAt = parseInt(line.split('=')[1]);
+      config.tokenExpiresAt = expiresAt;
+      config.tokenExpired = expiresAt < Date.now();
+    }
+  }
+
+  return config;
+}
+
 const program = new Command();
 
 program
@@ -40,20 +76,116 @@ program
   .version(version)
   .option('-e, --env <environment>', 'Environment (uat, prod)', 'uat');
 
+// Config command - 检查配置状态
+program
+  .command('config')
+  .description('Check current configuration status')
+  .action(() => {
+    try {
+      const config = checkExistingConfig();
+
+      if (!config) {
+        printJSON({
+          configured: false,
+          configFile: envFile,
+          message: 'No configuration found. Please run: byteplan login -u <phone> -p <password>'
+        });
+        return;
+      }
+
+      printJSON({
+        configured: true,
+        configFile: envFile,
+        user: config.user || '',
+        env: config.env || 'uat',
+        hasToken: config.hasToken || false,
+        tokenExpired: config.tokenExpired || false,
+        tokenExpiresAt: config.tokenExpiresAt ? new Date(config.tokenExpiresAt).toISOString() : null,
+        message: config.tokenExpired
+          ? 'Token expired. Will auto-refresh on next command.'
+          : 'Configuration is valid.'
+      });
+    } catch (error) {
+      printError(error);
+    }
+  });
+
 // Login command
 program
   .command('login')
-  .description('Login to BytePlan')
-  .requiredOption('-u, --user <phone>', 'Phone number')
-  .requiredOption('-p, --password <password>', 'Password')
+  .description('Login to BytePlan and save credentials')
+  .option('-u, --user <phone>', 'Phone number')
+  .option('-p, --password <password>', 'Password')
+  .addHelpText('after', `
+Usage:
+  byteplan login                    # 使用已保存的凭据刷新 Token（无需参数）
+  byteplan login -u <phone> -p <pwd> # 新登录或覆盖已有凭据
+
+说明:
+  - 首次使用需要提供账号密码: byteplan login -u 18256485741 -p yourpassword
+  - 登录成功后凭据保存到 ~/.byteplan/.env
+  - 后续可直接运行 byteplan login 刷新 Token（无需参数）
+  - 提供新账号密码会覆盖已有配置
+
+检查配置状态:
+  byteplan config
+`)
   .action(async (options) => {
     try {
+      const existingConfig = checkExistingConfig();
       const env = program.opts().env;
+
+      // 没有提供账号密码，使用已保存的配置
+      if (!options.user && !options.password) {
+        if (!existingConfig) {
+          printJSON({
+            error: true,
+            message: 'No saved credentials. Please provide user and password.',
+            hint: 'byteplan login -u <phone> -p <password>'
+          });
+          process.exit(1);
+        }
+
+        // 使用保存的凭据重新登录
+        const result = await loginWithEnv(true);
+        const userInfo = await getUserInfo();
+
+        printJSON({
+          success: true,
+          source: 'saved_credentials',
+          user: {
+            userId: userInfo.user?.id || '',
+            userName: userInfo.user?.userName || '',
+            userPhone: userInfo.user?.mobile || existingConfig.user,
+            email: userInfo.user?.email || '',
+          },
+          tenant: {
+            tenantId: userInfo.user?.tenantId || '',
+            tenantName: userInfo.user?.tenantName || '',
+            tenantCode: userInfo.user?.tenantCode || '',
+          },
+          expiresIn: result.expires_in,
+        });
+        return;
+      }
+
+      // 提供了账号密码（直接覆盖）
+      if (!options.user || !options.password) {
+        printJSON({
+          error: true,
+          message: 'Both user and password are required when providing credentials.',
+          hint: 'byteplan login -u <phone> -p <password>'
+        });
+        process.exit(1);
+      }
+
+      // 新登录（覆盖已有配置）
       const result = await login(options.user, options.password, env);
       const userInfo = await getUserInfo(result.access_token);
 
       printJSON({
         success: true,
+        source: 'new_credentials',
         user: {
           userId: userInfo.user?.id || '',
           userName: userInfo.user?.userName || '',
@@ -66,6 +198,7 @@ program
           tenantCode: userInfo.user?.tenantCode || '',
         },
         expiresIn: result.expires_in,
+        overwritten: existingConfig ? true : false,
       });
     } catch (error) {
       printError(error);

package/src/commands/skills.js

@@ -12,6 +12,27 @@ import { createRequire } from 'module';
 
 const require = createRequire(import.meta.url);
 
+// 配置文件路径
+const configDir = path.join(homedir(), '.byteplan');
+const envFile = path.join(configDir, '.env');
+
+// 检查配置状态
+function checkConfig() {
+  if (!existsSync(envFile)) {
+    return { configured: false };
+  }
+
+  const content = readFileSync(envFile, 'utf-8');
+  const config = { configured: true };
+
+  for (const line of content.split('\n')) {
+    if (line.startsWith('BP_USER=')) config.user = line.split('=')[1];
+    if (line.startsWith('BP_ENV=')) config.env = line.split('=')[1];
+  }
+
+  return config;
+}
+
 // 展开 ~ 路径，支持跨平台
 function expandHomeDir(dirPath) {
   if (!dirPath) return dirPath;
@@ -173,24 +194,31 @@ function installAllSkills(targetDirs) {
 
 // Skills 命令
 const skillsCmd = new Command('skills')
-  .description('Manage BytePlan skills (install, list, check installed)')
+  .description('Manage BytePlan skills')
   .option('-p, --platform <platforms>', 'Target platform(s): claude-code, codex, openclaw (comma-separated)')
   .option('-d, --dir <directory>', 'Custom target directory')
+  .option('--check-config', 'Check configuration status before install', false)
   .addHelpText('after', `
 Commands:
   skills install     Install all BytePlan skills
   skills list        List all available skills
   skills installed   List installed skills
 
+说明:
+  - 所有命令会自动检查配置状态（~/.byteplan/.env）
+  - 如未配置，会提示先运行: byteplan login -u <phone> -p <password>
+  - --check-config 仅检查配置不执行安装
+
 Platforms:
   claude-code (claude)  ~/.claude/commands
   codex                 ~/.codex
   openclaw              ~/.openclaw/skills
 
 Examples:
-  byteplan skills install -p claude-code
-  byteplan skills install -p claude-code,codex,openclaw
-  byteplan skills list
+  byteplan skills list                           # 查看 skills 并显示配置状态
+  byteplan skills install -p claude-code         # 安装到 claude-code
+  byteplan skills install -p claude-code,codex   # 安装到多个平台
+  byteplan skills install --check-config         # 仅检查配置
 `);
 
 // skills install 子命令 - 安装全部
@@ -199,17 +227,41 @@ skillsCmd
   .description('Install all BytePlan skills to target platform(s)')
   .addHelpText('after', `
 Options (from parent):
-  -p, --platform   Target platform(s): claude-code, codex, openclaw
-  -d, --dir        Custom target directory
+  -p, --platform      Target platform(s): claude-code, codex, openclaw
+  -d, --dir           Custom target directory
+  --check-config      仅检查配置状态，不执行安装
 
 Examples:
   byteplan skills install -p claude-code
   byteplan skills install -p claude-code,codex
   byteplan skills install -d ~/.claude/commands
+  byteplan skills install --check-config
 `)
   .action(() => {
     try {
+      // 检查配置状态
+      const config = checkConfig();
       const parentOptions = skillsCmd.opts();
+
+      // 如果请求检查配置或未配置，显示配置状态
+      if (parentOptions.checkConfig || !config.configured) {
+        printJSON({
+          config: config.configured ? {
+            configured: true,
+            user: config.user,
+            env: config.env
+          } : {
+            configured: false,
+            configFile: envFile
+          },
+          hint: config.configured
+            ? 'Configuration found. Run without --check-config to install.'
+            : 'Please login first: byteplan login -u <phone> -p <password>'
+        });
+        if (!config.configured) process.exit(1);
+        if (parentOptions.checkConfig) process.exit(0);
+      }
+
       const resolved = resolveTargetDirs(parentOptions.platform, parentOptions.dir);
 
       if (resolved.error) {
@@ -221,6 +273,7 @@ Examples:
 
       printJSON({
         success: true,
+        config: { user: config.user, env: config.env },
         platforms: results,
         totalPlatforms: resolved.targets.length,
         totalSkills: totalSkills,
@@ -236,8 +289,11 @@ skillsCmd
   .description('List all available BytePlan skills')
   .action(() => {
     try {
+      const config = checkConfig();
       const skills = getAvailableSkills();
+
       printJSON({
+        config: config.configured ? { user: config.user, env: config.env } : { configured: false },
         skills: skills.map(s => ({ name: s.name, description: s.description })),
         total: skills.length,
       });
@@ -261,6 +317,7 @@ Examples:
 `)
   .action(() => {
     try {
+      const config = checkConfig();
       const parentOptions = skillsCmd.opts();
       const resolved = resolveTargetDirs(parentOptions.platform, parentOptions.dir);
 
@@ -280,6 +337,7 @@ Examples:
       }
 
       printJSON({
+        config: config.configured ? { user: config.user, env: config.env } : { configured: false },
         platforms: results,
         totalPlatforms: resolved.targets.length,
       });