TMaker 命令参考

完整的 CLI 命令列表、参数说明和使用示例

⚠️ 重要提示

所有 TMaker 命令必须在 TMaker 运行根目录执行（包含 templates/ 与 config.json）。

create

简写: c

创建模板（简化）

创建基础模板结构（简化模式）。适合快速开始。

用法

tmaker create [--full]

参数

必需

模板 ID（例如：001, mytemplate）

选项

--full, -f

创建完整模板（包含默认页面与布局组件）

示例

tmaker create mysite

创建简化模板

mk c mysite -f

创建完整模板

创建的文件

  • template.json - 模板配置文件
  • css/site.css - Tailwind CSS v4 配置
  • js/site.js - 自定义脚本
  • tailwind.config.js - Tailwind 配置
  • package.json - NPM 依赖配置

初始化后的步骤

cd templates/
npm install
cd ../..
tmaker render

💡 小贴士

  • • 简化模式只创建必要布局组件
  • • 完整模板可使用 template create

template

简写: t

模板管理

列出、查看或清理本地模板。

用法

tmaker template

子命令

list ls

列出所有可用模板

tmaker template list
info i

显示模板详细信息

tmaker template info
create c

创建完整模板（默认 full 模式）

tmaker template create [--simplified]
clean cl

清理模板内的临时或无用文件

tmaker template clean [--dry-run] [--yes] [--include-temp]

示例

tmaker template list

列出所有模板

mk t i 001

查看模板 001 详情

tmaker template clean mysite --dry-run

扫描清理候选文件

render

简写: r

渲染模板为 HTML

将 .sbn 或 TemplatePage 的 .html 渲染为静态 HTML 文件。

用法

tmaker render [options]

参数

必需

模板 ID

选项

--page, -p

只渲染指定页面（可选）

示例

tmaker render 001

渲染模板 001 的所有页面

mk r 001 -p home

只渲染 home 页面

输出： 生成文件保存到 templates_outputs//

💡 小贴士

  • • 修改模板或数据后需要重新渲染
  • • TemplatePage 使用 .html 内容作为正文

preview

简写: p

启动预览服务器

启动本地服务器预览已渲染的 HTML 文件。

用法

tmaker preview [options]

参数

必需

模板 ID

选项

--port, -p

指定端口（默认：1688）

示例

tmaker preview 001

默认端口预览

mk p 001 -p 3000

指定端口预览

访问： 在浏览器中打开 http://localhost:1688（或指定端口）

💡 小贴士

  • • 预览前需要先运行 render
  • • 修改内容后需重新渲染

fetch

简写: f

从远程下载模板

从 AiCms API 服务器下载模板配置与资源到本地。

用法

tmaker fetch [--name ]

参数

必需

远程模板名称

选项

--name, -n

自定义本地模板目录名称

示例

tmaker fetch MyTemplate

下载模板到本地

mk f MyTemplate -n LocalTemplate

指定本地目录名称

要求： 需要先使用 login 命令登录

💡 小贴士

  • • 默认会下载页面、组件和分类树
  • • 同步后建议运行 render 检查输出

publish

简写: pub

发布模板到远程

将本地模板上传到 AiCms API 服务器，包括页面、组件与资源。

用法

tmaker publish [options]

参数

必需

本地模板 ID

选项

--name, -n

远程模板名称（默认与 ID 相同）

--no-resources, -nr

不上传资源文件

--force, -f

强制模式

--resource-type, -rt, -r

只发布指定类型资源

--media-type, -mt, -m

媒体类型过滤

--image-path, -ip

指定图片路径过滤

资源类型

  • all - 所有资源（默认）
  • page - 只发布页面
  • component - 只发布组件模板
  • categorytree - 只发布分类树
  • media - 只发布媒体资源（CSS/JS）

示例

tmaker publish 001

发布模板 001

mk pub 001 -r page

只发布页面

要求： 需要先使用 login 命令登录

💡 小贴士

  • • 发布会覆盖远程同名模板
  • • 可按资源类型分批发布

login

简写: l

登录 AiCms API

登录并保存访问令牌用于 fetch 与 publish。

用法

tmaker login [options]

选项

--username, -u

用户名（可选）

--password, -p

密码（可选）

示例

tmaker login

交互式登录

mk l -u admin@example.com -p ******

命令行登录

💡 小贴士

  • • 令牌有效期取决于服务器配置
  • • 不要提交 config.json 到仓库

logout

简写: lo

退出登录

清除保存的访问令牌。

用法

tmaker logout

示例

tmaker logout

清除令牌

mk lo

使用简写

license

简写: lic

查看许可证状态

显示本地许可证信息与有效期。

用法

tmaker license

示例

tmaker license

查看许可证状态

image-generate

简写: ig

生成图片资源

读取 image/ 目录下的 .prompt.json 并生成图片。

用法

tmaker image-generate [options]

参数

必需

模板 ID

选项

--force, -f

强制覆盖已存在图片

--path, -p

只生成指定目录或文件

示例

tmaker image-generate 001

生成全部图片

mk ig 001 -p blog/

只生成 blog 目录

要求

  • 需要配置图像生成服务 API Key（如 Volcano）

全局选项

以下选项适用于所有命令

--lang, --language

强制使用指定语言（en, zh, english, chinese）

tmaker --lang zh render 001
--workspace

指定工作区路径

tmaker --workspace /path/to/project render 001
--help, -h

显示命令帮助信息

tmaker render --help
--version, -v

显示版本信息

tmaker --version

常用工作流程

从零创建新模板

cd TMaker
tmaker create mytemplate
cd templates/mytemplate
npm install
cd ../..
tmaker render mytemplate
tmaker preview mytemplate

从远程获取并发布

cd TMaker
tmaker login -u user@example.com -p password
tmaker fetch RemoteTemplate
# 修改模板...
tmaker publish localTemplate -n RemoteTemplate

快速预览

cd TMaker
# 修改模板文件
tmaker render mytemplate
tmaker preview mytemplate

命令简写

为提高效率，TMaker 支持以下命令简写

tmaker mk

主命令简写

create c

创建模板

template t

模板管理

render r

渲染

preview p

预览

login l

登录

logout lo

退出

fetch f

下载

publish pub

发布

image-generate ig

图片生成

需要更多帮助？

查看完整文档或联系我们的支持团队

返回文档首页 联系支持