mintlify__docs/zh/cli/commands.mdx

---
title: "Mintlify CLI 命令参考"
sidebarTitle: "命令参考"
description: "Mintlify CLI 命令和选项的完整参考，涵盖 mint index、mint dev、mint validate、mint broken-links 等命令。"
keywords: ["CLI", "mint", "命令", "选项", "参考"]
boost: 3
---

若要安装 CLI，请参阅[安装 CLI](/zh/cli/install)。

<div id="global-flags">
  ## 全局选项
</div>

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

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

<div id="mint-dev">
  ## `mint dev`
</div>

启动文档的本地预览。

```bash
mint dev [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--port` | 本地预览使用的端口。默认为 `3000`。 |
| `--no-open` | 不自动打开浏览器。 |
| `--groups` | 以空格分隔的用户组列表，用于模拟预览。例如 `--groups admin user`。 |
| `--disable-openapi` | 跳过 OpenAPI 文件处理以提高性能。 |
| `--disable-prefetch` | 在本地预览中禁用导航预加载。适用于后台预加载会拖慢页面加载的超大型站点。 |
| `--local-schema` | 允许通过 HTTP 提供的本地托管 OpenAPI 文件。 |

---

<div id="mint-index">
  ## `mint index`
</div>

将 Mintlify 托管的 Index MCP 服务器安装到你的编程代理中。该服务器提供 `context` 工具，用于查询库、框架、SDK、API 和 CLI 工具。

Index MCP 服务器不同于[Mintlify Docs MCP 服务器](/zh/ai/model-context-protocol)，后者用于搜索你的文档站点。

```bash
mint index [options]
```

该命令也可以使用 `mintlify index` 运行。

<div id="mint-index-options">
  ### 选项
</div>

| 选项 | 描述 |
| --- | --- |
| `--claude` | 配置 Claude Code。 |
| `--cursor` | 配置 Cursor。 |
| `--vscode` | 配置 VS Code。 |
| `--codex` | 配置 Codex。 |
| `--opencode` | 配置 OpenCode。 |
| `--windsurf` | 配置 Windsurf。 |
| `--zed` | 配置 Zed。 |
| `--project` | 在客户端支持时写入项目配置，而不是全局配置。 |
| `--yes`、`-y` | 跳过选择器并配置所有检测到的客户端。 |

<div id="mint-index-select-clients">
  ### 选择客户端
</div>

不带客户端选项运行 `mint index`，即可检测已安装的客户端并打开交互式选择器。检测到的客户端默认处于选中状态。选择要配置的客户端，然后确认提示。

传入一个或多个客户端选项，可以在不打开选择器的情况下配置指定客户端：

```bash
mint index --claude --cursor
```

使用 `--yes` 可在不显示提示的情况下配置所有检测到的客户端。如果没有检测到客户端，请传入明确的客户端选项，例如 `--claude` 或 `--cursor`。

将 `--project` 与客户端选项一起使用，可将项目配置写入当前目录：

```bash
mint index --project --cursor --vscode
```

<div id="mint-index-configuration">
  ### 配置和规则
</div>

该命令会将 `mintlify-index` 服务器添加到每个选中的客户端，并将其指向 `https://index.mintlify.com/mcp`。默认情况下，它会更新全局配置。使用 `--project` 时，如果客户端支持项目配置，则使用该配置。

该命令还会为除 Zed 之外的每个选中客户端添加使用规则。该规则会告知客户端使用 Index MCP 的 `context` 工具查询文档，包括语法、配置、迁移和设置，并优先使用该工具而不是网页搜索，因为训练数据可能已经过时。该规则不适用于通用编程概念或业务逻辑调试。

Windsurf 只有全局 MCP 配置。使用 `--project` 时，该命令仍会将 MCP 条目写入 Windsurf 的全局配置，并将使用规则写入当前项目。

重新运行该命令会更新现有的 `mintlify-index` 条目及其生成的规则，同时保留其他配置。如果现有 JSON 或 JSONC 配置无效，该命令会显示错误且不会修改该文件。

支持的客户端及其标准配置文件如下：

| 客户端 | 全局配置 | 项目配置 |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | 用户 `mcp.json` | `.vscode/mcp.json` |
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | 仅全局配置 |
| Zed | 用户 `settings.json` | `.zed/settings.json` |

---

<div id="mint-signup">
  ## `mint signup`
</div>

从终端创建新的 Mintlify 账户。

```bash
mint signup [flags]
```

