esa-cli 1.0.4 → 1.0.5

package/README.md

@@ -15,7 +15,7 @@ ESA CLI is a command-line tool for building with Alibaba Cloud ESA Functions and
 
 ### Prerequisites
 
-- Node.js: 18.x or higher (supports 18.x, 20.x, 22.x)
+- Node.js: 20.x or higher (supports 20.x, 22.x)
 - OS: macOS (x86, Apple Silicon), Linux
 - Recommended to use a Node version manager like Volta or nvm to avoid permission issues and easily switch Node.js versions.
 

package/dist/commands/init/helper.js

@@ -17,7 +17,7 @@ import Haikunator from 'haikunator';
 import t from '../../i18n/index.js';
 import logger from '../../libs/logger.js';
 import Template from '../../libs/templates/index.js';
-import { execCommand } from '../../utils/command.js';
+import { execCommand, execWithLoginShell } from '../../utils/command.js';
 import { getDirName } from '../../utils/fileUtils/base.js';
 import { generateConfigFile, getCliConfig, getProjectConfig, getTemplatesConfig, templateHubPath, updateProjectConfigFile } from '../../utils/fileUtils/index.js';
 import promptParameter from '../../utils/prompt.js';
@@ -382,7 +382,7 @@ export const createProject = (initParams) => __awaiter(void 0, void 0, void 0, f
         const templateFlag = ((_a = frameworkConfig.language) === null || _a === void 0 ? void 0 : _a[initParams.language || 'typescript']) || '';
         const extraParams = frameworkConfig.params || '';
         const full = `${command} ${initParams.name} ${templateFlag} ${extraParams}`.trim();
-        const res = yield execCommand(['sh', '-lc', full], {
+        const res = yield execWithLoginShell(full, {
             interactive: true,
             startText: `Starting to execute framework command ${chalk.gray(full)}`,
             doneText: `Framework command executed  ${chalk.gray(full)}`

package/dist/commands/utils.js

@@ -93,6 +93,13 @@ export function checkIsLoginSuccess() {
                     },
                     endpoint: result.endpoint
                 });
+                api.updateConfig({
+                    auth: {
+                        accessKeyId,
+                        accessKeySecret
+                    },
+                    endpoint: result.endpoint
+                });
                 return true;
             }
         }

package/dist/docs/Commands_en.md

@@ -345,15 +345,11 @@ AccessKey ID (AK)
 **--access-key-secret, --sk** _optional_  
 AccessKey Secret (SK)
 
-**--endpoint, -e** _optional_  
-API endpoint URL Example: esa.cn-hangzhou.aliyuncs.com
-
 **Environment Variables**  
 Read from environment variables:
 
 - **ESA_ACCESS_KEY_ID**
 - **ESA_ACCESS_KEY_SECRET**
-- **ESA_ENDPOINT**
 
 ---
 

package/dist/docs/Commands_zh_CN.md

@@ -2,13 +2,31 @@
 
 **ESA CLI 提供多种命令来管理您的阿里云 ESA Functions & Pages。**
 
-**init** - 从各种 Web 框架和模板创建新项目。**
-\*\***dev** - 启动本地开发服务器。** \***\*commit** - 提交代码并保存为新版本。**
-\*\***deploy** - 将您的 Functions & Pages 部署到阿里云。** \***\*deployments** - 管理您的部署和版本。**
-\*\***project** - 管理您的 Functions & Pages 项目。** \***\*site** - 列出您已激活的站点。**
-\*\***domain** - 管理您的 Functions & Pages 的域名绑定。** \***\*route** - 管理您的 Functions & Pages 的路由绑定。**
-\*\***login** - 使用您的阿里云账户授权 ESA CLI。** \***\*logout** - 移除 ESA CLI 访问您账户的授权。**
-\*\***config** - 修改您的本地或全局配置。** \***\*lang** - 设置 CLI 的语言。
+**init** - 从各种 Web 框架和模板创建新项目。
+
+**dev** - 启动本地开发服务器。
+
+**commit** - 提交代码并保存为新版本。
+
+**deploy** - 将您的 Functions & Pages 部署到阿里云。
+
+**deployments** - 管理您的部署和版本。
+
+**project** - 管理您的 Functions & Pages 项目。
+
+**site** - 列出您已激活的站点。
+
+**domain** - 管理您的 Functions & Pages 的域名绑定。
+
+**route** - 管理您的 Functions & Pages 的路由绑定。
+
+**login** - 使用您的阿里云账户授权 ESA CLI。
+
+**logout** - 移除 ESA CLI 访问您账户的授权。
+
+**config** - 修改您的本地或全局配置。
+
+**lang** - 设置 CLI 的语言。
 
 ### 如何运行 ESA CLI 命令
 
@@ -38,12 +56,12 @@ npx esa-cli <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]
 
 ```
 {
-  ...
-  "scripts": {
-    "deploy": "esa-cli deploy",
-    "dev": "esa-cli dev"
+  ...
+  "scripts": {
+    "deploy": "esa-cli deploy",
+    "dev": "esa-cli dev"
   }
-  ...
+  ...
 }
 ```
 
