命令参考

全局选项

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

选项	描述
`--telemetry`, `-t`	启用或禁用匿名使用遥测。
`--help`, `-h`	显示命令帮助。
`--version`, `-v`	显示 CLI 版本。`mint version` 的别名。

`mint dev`

启动文档的本地预览。

mint dev [flags]

选项	描述
`--port`	本地预览使用的端口。默认为 `3000`。
`--no-open`	不自动打开浏览器。
`--groups`	以逗号分隔的用户组列表，用于模拟预览。
`--disable-openapi`	跳过 OpenAPI 文件处理以提高性能。
`--local-schema`	允许通过 HTTP 提供的本地托管 OpenAPI 文件。

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

mint login

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

`mint logout`

移除已存储的凭据。

mint logout

`mint status`

显示与当前会话关联的账户和组织。

mint status

`mint analytics`

查看文档的分析数据。需要使用 mint login 进行身份验证。

mint analytics <subcommand> [flags]

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

选项	描述
`--subdomain`	文档子域名。默认使用 `mint config set subdomain` 设置的值。
`--from`	开始日期，格式为 `YYYY-MM-DD`。默认为 7 天前，或使用 `mint config set dateFrom` 设置的值。
`--to`	结束日期，格式为 `YYYY-MM-DD`。默认为今天，或使用 `mint config set dateTo` 设置的值。
`--format`	输出格式：`plain`（默认）、`table`、`json` 或 `graph`。
`--agent`	JSON 输出。等同于 `--format json`。当环境变量 `CLAUDECODE` 为 `1` 时也会自动激活。

`mint analytics stats`

显示浏览量、访客数、搜索量、反馈和助手使用情况的摘要。

mint analytics stats [flags]

选项	描述
`--page`	筛选特定页面路径。
`--humans`	仅显示人类流量。
`--agents`	仅显示 AI 代理流量。

`mint analytics search`

显示搜索查询及其命中次数和点击率。

mint analytics search [flags]

选项	描述
`--query`	按搜索查询子字符串筛选。
`--page`	按点击最多的页面筛选。

`mint analytics feedback`

显示用户提交的反馈。

mint analytics feedback [flags]

选项	描述
`--type`	反馈类型：`page`（按页面汇总）或 `code`（代码片段反馈）。
`--page`	筛选特定页面路径。

`mint analytics conversation`

查看助手对话数据。

mint analytics conversation <subcommand> [flags]

`mint analytics conversation list`

列出助手对话。每个条目包含一个对话 ID。

mint analytics conversation list [flags]

选项	描述
`--page`	筛选引用了特定页面的对话。

`mint analytics conversation view <conversation-id>`

按 ID 查看单个对话。使用 mint analytics conversation list 获取 ID。

mint analytics conversation view <conversation-id>

`mint analytics conversation buckets list`

列出分组的对话分类。每个条目包含一个分类 ID。

mint analytics conversation buckets list

`mint analytics conversation buckets view <bucket-id>`

查看某个分类中的对话。使用 mint analytics conversation buckets list 获取 ID。

mint analytics conversation buckets view <bucket-id>

`mint config`

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

mint config <subcommand> <key> [value]

子命令	描述
`set <key> <value>`	设置配置值。
`get <key>`	显示配置值。
`clear <key>`	移除配置值。

配置键

键	描述	使用者
`subdomain`	默认文档子域名。	`mint analytics`
`dateFrom`	分析查询的默认开始日期（`YYYY-MM-DD`）。	`mint analytics`
`dateTo`	分析查询的默认结束日期（`YYYY-MM-DD`）。	`mint analytics`

`mint broken-links`

检查文档中的内部断链。

mint broken-links [flags]

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

选项	描述
`--check-anchors`	同时验证锚链接（例如 `/page#section`）是否与标题 slug 匹配。
`--check-external`	同时检查外部 URL 是否有断链。
`--check-snippets`	同时检查 `<Snippet>` 组件内的链接。

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

mint a11y [flags]

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

选项	描述
`--skip-contrast`	跳过颜色对比度检查。
`--skip-alt-text`	跳过缺失替代文本检查。

`mint validate`

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

mint validate [flags]

选项	描述
`--groups`	以逗号分隔的用户组列表，用于模拟验证。
`--disable-openapi`	跳过 OpenAPI 文件处理和验证。
`--local-schema`	允许验证通过 HTTP 提供的本地托管 OpenAPI 文件。生产环境仅支持 HTTPS。

独立的 mint openapi-check 命令已弃用。请改用 mint validate。

`mint workflow`

以交互方式创建工作流文件。

mint workflow

CLI 会提示输入名称、触发器类型和其他设置，然后在 .mintlify/workflows/ 中创建一个 .md 文件。

`mint export`

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

mint export [flags]

选项	描述
`--output`	输出文件名。默认为 `export.zip`。
`--groups`	以逗号分隔的用户组列表，用于包含受限页面。
`--disable-openapi`	跳过 OpenAPI 处理。

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

`mint new`

从 Mintlify 入门模板创建新的文档项目。

mint new [directory] [flags]

选项	描述
`--name`	项目名称。在交互模式下未提供时，CLI 会提示输入。
`--theme`	项目主题。在交互模式下未提供时，CLI 会提示选择。
`--force`	无需确认即覆盖目录。

`mint update`

将 CLI 更新到最新版本。

mint update

`mint version`

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

mint version

即将推出

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

命令	描述
`mint ai`	AI 驱动的文档工具。
`mint test`	文档测试。
`mint signup`	从 CLI 注册账户。
`mint mcp`	文档 MCP 服务器。

遥测

CLI 收集匿名使用遥测数据以帮助改进 Mintlify。遥测数据包括命令名称、CLI 版本、操作系统和架构。Mintlify 不会收集个人身份信息、项目内容或文件路径。默认情况下，CLI 会收集遥测数据。你可以随时使用 --telemetry 选项退出：

# 禁用遥测
mint --telemetry false

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

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

变量	值	描述
`MINTLIFY_TELEMETRY_DISABLED`	`1`	禁用 Mintlify CLI 遥测。
`DO_NOT_TRACK`	`1`	使用 Console Do Not Track 标准禁用遥测。

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

快速入门

组织

自定义

创建内容

编写 API 文档

部署

优化

全局选项

`mint dev`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint config`

配置键

`mint broken-links`

`mint validate`

`mint workflow`

`mint export`

`mint new`

`mint update`

`mint version`

即将推出

遥测

快速入门

组织

自定义

创建内容

编写 API 文档

部署

优化

​全局选项

​mint dev

​mint login

​mint logout

​mint status

​mint analytics

​mint analytics stats

​mint analytics search

​mint analytics feedback

​mint analytics conversation

​mint analytics conversation list

​mint analytics conversation view <conversation-id>

​mint analytics conversation buckets list

​mint analytics conversation buckets view <bucket-id>

​mint config

​配置键

​mint broken-links

​mint a11y

​mint validate

​mint workflow

​mint export

​mint new

​mint update

​mint version

​即将推出

​遥测

全局选项

`mint dev`

`mint login`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint config`

配置键

`mint broken-links`

`mint a11y`

`mint validate`

`mint workflow`

`mint export`

`mint new`

`mint update`

`mint version`

即将推出

遥测