| Flag | 描述 |
| --- | --- |
| `--firstName` | 你的名字。 |
| `--lastName` | 你的姓氏。 |
| `--company` | 你的公司名称。 |
| `--email` | 账户的电子邮件地址。 |

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

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

<Note>
  在你点击验证链接之前，`mint signup` 不会返回，而这可能需要几分钟。在脚本或自动化流程中，请以后台进程的方式运行它，而不是同步等待其完成。
</Note>

<div id="examples">
  ### 示例
</div>

```bash
# 交互式注册
mint signup

# 一次性提供所有信息进行注册
mint signup \
  --firstName Jane \
  --lastName Doe \
  --company Acme \
  --email jane@acme.com
```

---

<div id="mint-login">
  ## `mint login`
</div>

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

```bash
mint login
```

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

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

---

<div id="mint-logout">
  ## `mint logout`
</div>

移除已存储的凭据。

```bash
mint logout
```

---

<div id="mint-status">
  ## `mint status`
</div>

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

```bash
mint status
```

---

<div id="mint-add-domain">
  ## `mint add-domain`
</div>

从终端为你的部署添加一个[自定义域名](/zh/customize/custom-domain)。需要使用 `mint login` 进行身份验证。

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

| 参数 | 描述 |
| --- | --- |
| `domain` | 要添加的自定义域名，例如 `docs.example.com`。必须是纯主机名。 |