@@ -63,25 +81,25 @@ npm run deploy
 esa-cli init [<NAME>] [OPTIONS]
 ```
 
-**NAME\***可选（默认：工作目录名称）\*
+**NAME** _可选（默认：工作目录名称）_
 **Functions & Pages 项目的名称。这既是目录名称，也是生成的 ESA CLI 配置中的 name 属性。**
 
-**--framework, -f\***可选\*
+**--framework, -f** _可选_
 **选择前端框架（react/vue/nextjs...）**
 
-**--language, -l\***可选\*
+**--language, -l** _可选_
 **选择编程语言（typescript/javascript）。可选：typescript | javascript**
 
-**--template, -t\***可选\*
+**--template, -t** _可选_
 **指定模板名称**
 
-**--yes, -y\***可选\*
+**--yes, -y** _可选_
 **对所有交互询问选择"是"（默认 false），模版采用helloworld**
 
-**--git\***可选\*
+**--git** _可选_
 **在项目中初始化 git**
 
-**--deploy\***可选\*
+**--deploy** _可选_
 **初始化完成后自动部署**
 
 ---
@@ -94,22 +112,22 @@ esa-cli init [<NAME>] [OPTIONS]
 esa-cli dev [<ENTRY>] [OPTIONS]
 ```
 
-**ENTRY\***可选\*
+**ENTRY** _可选_
 **函数和Pages入口文件**
 
-**--port, -p\***可选\*
+**--port, -p** _可选_
 **监听端口**
 
-**--minify, -m\***可选\*
+**--minify, -m** _可选_
 **开发模式下压缩代码（默认 false）**
 
-**--refresh-command\***可选\*
+**--refresh-command** _可选_
 **保存自动刷新前执行的命令**
 
-**--local-upstream\***可选\*
+**--local-upstream** _可选_
 **在本地开发中作为源站的主机**
 
-**--debug\***可选\*
+**--debug** _可选_
 **输出调试日志（默认 false）**
 
 ---
@@ -122,19 +140,19 @@ esa-cli dev [<ENTRY>] [OPTIONS]
 esa-cli commit [<ENTRY>] [OPTIONS]
 ```
 
-**ENTRY\***可选\*
+**ENTRY** _可选_
 **函数和Pages入口文件**
 
-**--minify, -m\***可选\*
+**--minify, -m** _可选_
 **提交前压缩代码（默认 false）**
 
-**--assets, -a\***可选\*
+**--assets, -a** _可选_
 **静态资源目录**
 
-**--description, -d\***可选\*
+**--description, -d** _可选_
 **版本/例程描述（跳过交互输入）**
 
-**--name, -n\***可选\*
+**--name, -n** _可选_
 **函数和Pages名称**
 
 ---
@@ -147,25 +165,25 @@ esa-cli commit [<ENTRY>] [OPTIONS]
 esa-cli deploy [<ENTRY>] [OPTIONS]
 ```
 
