TMaker 命令参考

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

⚠️ 重要提示

所有 TMaker 命令必须在 TMaker 目录下执行（不是在 templates/xxx 目录下）。命令会相对于 TMaker 目录查找模板文件。

init

简写: i

初始化新模板

创建标准的模板目录结构和配置文件，包括 template.json、页面目录、组件目录、样式和脚本文件。

用法

tmaker init

参数

必需

模板 ID（例如：001, mytemplate, blog）

示例

tmaker init mytemplate

创建名为 mytemplate 的新模板

mk i 999

使用简写创建模板 999

创建的文件

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

初始化后的步骤

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

💡 小贴士

  • • 模板 ID 只能包含字母、数字、下划线和连字符
  • • 初始化后需要在模板目录下运行 npm install 安装依赖

render

简写: r

渲染模板为 HTML

将 Scriban 模板文件（.sbn）渲染为静态 HTML 文件，合并数据文件（.data.json）并应用布局组件。

用法

tmaker render [options]

参数

必需

模板 ID

选项

--page, -p

只渲染指定页面（可选）

示例

tmaker render 001

渲染模板 001 的所有页面

mk r 001 -p home

只渲染 home 页面

tmaker render A1005 --page shop/products

渲染子目录中的页面

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

💡 小贴士

  • • 修改模板或数据后需要重新渲染
  • • 渲染会自动扫描 pages/ 目录下的所有 .sbn 文件
  • • 每个页面必须有对应的 .meta.json 文件

preview

简写: p

启动预览服务器

启动本地开发服务器，预览已渲染的模板 HTML 文件。

用法

tmaker preview [options]

参数

必需

模板 ID

选项

--port, -p

指定服务器端口（默认：1688）

示例

tmaker preview 001

在默认端口 1688 预览模板

mk p 001 -p 8080

在端口 8080 预览

tmaker preview wvip --port 3000

在端口 3000 预览

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

💡 小贴士

  • • 预览前需要先运行 render 命令
  • • 服务器运行时可以按 Ctrl+C 停止
  • • 修改文件后需要重新渲染才能看到更新

ai-generate

简写: ai

AI 自动生成网站

使用 Claude AI 自动生成完整网站内容，包括所有页面的 HTML、数据和元数据文件。

用法

tmaker ai-generate [options]

参数

必需

模板 ID

选项

--force, -f

强制重新生成所有页面（忽略已有页面）

--skip-tests, -st

跳过生成后的 Playwright 测试

示例

tmaker ai-generate A1005

使用 AI 生成模板 A1005

mk ai wvip -f -st

强制重新生成所有页面并跳过测试

要求

  • 需要在 appsettings.json 中配置 Claude API 密钥
  • 或设置环境变量 ANTHROPIC_API_KEY
  • template.json 必须包含完整的模板元数据和 code-rules

配置

文件: TMaker/appsettings.json

{
  "Claude": {
    "ApiKey": "your-claude-api-key",
    "Model": "claude-sonnet-4-20250514"
  }
}

💡 小贴士

  • • AI 会根据 template.json 中的配置生成内容
  • • 生成过程可能需要几分钟时间
  • • 可以使用 --force 重新生成已有页面

login

简写: l

登录 AiCms API

使用用户名和密码登录 AiCms API 服务，保存访问令牌用于后续的 fetch 和 publish 操作。

用法

tmaker login [options]

选项

--username, -u

用户名（可选，不提供将提示输入）

--password, -p

密码（可选，不提供将提示输入）

示例

tmaker login

交互式登录（提示输入用户名和密码）

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

使用命令行参数登录

💡 小贴士

  • • 登录后令牌会自动用于 fetch 和 publish 命令
  • • 令牌有效期取决于服务器配置

logout

简写: lo

退出登录

清除保存的 AiCms API 访问令牌。

用法

tmaker logout

示例

tmaker logout

清除保存的令牌

mk lo

使用简写退出登录

fetch

简写: f

从远程下载模板

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

用法

tmaker fetch [options]

参数

必需

远程模板名称

选项

-all, --all, -a

下载所有资源（页面、组件、分类树）

--dir, -d

保存到指定本地目录（默认：自动生成）

示例

tmaker fetch MyTemplate

只下载站点元数据

mk f MyTemplate -a

下载模板和所有资源

mk f MyTemplate -a -d ./templates/custom

下载到指定目录

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

💡 小贴士

  • • 不使用 -all 只下载基本配置
  • • 使用 -all 会下载页面、组件和分类

publish

简写: pub

发布模板到远程

将本地模板上传到 AiCms API 服务器，包括配置和资源文件。

用法

tmaker publish [options]

参数

必需

本地模板 ID

选项

--name, -n

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

--no-resources, -nr

不上传资源文件

--resource-type, -rt, -r

只发布指定类型的资源

资源类型

  • all - 所有资源（默认）
  • page - 只上传页面
  • component - 只上传组件模板
  • categorytree - 只上传分类树
  • media - 只上传媒体文件（压缩后的 CSS/JS）

示例

tmaker publish 001

发布模板 001

mk pub 001 -n CustomTemplate

以自定义名称发布

mk pub 001 -r page

只发布页面资源

mk pub 001 -nr

不上传资源文件

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

💡 小贴士

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

template

简写: t

模板管理

列出或查看本地模板信息。

用法

tmaker template

子命令

list ls

列出所有可用模板

tmaker template list
info i

显示模板详细信息

tmaker template info

示例

tmaker template list

列出所有模板

mk t i 001

查看模板 001 的详细信息

全局选项

以下选项适用于所有命令

--lang, --language

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

tmaker --lang zh render 001
--help, -h

显示命令帮助信息

tmaker render --help
--version, -v

显示版本信息

tmaker --version

常用工作流程

从零创建新模板

cd TMaker
tmaker init mytemplate
cd templates/mytemplate
npm install
cd ../..
# 编辑模板文件...
tmaker render mytemplate
tmaker preview mytemplate

使用 AI 生成完整网站

cd TMaker
tmaker init A1005
# 配置 template.json...
tmaker ai-generate A1005
tmaker preview A1005

从远程获取并发布

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

快速开发预览

cd TMaker
# 修改模板文件
tmaker render mytemplate
# 在浏览器中刷新页面查看效果

命令简写

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

tmaker mk

主命令简写

init i

初始化

render r

渲染

preview p

预览

ai-generate ai

AI 生成

login l

登录

logout lo

退出

fetch f

下载

publish pub

发布

template t

模板管理

需要更多帮助？

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

返回文档首页 联系支持