| 选项 | 描述 |
| --- | --- |
| `--basePath` | 将文档托管在域名的[子路径](/zh/customize/custom-domain#choose-where-to-host-your-documentation)下，例如 `/docs`。必须以 `/` 开头，并符合 [base path 要求](/zh/customize/custom-domain#base-path-requirements)。 |

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

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

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

请先添加 `TXT` 记录，验证记录通过后再添加 `CNAME`。有关完整的 DNS 配置说明、顶级域名要求和 TLS 配置详情，请参见[自定义域名](/zh/customize/custom-domain)。

如果命令报错 `Domain is already in use by another deployment in your organization` 或 `Domain is already claimed by another organization`，说明该域名已绑定到另一个 Mintlify 部署。请参见[添加域名时报错 "Domain is already claimed by another organization"](/zh/help-center/domain-already-claimed-by-another-organization) 以释放并重新添加。

<Note>
  如果命令结束时某些 `TXT` 记录仍在生成中，请稍后前往控制台的 [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) 页面查看剩余的值。
</Note>

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

<div id="example-add-domain">
  ### 示例
</div>

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

```bash
mint add-domain docs.example.com
```

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

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

---

<div id="mint-automations">
  ## `mint automations`
</div>

从终端创建、列出和删除[自动化](/zh/automations)。需要使用 `mint login` 进行身份验证。

```bash
mint automations <subcommand> [flags]
```

<Note>
  `mint workflow` 和 `mint workflows` 仍可作为 `mint automations` 的别名继续使用，因此现有脚本仍可正常运行。新脚本应使用 `mint automations`。
</Note>

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

| 选项 | 描述 |
| --- | --- |
| `--subdomain` | 文档子域名。默认为通过 `mint config set subdomain` 设置的值，或你账户中的第一个项目。 |
| `--format` | 输出格式：`table`（默认，美化）或 `json`（原始、机器可读）。 |

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

<div id="mint-automations-create">
  ### `mint automations create`
</div>

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

```bash
mint automations create [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--name` | 自动化名称。除非提供了 `--file`，否则为必填项。 |
| `--prompt` | 每次运行时附加到自动化基础提示的说明。 |
| `--type` | 自动化类型。可选值之一：`changelog`、`source-code-agent`、`translations`、`writing-style`、`typo-check`、`broken-link-detection`、`seo-metadata-audit`、`assistant-docs-updates` 或 `contextual-feedback-docs-updates`。省略表示自定义自动化。 |
| `--cron` | 用于计划触发的 cron 表达式。与 `--push-repo` 互斥。 |
| `--push-repo` | 用于推送触发的仓库（`owner/repo`）。可重复以监听多个仓库。与 `--cron` 互斥。 |
| `--context-repo` | 自动化运行时 agent 读取的附加上下文仓库（`owner/repo`）。可重复，总共最多 10 个。 |
| `--automerge` | 自动合并此自动化打开的 pull request。设置要求请参见[配置 automerge](/zh/guides/configure-automerge)。 |
| `--file` | 指向包含完整自动化主体的 JSON 或 YAML 文件路径。会覆盖内联选项。 |

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

<div id="examples">
  #### 示例
</div>

```bash
# 计划翻译自动化
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` 字段保存触发器：

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

<div id="mint-automations-list">
  ### `mint automations list`
</div>

列出当前部署的自动化。

```bash
mint automations list [flags]
```

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

<div id="mint-automations-delete">
  ### `mint automations delete`
</div>

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

```bash
mint automations delete <id> [flags]
```

| 参数 | 描述 |
| --- | --- |
| `id` | 要删除的自动化架构 ID。 |

---

<div id="mint-analytics">
  ## `mint analytics`
</div>

从终端查询文档分析数据。需要使用 `mint login` 进行身份验证。

<Info>
  分析功能需要 [Pro 或 Enterprise 计划](https://mintlify.com/pricing?ref=analytics)。
</Info>

```bash
mint analytics <subcommand> [flags]
```

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

| 选项 | 描述 |
| --- | --- |
| `--subdomain` | 文档子域名。默认为通过 `mint config set subdomain` 设置的值，或你账户中的第一个项目。 |
| `--from` | 起始日期，格式为 `YYYY-MM-DD`。默认为七天前，或通过 `mint config set dateFrom` 设置的值。 |
| `--to` | 结束日期，格式为 `YYYY-MM-DD`。默认为今天，或通过 `mint config set dateTo` 设置的值。 |
| `--format` | 输出格式：`table`（美化）、`plain`（制表符分隔，可用于管道）、`json`（原始）或 `graph`（条形图）。默认为 `plain`，当 CLI 检测到 AI 或 CI 环境时默认为 `json`。 |

<div id="mint-analytics-stats">
  ### `mint analytics stats`
</div>

显示某个日期范围内的核心 KPI：浏览量、访客数、搜索次数、反馈和 assistant 使用情况。人类流量和 agent 流量分别报告。

```bash
mint analytics stats [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--page` | 按指定页面路径过滤。 |

<div id="mint-analytics-search">
  ### `mint analytics search`
</div>

显示搜索查询，包括命中次数、点击率、点击最多的页面和最后搜索日期。

```bash
mint analytics search [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--query` | 按搜索查询子字符串过滤结果。 |
| `--page` | 过滤出以给定页面作为点击最多结果的查询。 |

<div id="mint-analytics-feedback">
  ### `mint analytics feedback`
</div>

显示用户提交的反馈。默认返回单条反馈条目。传入 `--type page` 可查看按页面路径聚合的反馈，或传入 `--type code` 仅包含针对代码片段的反馈。

```bash
mint analytics feedback [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--type` | `code` 表示代码片段反馈，`page` 表示按页面级聚合。省略则返回所有反馈条目。 |
| `--page` | 按指定页面路径过滤。 |

<div id="mint-analytics-conversation">
  ### `mint analytics conversation`
</div>

查看 assistant 对话分析数据。

<div id="mint-analytics-conversation-list">
  #### `mint analytics conversation list`
</div>

列出最近的 assistant 对话，包括时间戳、用户的第一个问题和分类。

```bash
mint analytics conversation list [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--page` | 过滤出其来源引用了给定页面路径的对话。 |

<div id="mint-analytics-conversation-view">
  #### `mint analytics conversation view`
</div>

查看单个对话的完整消息线程。

```bash
mint analytics conversation view <id> [flags]
```

| 参数 | 描述 |
| --- | --- |
| `id` | 来自 `mint analytics conversation list` 的对话 ID。 |

<div id="mint-analytics-conversation-buckets-list">
  #### `mint analytics conversation buckets list`
</div>

列出按主题分组的对话集群，包括每个集群的对话数量和最近的提问日期。

```bash
mint analytics conversation buckets list [flags]
```

<div id="mint-analytics-conversation-buckets-view">
  #### `mint analytics conversation buckets view`
</div>

列出对话集群中的各个线程。

```bash
mint analytics conversation buckets view <id> [flags]
```

| 参数 | 描述 |
| --- | --- |
| `id` | 来自 `mint analytics conversation buckets list` 的集群 ID。 |

| 选项 | 描述 |
| --- | --- |
| `--limit` | 要返回的最大线程数。取值范围为 1 到 100。 |
| `--cursor` | 来自上一次响应的分页游标。 |

<div id="analytics-examples">
  #### 示例
</div>

```bash
# 最近 30 天的 KPI
mint analytics stats --from 2026-07-25 --to 2026-08-24

# 以条形图显示热门搜索查询
mint analytics search --format graph

# 以 JSON 格式聚合页面级反馈，便于管道传递给其他工具
mint analytics feedback --type page --format json

# 查看单个对话线程
mint analytics conversation view conv_123
```

---

<div id="mint-config">
  ## `mint config`
</div>

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

```bash
mint config <subcommand> <key> [value]
```

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

<div id="configuration-keys">
  ### 配置键
</div>

| 键 | 描述 | 使用者 |
| --- | --- | --- |
| `subdomain` | 默认文档子域名。 | `mint dev`、`mint automations`、`mint analytics`、`mint add-domain`、`mint score` |
| `dateFrom` | 分析查询的默认开始日期。 | `mint analytics` |
| `dateTo` | 分析查询的默认结束日期。 | `mint analytics` |

---

<div id="mint-broken-links">
  ## `mint broken-links`
</div>

检查文档中的内部断链。

```bash
mint broken-links [flags]
```

该命令会排除匹配 [.mintignore](/zh/organize/mintignore) 模式的文件。指向被忽略文件的链接会被报告为断链。

| 选项 | 描述 |
| --- | --- |
| `--files` | 要检查的一个或多个文件路径或 glob。默认检查整个站点。 |
| `--check-anchors` | 同时验证锚链接（例如 `/page#section`）是否与标题 slug 匹配。 |
| `--check-external` | 同时检查外部 URL 是否有断链。 |
| `--check-redirects` | 同时检查 `docs.json` 中的重定向目标是否解析为有效路径。 |
| `--check-snippets` | 同时检查 `<Snippet>` 组件内的链接。 |

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

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

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

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

---

<div id="mint-a11y">
  ## `mint a11y`
</div>

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

```bash
mint a11y [flags]
```

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

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

---

<div id="mint-validate">
  ## `mint validate`
</div>

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

```bash
mint validate [flags]
```

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

<Note>
  请改用 `mint validate`，而不是已弃用的独立 `mint openapi-check` 命令。
</Note>

---

<div id="mint-test">
  ## `mint test`
</div>

为文档中的代码示例生成并运行测试。

```bash
mint test
```

`mint test` 会扫描你的内容中的代码块，生成用于验证这些代码块的单元测试，并使用本地编码代理运行这些测试。

<div id="prerequisites">
  ### 前置条件
</div>

- 使用 `mint login` 进行身份验证。
- 为你要使用的编码代理安装 SDK：

  ```bash
  # Claude (default)
  npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk

  # Codex
  npm install @openai/codex-sdk
  ```

只有出现在 `docs.json` 导航中的页面才会显示以供选择。

<Frame>
  <img
    src="/images/cli/mint-test-scope.png"
    alt="mint test 交互式界面，包含步骤侧边栏和页面选择树，树中列出各页面文件夹及其代码块数量。"
  />
</Frame>

<div id="output">
  ### 输出
</div>

`mint test` 命令会写入项目中的两个位置：

| 路径 | 内容 |
| --- | --- |
| `tests/mint-test/<run-id>/` | 生成的测试项目，每个 agent 和页面对应一个目录。 |
| `.mintlify/test/` | 运行报告和历史记录，包括每次运行的 `runs/<run-id>.json`。 |

如果不想提交测试产物，请将这两个路径添加到 `.gitignore` 中。

运行结束后，该命令会打印结果摘要，例如 `mint test passed: 8 passed, 0 failed, 0 agent errors`。当所有测试都通过时，命令以退出码 `0` 结束，否则以 `1` 结束。

---

<div id="mint-export">
  ## `mint export`
</div>

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

```bash
mint export [flags]
```

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

有关详细信息，请参阅[离线导出](/zh/deploy/export)。

---

<div id="mint-score">
  ## `mint score`
</div>

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

```bash
mint score [url] [flags]
```

| 参数 | 描述 |
| --- | --- |
| `url` | 可选。要检查的文档站点的 URL。如果省略，该命令将对你配置的子域名进行评分（来自 `mint config`，或与你登录账户关联的子域名）。 |

| 选项 | 描述 |
| --- | --- |
| `--format` | 输出格式：`table`（默认，带颜色）、`plain`（可管道传输的 TSV）或 `json`。 |

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

<div id="examples">
  ### 示例
</div>

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

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

<div id="checks">
  ### 检查项
</div>

评分评估以下方面：

| 检查项 | 验证内容 |
| --- | --- |
| `llmsTxtExists` | 代理可以访问站点根目录下的 [llms.txt](/zh/ai/llmstxt) 文件。 |
| `llmsTxtValid` | `llms.txt` 文件遵循预期格式，包含标题、引用摘要和 Markdown 链接。 |
| `llmsTxtSize` | `llms.txt` 文件在大小阈值内，确保代理可以完整消费而不会被截断。 |
| `llmsTxtLinksResolve` | `llms.txt` 中的链接指向有效页面。 |
| `llmsTxtLinksMarkdown` | `llms.txt` 中的链接使用 Markdown 语法。 |
| `llmsTxtDirective` | `llms.txt` 文件包含使用指令。 |
| `llmsTxtFullExists` | 提供了 [llms-full.txt](/zh/ai/llmstxt/#llms-full-txt) 文件，供需要完整内容的代理使用。独立于 `llmsTxtExists` 运行。 |
| `llmsTxtFullSize` | `llms-full.txt` 文件大小合理，代理可以处理。 |
| `llmsTxtFullValid` | `llms-full.txt` 文件包含带标题的有效内容。 |
| `llmsTxtFullLinksResolve` | `llms-full.txt` 中的链接指向有效页面。 |
| `skillMd` | 代理可以访问 [skill.md](https://www.mintlify.com/docs/ai/skillmd) 文件以供代理工具使用。 |
| `contentNegotiationMarkdown` | 当代理通过内容协商请求时，站点返回 Markdown。 |
| `contentNegotiationPlaintext` | 当代理通过内容协商请求时，站点返回纯文本。 |
| `mcpServerDiscoverable` | 代理可以发现用于基于工具的代理的 [MCP 服务器](/zh/ai/model-context-protocol)。 |
| `mcpToolCount` | MCP 服务器至少公开一个工具。 |
| `openApiSpec` | 在标准路径下有可用的 OpenAPI 或 Swagger 规范。 |
| `robotsTxtAllowsAI` | `robots.txt` 文件没有阻止 AI 爬虫。 |
| `sitemapExists` | 有可用的站点地图供页面发现使用。 |
| `structuredData` | 主页包含 [JSON-LD](https://json-ld.org/) 结构化数据（`<script type="application/ld+json">`）。报告 JSON-LD 块的数量和发现的架构类型。 |
| `responseLatency` | 站点在代理可接受的时间内响应。 |

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

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

---

<div id="mint-format">
  ## `mint format`
</div>

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

```bash
mint format
```

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

<Warning>
  `mint format` 会就地重写文件。运行前请先提交或暂存你的更改，以便审查 diff。
</Warning>

命令完成后，会打印重新格式化了多少个 MDX 文件以及有多少文件解析失败。如果有任何文件失败，命令将以退出码 `1` 结束，并打印文件路径和错误信息，这样你就可以在 CI 中运行它以强制执行一致的格式。示例流水线请参见 [在 CI 中安装](/zh/cli/install#install-in-ci)。

---

<div id="mint-new">
  ## `mint new`
</div>

通过选择主题或从 [mintlify/templates](https://github.com/mintlify/templates) 仓库克隆预定义模板来创建新的文档项目。

```bash
mint new [directory] [flags]
```

| 选项 | 描述 |
| --- | --- |
| `--name` | 项目名称。在交互模式下未提供时，CLI 会提示输入。 |
| `--theme` | 项目[主题](/zh/customize/themes)。在交互模式下未提供时，CLI 会提示选择。 |
| `--template` | 预定义模板。在交互模式下未提供时，CLI 会提示选择。 |
| `--force` | 无需确认即覆盖目录。 |

---

<div id="mint-update">
  ## `mint update`
</div>

将 CLI 更新到最新版本。

```bash
mint update
```

---

<div id="mint-version">
  ## `mint version`
</div>

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

```bash
mint version
```

---

<div id="coming-soon">
  ## 即将推出
</div>

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

| 命令 | 描述 |
| --- | --- |
| `mint ai` | AI 驱动的文档工具。 |
| `mint mcp` | 文档 MCP 服务器。 |

---

<div id="telemetry">
  ## 遥测
</div>

CLI 收集使用遥测数据以帮助改进 Mintlify。遥测数据包括命令名称、CLI 版本、操作系统和架构。如果你已登录，遥测事件还会包含你的账户电子邮件地址。未登录时的使用保持匿名，退出登录会删除已存储的电子邮件。Mintlify **不会**收集项目内容或文件路径。

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

```bash
# 禁用遥测
mint --telemetry false

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

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

| 变量 | 值 | 描述 |
| --- | --- | --- |
| `MINTLIFY_TELEMETRY_DISABLED` | `1` | 禁用 Mintlify CLI 遥测。 |
| `DO_NOT_TRACK` | `1` | 使用 [Console Do Not Track](https://consoledonottrack.com/) 标准禁用遥测。 |

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