-**ENTRY\***可选\*
-**函数和Pages入口文件，默认以 **`esa.jsonc`中entry配置为准
+**ENTRY** _可选_
+**函数和Pages入口文件，默认以 `esa.jsonc`中entry配置为准**
 
-**--version, -v\***可选\*
+**--version, -v** _可选_
 **指定要部署的版本（跳过交互选择）**
 
-**--environment, -e\***可选\*
+**--environment, -e** _可选_
 **部署环境。可选：staging | production**
 
-**--name, -n\***可选\*
+**--name, -n** _可选_
 **函数和Pages名称**
 
-**--assets, -a\***可选\*
+**--assets, -a** _可选_
 **静态资源目录（例如：./dist）**
 
-**--description, -d\***可选\*
+**--description, -d** _可选_
 **版本描述**
 
-**--minify, -m\***可选\*
+**--minify, -m** _可选_
 **是否压缩代码**
 
 ---
@@ -190,7 +208,7 @@ esa-cli deployments list
 esa-cli deployments delete [<DEPLOYMENT_ID>...] [OPTIONS]
 ```
 
-**DEPLOYMENT_ID\***必需\*
+**DEPLOYMENT_ID** _必需_
 **要删除的部署版本ID（可一次传多个）**
 
 ---
@@ -215,7 +233,7 @@ esa-cli project list
 esa-cli project delete <PROJECT_NAME> [OPTIONS]
 ```
 
-**PROJECT_NAME\***必需\*
+**PROJECT_NAME** _必需_
 **要删除的函数或Pages名称**
 
 ---
@@ -248,7 +266,7 @@ esa-cli domain add <DOMAIN> [OPTIONS]
 
 **只有在该账号下激活的站点才能绑定**
 
-**DOMAIN\***必需\*
+**DOMAIN** _必需_
 **要绑定的域名（在该账号站点下已激活）**
 
 ### domain list
@@ -267,7 +285,7 @@ esa-cli domain list
 esa-cli domain delete <DOMAIN> [OPTIONS]
 ```
 
-**DOMAIN\***必需\*
+**DOMAIN** _必需_
 **要删除绑定的域名**
 
 ---
@@ -284,23 +302,24 @@ esa-cli domain delete <DOMAIN> [OPTIONS]
 esa-cli route add [<ROUTE>] [<SITE>] [OPTIONS]
 ```
 
-**ROUTE\***可选\*
+**ROUTE** _可选_
 **路由值，例如：example.com/_ 或 _.example.com/\***
 
-**SITE\***可选\*
+**SITE** _可选_
 **站点名称，例如：example.com**
 
 **只有在该账号下激活的站点才能绑定**
 
