CLI

AgileBuilder 命令行工具

概述

AgileBuilder CLI 是功能完整的命令行工具,支持项目生成、模板管理、本地 UI 启动、MCP 服务管理等功能。

CLI 界面


全局选项

agilebuilder [command] [options]

选项:
  -v, --version    显示版本号
  -h, --help       显示帮助信息
  --verbose        显示详细日志
  --no-color       禁用彩色输出

常用命令

generate - 生成项目

agilebuilder generate <template> <output> [options]

参数:
  template    模板名称或路径
  output      输出目录

选项:
  -y, --yes              跳过确认提示
  --no-hooks             不执行 hooks
  --var <key=value>      指定变量值

示例:
  agilebuilder generate react-starter my-app
  agilebuilder generate react-starter my-app --var useTypeScript=true -y

template - 模板管理

agilebuilder template <subcommand>

子命令:
  list                   列出所有模板
  add <url>              从 Git URL 添加模板
  remove <name>          删除模板
  create <path>          从现有项目创建模板
  info <name>            查看模板详情
  sync                   同步云端模板

template add

agilebuilder template add <url> [options]

选项:
  --name <name>         指定模板名称
  --branch <branch>     指定 Git 分支

template create

agilebuilder template create <path> [options]

选项:
  --name <name>         模板名称
  --desc <description>  模板描述

ui - 启动本地 UI

agilebuilder ui [options]

选项:
  -p, --port <port>    指定端口号 (默认: 3456)
  --no-open            不自动打开浏览器

mcp - MCP 服务管理

agilebuilder mcp <subcommand>

子命令:
  start                  启动 MCP 服务
  stop                   停止 MCP 服务
  status                 查看服务状态

mcp start

agilebuilder mcp start [options]

选项:
  -p, --port <port>     指定端口号 (默认: 3457)
  --daemon              后台运行

config - 配置管理

agilebuilder config <subcommand>

子命令:
  list                   列出所有配置
  get <key>              获取配置值
  set <key> <value>      设置配置值
  reset                  重置为默认配置

login/logout - 登录登出

# 登录
agilebuilder login
agilebuilder login --email your@email.com

# 登出
agilebuilder logout

# 查看登录状态
agilebuilder status

环境变量

变量说明默认值
AGILEBUILDER_HOME数据目录~/.agilebuilder
AGILEBUILDER_PORTUI 端口3456
AGILEBUILDER_MCP_PORTMCP 端口3457

退出码

说明
0成功
1一般错误
2参数错误
3模板不存在
4生成失败

配置文件

CLI 配置文件位于 ~/.agilebuilder/config.json

{
  "templateDir": "~/my-templates",
  "defaultPackageManager": "pnpm",
  "mcpPort": 3457,
  "uiPort": 3456
}

下一步