Mintlify CLI 命令参考

以下选项适用于所有命令。

启动文档的本地预览。

mint dev [flags]

从终端创建新的 Mintlify 账户。

mint signup [flags]

不带任何 flag 运行该命令即可以交互方式输入你的信息。CLI 会提示你输入未通过 flag 传入的值。

提交信息后，Mintlify 会向你的邮箱发送一封验证邮件。该命令会一直等待，直到你点击验证链接后，才会创建你的账户、为你登录并保存凭据。完成后，打开控制台来连接你的仓库并开始构建。

# 交互式注册
mint signup

# 一次性提供所有信息进行注册
mint signup \
  --firstName Jane \
  --lastName Doe \
  --company Acme \
  --email [email protected]

使用你的 Mintlify 账户进行身份验证。

mint login

打开浏览器窗口完成身份验证。如果浏览器未打开，CLI 会显示一个 URL 供你手动打开，并提示你粘贴授权代码。凭据保存在 ~/.config/mintlify/config.json 中。

如果你有多个部署，CLI 会在登录后提示你选择一个默认项目。你可以稍后使用 mint config set subdomain <subdomain> 更改默认项目。

移除已存储的凭据。

mint logout

显示当前会话的详细信息，包括 CLI 版本、账户邮箱、组织和已配置的子域名。

mint status

从终端为你的部署添加一个自定义域名。需要使用 mint login 进行身份验证。

mint add-domain <domain> [--basePath <path>]

该命令使用通过 mint config 配置的子域名。如果未设置，则使用账户中的第一个子域名。

域名注册后，CLI 将等待最长 10 秒以生成 DNS 记录，然后打印需要在你的域名提供商处添加的 TXT 和 CNAME 记录：

TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders

请先添加 TXT 记录，验证记录通过后再添加 CNAME。有关完整的 DNS 配置说明、顶级域名要求和 TLS 配置详情，请参见自定义域名。

传入 --basePath 时，CLI 会在注册域名后保存 base path。新路径会在你的下次部署时生效，在此之前你的站点会继续从当前路径提供服务。CNAME 会把该域名的所有流量都发送到 Mintlify，因此仅在该域名没有托管其他内容时才添加它。否则，请保留现有 DNS，并为该 base path 设置指向 Mintlify 的反向代理。有关按服务商分类的指南，请参见将文档托管在子路径下。

在根路径添加自定义域名：

mint add-domain docs.example.com

添加自定义域名并将文档托管在 /docs：

mint add-domain example.com --basePath /docs

从终端创建、列出和删除自动化。需要使用 mint login 进行身份验证。

mint automations <subcommand> [flags]

所有子命令都接受以下共享选项：

当设置 --format json 时，错误会以 Error: <message> 的形式输出到 stderr，并且命令以非零状态退出，因此你可以将成功的输出通过管道传递给其他工具。

创建新自动化。你可以通过选项内联传递自动化定义，或者使用 --file 指向一个 JSON 或 YAML 文件。

mint automations create [flags]

请提供恰好一个触发器：传入 --cron 表示计划自动化，或传入一个或多个 --push-repo 选项表示推送触发的自动化。

# 计划翻译自动化
mint automations create \
  --name "Translate content" \
  --type translations \
  --cron "0 6 * * *"

# 带额外上下文的推送触发自动化
mint automations create \
  --name "Sync API reference" \
  --type source-code-agent \
  --push-repo my-org/api \
  --context-repo my-org/shared-types \
  --automerge

# 从文件创建
mint automations create --file automation.yaml

自动化文件使用与内联选项相同的结构。on 字段保存触发器：

name: Translate content
type: translations
on:
  cron: "0 6 * * *"
prompt: Prefer formal tone in French translations.
automerge: false
context:
  - repo: my-org/shared-content

列出当前部署的自动化。

mint automations list [flags]

默认的表格输出显示每个自动化的 ID、名称、类型、触发器和状态。使用 --format json 可获取完整的自动化对象。

通过 ID 删除自动化。使用 mint automations list 获取 ID。

mint automations delete <id> [flags]

管理 CLI 命令的持久默认值。配置保存在 ~/.config/mintlify/config.json 中。

mint config <subcommand> <key> [value]

检查文档中的内部断链。