-**--route, -r\***可选*路由值，例如：example.com/*
+**--route, -r** _可选_
+**路由值，例如：example.com/\***
 
-- **主机名支持以 **`*` 开头表示后缀匹配（如：`*.example.com`）
-- **路径支持以 **`*` 结尾表示前缀匹配（如：`/api/*`）
+- **主机名支持以 `*` 开头表示后缀匹配（如：`*.example.com`）**
+- **路径支持以 `*` 结尾表示前缀匹配（如：`/api/*`）**
 
-**--site, -s\***可选\*
+**--site, -s** _可选_
 **站点名称（需为账户下已激活站点）**
 
-**--alias, -a\***可选\*
+**--alias, -a** _可选_
 **路由名称（别名）例如：apple、orange等**
 
 ### route list
@@ -319,7 +338,7 @@ esa-cli route list
 esa-cli route delete <ROUTE_NAME> [OPTIONS]
 ```
 
-**ROUTE_NAME\***必需\*
+**ROUTE_NAME** _必需_
 **要删除的路由名称**
 
 ---
@@ -332,20 +351,16 @@ esa-cli route delete <ROUTE_NAME> [OPTIONS]
 esa-cli login [OPTIONS]
 ```
 
-**--access-key-id, --ak\***可选\*
+**--access-key-id, --ak** _可选_
 **AccessKey ID (AK)**
 
-**--access-key-secret, --sk\***可选\*
+**--access-key-secret, --sk** _可选_
 **AccessKey Secret (SK)**
 
-**--endpoint, -e\***可选\*
-**API 端点 URL 例子: esa.cn-hangzhou.aliyuncs.com**
-
-**环境变量**从环境变量中读取：
+**环境变量** _从环境变量中读取：_
 
 - **ESA_ACCESS_KEY_ID**
 - **ESA_ACCESS_KEY_SECRET**
-- **ESA_ENDPOINT**
 
 ---
 
@@ -367,10 +382,10 @@ esa-cli logout
 esa-cli config [OPTIONS]
 ```
 
-**--local, -l\***可选\*
+**--local, -l** _可选_
 **编辑本地配置文件（默认 false）**
 
-**--global, -g\***可选\*
+**--global, -g** _可选_
 **编辑全局配置文件（默认 false）**
 
 ---

package/dist/index.js

@@ -24,6 +24,7 @@ import routeCommand from './commands/route/index.js';
 import routine from './commands/routine/index.js';
 import site from './commands/site/index.js';
 import t from './i18n/index.js';
+import logger from './libs/logger.js';
 import { handleCheckVersion, checkCLIVersion } from './utils/checkVersion.js';
 import { getCliConfig } from './utils/fileUtils/index.js';
 const main = () => __awaiter(void 0, void 0, void 0, function* () {
@@ -40,6 +41,9 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
         .wrap(null)
         .help()
         .middleware((argv) => __awaiter(void 0, void 0, void 0, function* () {
+        if (argv.debug) {
+            logger.setLogLevel('debug');
+        }
         try {
             // Pass current command (first positional) so version check can decide prompting behavior
             yield checkCLIVersion((argv._ && argv._[0] ? String(argv._[0]) : ''));
@@ -57,6 +61,11 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
         .options('help', {
         describe: t('main_help_describe').d('Show help'),
         alias: 'h'
+    })
+        .options('debug', {
+        describe: t('dev_option_debugger').d('Output debug logs'),
+        type: 'boolean',
+        default: false
     });
     esa.command('*', false, () => { }, (args) => {
         if (args._.length > 0) {

package/dist/libs/api.js

@@ -11,6 +11,7 @@ import ESA, * as $ESA from '@alicloud/esa20240910';
 import * as $OpenApi from '@alicloud/openapi-client';
 import * as $Util from '@alicloud/tea-util';
 import { getApiConfig } from '../utils/fileUtils/index.js';
+import { CLI_USER_AGENT } from './constants.js';
 import logger from './logger.js';
 class Client {
     constructor() {
@@ -77,7 +78,8 @@ class Client {
         const apiConfig = new $OpenApi.Config({
             accessKeyId: (_a = config.auth) === null || _a === void 0 ? void 0 : _a.accessKeyId,
             accessKeySecret: (_b = config.auth) === null || _b === void 0 ? void 0 : _b.accessKeySecret,
-            endpoint: config.endpoint
+            endpoint: config.endpoint,
+            userAgent: CLI_USER_AGENT
         });
         return new ESA.default(apiConfig);
     }

package/dist/libs/apiService.js

@@ -12,6 +12,7 @@ import FormData from 'form-data';
 import fetch from 'node-fetch';
 import t from '../i18n/index.js';
 import { getApiConfig } from '../utils/fileUtils/index.js';
+import { CLI_USER_AGENT } from './constants.js';
 import { Environment } from './interface.js';
 export class ApiService {
     constructor(cliConfig) {
@@ -19,7 +20,8 @@ export class ApiService {
         let apiConfig = new $OpenApi.Config({
             accessKeyId: (_a = cliConfig.auth) === null || _a === void 0 ? void 0 : _a.accessKeyId,
             accessKeySecret: (_b = cliConfig.auth) === null || _b === void 0 ? void 0 : _b.accessKeySecret,
-            endpoint: cliConfig.endpoint
+            endpoint: cliConfig.endpoint,
+            userAgent: CLI_USER_AGENT
         });
         this.client = new $OpenApi.default.default(apiConfig);
     }
@@ -37,7 +39,8 @@ export class ApiService {
         let apiConfig = new $OpenApi.Config({
             accessKeyId: (_a = newConfig.auth) === null || _a === void 0 ? void 0 : _a.accessKeyId,
             accessKeySecret: (_b = newConfig.auth) === null || _b === void 0 ? void 0 : _b.accessKeySecret,
-            endpoint: newConfig.endpoint
+            endpoint: newConfig.endpoint,
+            userAgent: CLI_USER_AGENT
         });
         this.client = new $OpenApi.default.default(apiConfig);
     }

package/dist/libs/constants.js

@@ -0,0 +1,13 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const packageJson = require('../../package.json');
+/**
+ * CLI User-Agent string for API requests
+ * Format: esa-cli/{version}
+ * This helps identify requests originating from the CLI
+ */
+export const CLI_USER_AGENT = `esa-cli/${packageJson.version}`;
+/**
+ * CLI version from package.json
+ */
+export const CLI_VERSION = packageJson.version;

