Skip to content

命令行接口

NServe 提供了三个主要命令,用于项目的开发、构建和代码生成。

nserve serve

启动开发服务器,支持 TypeScript 实时编译和热重载功能。

语法

bash
nserve serve [options]

选项

  • --mode <mode> - 指定运行模式(development/production)
  • --config <path> - 指定配置文件路径

示例

bash
nserve serve
nserve serve --mode development
nserve serve --config ./custom.config.ts

功能说明

  • 实时编译 TypeScript 代码
  • 热重载功能,修改代码后自动重启服务器
  • 支持环境变量配置
  • 显示编译错误和警告

nserve build

构建项目,使用 esbuild 进行快速构建,生成可执行的 JavaScript 代码。

语法

bash
nserve build [options]

选项

  • --mode <mode> - 指定构建模式(development/production)
  • --config <path> - 指定配置文件路径

示例

bash
nserve build
nserve build --mode production
nserve build --config ./custom.config.ts

功能说明

  • 使用 esbuild 进行快速构建
  • 支持生产环境优化
  • 生成可执行的 JavaScript 代码
  • 输出到配置文件中指定的 outputDir 目录

nserve gen

根据配置文件生成代码,包括路由和模型相关文件。

语法

bash
nserve gen [options]

选项

  • --config <path> - 指定配置文件路径

示例

bash
nserve gen
nserve gen --config ./custom.config.ts

功能说明

  • 根据路由配置文件生成路由处理器和业务逻辑模板
  • 根据 SQL 文件生成数据模型
  • 生成路由注册文件
  • 保持现有代码不被覆盖,只生成新文件或更新必要的导入语句

命令行选项

所有 NServe 命令都支持以下通用选项:

  • -h, --help - 显示帮助信息
  • -v, --version - 显示版本信息

环境变量

NServe 支持通过环境变量配置命令行行为:

  • AICBLOCK_NSERVE_APP_ENTRY - 指定应用入口文件
  • AICBLOCK_NSERVE_OUTPUT_DIR - 指定构建输出目录
  • AICBLOCK_NSERVE_SOURCE_DIR - 指定源代码目录