mint broken-links [flags]

该命令会排除匹配 .mintignore 模式的文件。指向被忽略文件的链接会被报告为断链。

使用 --files 将检查限定为特定页面。适用于验证你刚编辑过的某个页面，或在 CI 中将检查范围缩小到某个目录。当 --files 与 --check-external 一起使用时，仅会检查所选页面上的外部 URL。

# 检查特定页面
mint broken-links --files introduction.mdx

# 检查匹配某个 glob 的页面
mint broken-links --files "guides/**/*.mdx"

# 传入多个路径
mint broken-links --files introduction.mdx --files "guides/**/*.mdx"

检查文档中的无障碍性问题。

mint a11y [flags]

检查颜色对比度和图片、视频上缺失的替代文本。

以严格模式验证文档构建。如果存在警告或错误则以错误退出。包括对 docs.json 中引用的 OpenAPI 规范的自动验证。

mint validate [flags]

将文档导出为独立的 zip 存档，用于离线查看和分发。

mint export [flags]

有关详细信息，请参阅离线导出。

对公共文档站点运行代理就绪性检查。需要使用 mint login 进行身份验证。

mint score [url] [flags]

该命令显示总体就绪性评分以及各项检查的通过/未通过指标。

# 评分你的默认子域名
mint score

# 评分特定站点
mint score docs.example.com

评分评估以下方面：

某些检查项仅在其依赖的检查项通过时才会运行。如果某个检查项失败，所有依赖它的检查项都不会运行，它们会自动失败。例如，llmsTxtValid 仅在 llmsTxtExists 先通过后才会通过。

总分使用加权评分，因此影响更大的检查项对您的分数贡献更多。

检查文档页面中是否存在 AI 风格的文本，并获取改写建议。需要使用 mint login 进行身份验证。

mint deslop [files...] [flags]

对于每个被标记的页面，该命令会报告 AI 撰写比例、被识别为 AI 生成的具体段落及其行号，以及建议的人类风格改写。

每检查一个页面消耗 1 个 AI 积分。少于 50 个词的页面会被跳过，不计费。当任意页面达到或超过阈值，或某次检查返回错误时，命令以退出码 1 结束；当所有页面都通过时，命令以退出码 0 结束。方便你在改写循环或 CI 中运行。

# 检查工作树中已更改的页面
mint deslop

# 检查特定页面
mint deslop docs/guide.mdx

# 检查所有 MDX 页面并输出 JSON 便于脚本处理
mint deslop "docs/**/*.mdx" --format json

# 同时清理所检查文件中的空白
mint deslop docs/guide.mdx --fix-whitespace

将当前目录中的每个 .mdx 文件格式化为 Mintlify 的规范样式。该命令使用与 Web 编辑器相同的 MDX 解析器解析每个文件，如果规范化输出与原文不同，则就地重写文件。

mint format

在文档项目的根目录中运行该命令。它会遍历所有子目录，跳过 .gitignore 匹配的路径和任何 Mintlify 忽略规则匹配的路径。已经与规范化输出一致的文件将保持不变。

命令完成后，会打印重新格式化了多少个 MDX 文件以及有多少文件解析失败。如果有任何文件失败，命令将以退出码 1 结束，并打印文件路径和错误信息，这样你就可以在 CI 中运行它以强制执行一致的格式。

通过选择主题或从 mintlify/templates 仓库克隆预定义模板来创建新的文档项目。

mint new [directory] [flags]

将 CLI 更新到最新版本。

mint update

显示当前 CLI 和客户端版本。

mint version

这些命令可以运行但尚未正式启用。运行它们会通过 CLI 遥测记录你的兴趣，并帮助确定下一步开发的优先级。

CLI 收集匿名使用遥测数据以帮助改进 Mintlify。遥测数据包括命令名称、CLI 版本、操作系统和架构。Mintlify 不会收集个人身份信息、项目内容或文件路径。

默认情况下，CLI 会收集遥测数据。你可以随时使用 --telemetry 选项退出：

# 禁用遥测
mint --telemetry false

# 重新启用遥测
mint --telemetry true

你也可以通过设置以下环境变量来禁用遥测：

你的偏好保存在 ~/.config/mintlify/config.json 中，在 CLI 会话之间持久有效。