# 10.2 CLI 命令行使用

:::tip 概述
CLI 入口 `cmd/gen`，经 make 目标调用。核心参数 `-tables`（必填，表名|表注释）与 `-preview`（仅预览不落盘）。
:::

## 常用命令

```bash
# 生成（后端四件套 + 前端 + 菜单/字典/路由副作用）
make gen TABLES="gin_example|示例表"

# 多表
make gen TABLES="gin_order|订单,gin_order_item|订单明细"

# 预览（打印到 stdout，不落盘、不注册菜单/路由）
make gen-preview TABLES="gin_example|示例表"

# Windows
make.bat gen TABLES="gin_example|示例表"

# 直接调用
go run ./cmd/gen -tables "gin_example|示例表"
go run ./cmd/gen -tables "gin_example|示例表" -preview
```

## 参数说明

| 参数 | 必填 | 说明 |
|---|---|---|
| -tables | 是 | `表名|表注释`，多表英文逗号分隔；表注释进文件头与菜单名 |
| -preview | 否 | 仅预览，不落盘、不注册副作用 |

## 执行序列

```text
配置加载 → 必填校验 → 日志初始化 → 数据库连接（仅内省，不触发 Redis/调度器）
→ 解析 tables → 预览打印 或 生成落盘 + 副作用
```

退出码：0 全部成功；1 参数/配置/执行失败——可直接进 CI/脚本。

## 表注释的作用

`gin_order|订单` 中的"订单"会出现在：

- 生成文件的头部注释
- 菜单名称（"订单管理"由模板拼装）
- RouteSpec 的 Summary/Log 文案基底

**建表时把 COMMENT 写好**，生成产物质量直接提升一档。

## 典型工作流

```text
① 建表（COMMENT 写全）
② make gen-preview 核对产物
③ make gen 落盘
④ 重启服务（路由注册生效）
⑤ 页面验证 + 按需微调
```

## 相关

- [10.3 Web 管理界面](/zh/generator/web-ui.html)
- [10.6 配置与覆盖策略](/zh/generator/config.html)