package/dist/utils/command.js

@@ -8,13 +8,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { spawn } from 'child_process';
+import { platform } from 'os';
 import { cancel, spinner } from '@clack/prompts';
 import chalk from 'chalk';
+export const isWindows = platform() === 'win32';
 /**
  * Execute a shell command with rich options (spinner, capture, env, cwd).
  */
 export const execCommand = (command_1, ...args_1) => __awaiter(void 0, [command_1, ...args_1], void 0, function* (command, options = {}) {
-    const { startText, doneText, silent = false, captureOutput = false, useSpinner = true, realtimeOutput = false, interactive = false, env, cwd, transformOutput, fallbackOutput, errorMessage } = options;
+    const { startText, doneText, silent = false, captureOutput = false, useSpinner = true, realtimeOutput = false, interactive = false, env, cwd, transformOutput, fallbackOutput, errorMessage, shell = false } = options;
     // Determine stdio mode based on options
     // If realtimeOutput is true, we need to pipe to capture and display output in real-time
     // If spinner is used without realtimeOutput, pipe to avoid TTY contention
@@ -55,7 +57,7 @@ export const execCommand = (command_1, ...args_1) => __awaiter(void 0, [command_
                 stdio,
                 cwd,
                 env: Object.assign(Object.assign({}, process.env), env),
-                shell: false
+                shell
             });
             if (stdio === 'pipe') {
                 (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.on('data', (chunk) => {
@@ -146,4 +148,21 @@ export const execCommand = (command_1, ...args_1) => __awaiter(void 0, [command_
         return { success: false, stdout, stderr };
     }
 });
+/**
+ * Execute a command with login shell on Unix (to load ~/.profile, ~/.zshrc etc.)
+ * On Windows, directly execute the command since login shell is not typically needed.
+ *
+ * @param commandStr - The full command string to execute
+ * @param options - ExecCommandOptions
+ */
+export const execWithLoginShell = (commandStr_1, ...args_1) => __awaiter(void 0, [commandStr_1, ...args_1], void 0, function* (commandStr, options = {}) {
+    if (isWindows) {
+        // Windows: use cmd /c to execute the command
+        return execCommand(['cmd', '/c', commandStr], options);
+    }
+    else {
+        // Unix: use login shell to ensure PATH is properly set (nvm, fnm, etc.)
+        return execCommand(['sh', '-lc', commandStr], options);
+    }
+});
 export default execCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esa-cli",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A CLI for operating Alibaba Cloud ESA Functions and Pages.",
   "main": "bin/enter.cjs",
   "type": "module",