electerm-data-tool 1.101.16 → 1.101.17

package/README.md

@@ -51,6 +51,39 @@ Available commands:
 - `--help` - Show help information
 - `--version` - Show version number
 
+Available options:
+
+- `-d, --data-path <path>` - Custom path to electerm data directory (for portable installations)
+
+### Custom Data Path (Portable Support)
+
+For portable installations where Electerm data is stored in a custom location, use the `--data-path` option:
+
+```bash
+# Export data from custom location
+electerm-data-tool --data-path /path/to/portable/electerm export backup.json
+
+# Migrate data in custom location
+electerm-data-tool --data-path /path/to/portable/electerm migrate
+
+# Check info for custom location
+electerm-data-tool --data-path /path/to/portable/electerm info
+```
+
+**Examples:**
+```bash
+# Windows portable installation
+electerm-data-tool --data-path "C:\PortableApps\Electerm\Data" export backup.json
+
+# macOS custom installation
+electerm-data-tool --data-path "/Volumes/USB/electerm-data" migrate
+
+# Linux custom installation
+electerm-data-tool --data-path "/opt/electerm/data" info
+```
+
+The tool will validate that the specified path exists before proceeding.
+
 ### 1. Database Migration
 
 Migrate your Electerm database from v1 (NeDB) to v2 (SQLite):
@@ -145,6 +178,39 @@ The exported JSON follows this structure:
 - The `passwordEncrypted` flag is removed from exported data
 - Exported passwords are human-readable for backup purposes
 
+## Environment Variables
+
+The tool supports the following environment variables for configuration:
+
+### `APP_PATH` (Legacy)
+
+Sets the base application data directory. This is the legacy method still supported for backward compatibility.
+
+```bash
+APP_PATH=/custom/path electerm-data-tool info
+```
+
+### Data Path Priority
+
+The tool uses the following priority order for determining the data path:
+
+1. **`--data-path` option** (highest priority) - Command-line argument
+2. **`APP_PATH` environment variable** - Legacy support
+3. **Default platform path** (lowest priority) - System default
+
+**Examples:**
+```bash
+# Using command-line option (recommended)
+electerm-data-tool --data-path /path/to/data info
+
+# Using environment variable (legacy)
+APP_PATH=/path/to/data electerm-data-tool info
+
+# Command-line option overrides environment variable
+APP_PATH=/path/one electerm-data-tool --data-path /path/two info
+# Will use /path/two
+```
+
 ## Requirements
 
 - **Node.js**: 16.0.0 or higher

package/README.zh-CN.md

@@ -51,6 +51,39 @@ electerm-data-tool [command] [options]
 - `--help` - 显示帮助信息
 - `--version` - 显示版本号
 
+可用选项：
+
+- `-d, --data-path <路径>` - 指定 Electerm 数据目录（便携版/自定义路径支持）
+
+### 自定义数据路径（便携版支持）
+
+对于便携版或 Electerm 数据存储在自定义位置的情况，可通过 `--data-path` 选项指定数据目录：
+
+```bash
+# 从自定义目录导出数据
+electerm-data-tool --data-path /path/to/portable/electerm export backup.json
+
+# 迁移自定义目录数据
+electerm-data-tool --data-path /path/to/portable/electerm migrate
+
+# 查看自定义目录信息
+electerm-data-tool --data-path /path/to/portable/electerm info
+```
+
+**示例：**
+```bash
+# Windows 便携版
+electerm-data-tool --data-path "C:\\PortableApps\\Electerm\\Data" export backup.json
+
+# macOS U 盘
+electerm-data-tool --data-path "/Volumes/USB/electerm-data" migrate
+
+# Linux 自定义安装
+electerm-data-tool --data-path "/opt/electerm/data" info
+```
+
+工具会校验指定路径是否存在。
+
 ### 1. 数据库迁移
 
 将 Electerm 数据库从 v1 (NeDB) 迁移到 v2 (SQLite)：
@@ -148,6 +181,41 @@ electerm-data-tool info
 迁移时 NeDB 文件会自动备份为：
 - `electerm.bookmarks.nedb-{timestamp}.bak`
 
