AgileBuilder logoAgileBuilder
返回文档

CLI 参考手册

AgileBuilder 命令行工具完整文档

本文档包含 AgileBuilder CLI 的所有命令和选项。

全局选项

agilebuilder [command] [options]

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

命令列表

ui

启动本地管理界面：

agilebuilder ui [options]

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

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 projectName=my-app \
  --var useTypeScript=true \
  -y

template

模板管理命令：

agilebuilder template <subcommand>

子命令：
  list                   列出所有模板
  add <url>              从 Git URL 添加模板
  remove <name>          删除模板
  create <path>          从现有项目创建模板
  info <name>            查看模板详情
  update <name>          更新模板

template add

agilebuilder template add <url> [options]

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

template create

agilebuilder template create <path> [options]

选项：
  --name <name>         模板名称 (必填)
  --desc <description>  模板描述
  --include <pattern>   包含的文件模式
  --exclude <pattern>   排除的文件模式

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                  重置为默认配置

环境变量

| 变量 | 描述 | 默认值 | |------|------|--------| | AGILEBUILDER_HOME | 数据目录 | ~/.agilebuilder | | AGILEBUILDER_PORT | UI 端口 | 3456 | | AGILEBUILDER_MCP_PORT | MCP 端口 | 3457 |

退出码

| 码 | 描述 | |-----|------| | 0 | 成功 | | 1 | 一般错误 | | 2 | 参数错误 | | 3 | 模板不存在 | | 4 | 生成失败 |

下一步