@nasl/cli 0.1.17 → 0.1.19

package/README.md

@@ -7,12 +7,12 @@ NASL 语言的命令行工具，提供编译、检查、开发服务等功能。
 ## 安装
 
 ```bash
-pnpm install -g @nasl/cli
+npm install -g @nasl/cli
 ```
 
 ## 使用
 
-### 初始化配置
+### 初始化配置（nasl init）
 
 ```bash
 nasl init
@@ -22,16 +22,15 @@ nasl init
 
 ```json
 {
-  "serverBaseURL": "https://nasl.lcap.163yun.com/api/v1/nasl", // NASL 编译服务的基础 URL
+  "serverBaseURL": "https://nasl.lcap.163yun.com", // NASL 编译服务的基础 URL
   "representation": "NaturalTS", // NASL 语言的表示
   "namespaceResolution": "filename-as-namespace", // 命名空间解析策略
-  "ideVersion": "4.1", // IDE 版本
+  "ideVersion": "4.4", // IDE 版本
   "srcDir": "src", // 源代码目录
   "outDir": "out" // 输出目录
 }
 ```
 
-
 ### 入口文件说明
 
 下面的命令中均支持 [entry] 参数，表示入口文件：
@@ -47,7 +46,7 @@ nasl init
 - 会自动进行依赖分析，收集所有依赖的文件
 - 依赖的页面文件（.tsx）不会继续进行依赖分析，而是直接提取签名，以提高性能
 
-### 编译 NASL 代码
+### 编译 NASL 代码（nasl compile 或 naslc）
 
 ```bash
 # 编译整个 src 目录
@@ -63,7 +62,7 @@ naslc "src/app.logics.*.ts"
 naslc "src/*.tsx"
 ```
 
-### 检查 NASL 代码
+### 检查 NASL 代码（nasl check）
 
 ```bash
 # 检查整个 src 目录
@@ -77,7 +76,7 @@ nasl check "src/app.logics.*.ts"
 nasl check "src/*.tsx"
 ```
 
-### 依赖分析
+### 依赖分析（nasl dep）
 
 建议指定入口文件，否则会扫描整个 src 目录，输出量较大。
 
@@ -89,13 +88,19 @@ nasl dep "src/*.tsx"
 nasl dep
 ```
 
-### 启动开发服务
+### 启动开发服务（nasl dev）
 
 ```bash
 nasl dev
 ```
 
-启动开发服务后，默认可以访问 http://localhost:3100 查看预览效果。
+启动开发服务后，默认访问 http://localhost:3100 查看预览效果。
+
+可以用 --port 和 --host 更换端口号和主机名。
+
+```bash
+nasl dev --port 4900 --host 0.0.0.0
+```
 
 dev 进程始终保持运行，规则如下：
 
@@ -109,7 +114,106 @@ dev 进程始终保持运行，规则如下：
   2. src 被创建：自动编译生成 out 目录
   3. src 被删除: 使用缓存的 out 目录
 
-## 开发 CLI 工具
+### 构建项目（nasl build）
+
+与 nasl dev 对应，构建成最终用于浏览器的 dist 产物。
+
+```bash
+# 使用生产模式构建（默认）
+nasl build
+
+# 使用开发模式构建
+nasl build --mode development
+
+# 构建指定入口文件及其依赖
+nasl build src/app.frontendTypes.pc.frontends.pc.views.dashboard.tsx
+```
+
+### 转换文件格式（nasl transform）
+
+```bash
+# files2full: 将 src 中的文件组合成 fullNaturalTS
+nasl transform files2full [entry] --output [outputPath]
+# 默认输出到 ./full-natural.ts
+
+# json2files: 将 JSON 文件转换成 src 的 files
+nasl transform json2files [jsonFile] --output [outputPath]
+# 如果不指定 jsonFile，将按照默认 IDE 版本的基础模板转换
+
+# files2json: 将 src 中的文件转换成一个 JSON（待实现）
+nasl transform files2json [entry] --output [outputPath]
+# 默认输出到 ./files.json
+```
+
+### 在 IDE 中直接创建应用（nasl create-app-in-ide）
+
+**注意**：目前该命令不支持 useOPENAPI 模式，只在测试环境使用。
+
+```bash
+# 会询问确认（默认）
+nasl create-app-in-ide [entry]
+
+# 跳过确认，直接执行
+nasl create-app-in-ide [entry] --quiet
+
+# 显示详细信息
+nasl create-app-in-ide [entry] --verbose
+```
+
+此命令会将当前项目的 NASL 代码上传到远程服务，在 IDE 中创建新的应用。默认会询问用户确认，使用 `--quiet` 选项可以跳过确认。
+
+## 环境变量配置
+
+除了在 `nasl.config.json` 中配置外，也可以通过环境变量来配置部分选项。
+
+**环境变量的优先级高于配置文件**，如果同时设置了环境变量和配置文件，将使用环境变量的值。
+
+### 支持的环境变量
+
+- `NASL_IDE_VERSION`: IDE 版本号，对应配置`ideVersion`字段
+  ```bash
+  export NASL_IDE_VERSION=4.4
+  ```
+
+- `NASL_SERVER_BASE_URL`: NASL 编译服务的基础 URL，对应配置`serverBaseURL`字段
+  ```bash
+  export NASL_SERVER_BASE_URL=https://nasl.lcap.163yun.com
+  ```
+
+- `USE_LCAP_OPENAPI`: 是否使用 OpenAPI 方式调用（值为 `'true'` 时启用），对应配置`useOPENAPI`字段
+  ```bash
+  export USE_LCAP_OPENAPI=true
+  ```
+
+- `LCAP_OPENAPI_AK`: LCAP OpenAPI Access Key（使用 OpenAPI 时必需），对应配置`OPENAPI_AK`字段
+  ```bash
+  export LCAP_OPENAPI_AK=your_access_key
+  ```
+
+- `LCAP_OPENAPI_SK`: LCAP OpenAPI Secret Key（使用 OpenAPI 时必需），对应配置`OPENAPI_SK`字段
+  ```bash
+  export LCAP_OPENAPI_SK=your_secret_key
+  ```
+
+### 配置文件示例（包含 OpenAPI 配置）
+
+```json
+{
+  "serverBaseURL": "https://sometenant.codewave.163.com",
+  "representation": "NaturalTS",
+  "namespaceResolution": "filename-as-namespace",
+  "ideVersion": "4.4",
+  "srcDir": "src",
+  "outDir": "out",
+  "useOPENAPI": true,
+  "OPENAPI_AK": "your_access_key",
+  "OPENAPI_SK": "your_secret_key"
+}
+```
+
+注意：如果配置了 `useOPENAPI: true`，则必须同时配置 `OPENAPI_AK` 和 `OPENAPI_SK`（可在配置文件中配置，或通过环境变量 `LCAP_OPENAPI_AK` 和 `LCAP_OPENAPI_SK` 配置）。
+
+## DEVELOPMENT
 
 ```bash
 # 安装依赖