+### 数据路径优先级
+
+Electerm 数据工具会按如下优先级查找数据目录：
+
+1. `--data-path` 命令行参数（最高优先级）
+2. `APP_PATH` 环境变量（兼容旧用法）
+3. 默认平台路径（最低优先级）
+
+**示例：**
+```bash
+# 推荐：命令行参数
+electerm-data-tool --data-path /path/to/data info
+
+# 兼容旧用法：环境变量
+APP_PATH=/path/to/data electerm-data-tool info
+
+# 命令行参数优先生效
+APP_PATH=/path/one electerm-data-tool --data-path /path/two info
+# 实际使用 /path/two
+```
+
+## 环境变量
+
+工具支持如下环境变量进行配置：
+
+### `APP_PATH`（兼容旧用法）
+
+设置应用数据目录（旧用法，仍然兼容）：
+
+```bash
+APP_PATH=/custom/path electerm-data-tool info
+```
+
+如需便携/自定义目录，推荐使用 `--data-path` 选项。
+
 ## 示例流程
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electerm-data-tool",
-  "version": "1.101.16",
+  "version": "1.101.17",
   "description": "electerm data export/migrate tool",
   "main": "src/index.js",
   "bin": {

package/src/common/app-props.js

@@ -17,7 +17,22 @@ function getAppPath () {
   }
 }
 
-exports.appPath = process.env.APP_PATH || getAppPath()
+function getElectermDataPath () {
+  // Priority order:
+  // 1. ELECTERM_DATA_PATH (set by --data-path option)
+  // 2. APP_PATH (legacy environment variable)
+  // 3. Default platform-specific path
+  if (process.env.ELECTERM_DATA_PATH) {
+    return process.env.ELECTERM_DATA_PATH
+  }
+  return process.env.APP_PATH || getAppPath()
+}
+
+// Use a getter to ensure we always get the current path
+Object.defineProperty(exports, 'appPath', {
+  get: getElectermDataPath
+})
+
 exports.defaultUserName = 'default_user'
 exports.packInfo = {
   version

package/src/index.js

@@ -27,6 +27,26 @@ program
   .name('electerm-data-tool')
   .description('CLI tool for electerm data migration and export')
   .version(pkg.version)
+  .option('-d, --data-path <path>', 'Custom path to electerm data directory (for portable installations)')
+  .hook('preAction', (thisCommand) => {
+    // Set custom data path if provided
+    if (thisCommand.opts().dataPath) {
+      const { existsSync } = require('fs')
+      const { resolve } = require('path')
+
+      const customPath = resolve(thisCommand.opts().dataPath)
+
+      // Validate that the custom path exists
+      if (!existsSync(customPath)) {
+        console.error(`❌ Custom data path does not exist: ${customPath}`)
+        console.error('   Please ensure the directory exists or check the path.')
+        process.exit(1)
+      }
+
+      process.env.ELECTERM_DATA_PATH = customPath
+      console.log(`📁 Using custom data path: ${customPath}`)
+    }
+  })
 
 /**
  * Migration command - migrates from NeDB (v1) to SQLite (v2)
@@ -48,6 +68,11 @@ program
       }
 
       log.info('Starting migration process...')
+
+      // Show the data path being used
+      const { appPath } = require('./common/app-props')
+      console.log(`📁 Data path: ${appPath}`)
+
       await migrate()
       log.info('Migration completed successfully!')
       console.log('✅ Migration from NeDB to SQLite completed successfully!')
@@ -69,6 +94,10 @@ program
     try {
       log.info('Starting data export...')
 
+      // Show the data path being used
+      const { appPath } = require('./common/app-props')
+      console.log(`📁 Data path: ${appPath}`)
+
       // Check if migration is needed to determine which database to use
       const { checkMigrate } = require('./migrate/migrate-1-to-2')
       const shouldMigrate = checkMigrate()
@@ -172,6 +201,12 @@ program
   .description('Display information about the current electerm data')
   .action(async () => {
     try {
+      // Show the data path being used
+      const { appPath } = require('./common/app-props')
+      console.log('📊 Electerm Data Information')
+      console.log(`📁 Data path: ${appPath}`)
+      console.log('='.repeat(50))
+
       // Check if migration is needed to determine which database to use
       const { checkMigrate } = require('./migrate/migrate-1-to-2')
       const shouldMigrate = checkMigrate()
@@ -206,9 +241,8 @@ program
       }
 
       const { dbAction, tables } = dbModule
-      console.log('📊 Electerm Data Information')
       console.log(`Database Type: ${dbType}`)
-      console.log('='.repeat(40))
+      console.log('='.repeat(50))
 
       let totalRecords = 0
       for (const table of tables) {
@@ -222,7 +256,7 @@ program
         }
       }
 
-      console.log('='.repeat(40))
+      console.log('='.repeat(50))
       console.log(`Total Records: ${totalRecords}`)
     } catch (error) {
       console.error('❌ Failed to read data:', error.message)