Gemini CLI 自定义命令实现「文档链接检查」:TOML 写法与用法
把「文档链接检查」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(文档目录),按什么顺序处理,交付什么(失效链接清单),哪些事不能做。Skill 就是把这些写下来的载体。
本文介绍如何在 Gemini CLI 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 文档链接检查(doc-link-check) |
| 作用 | 检查文档中的失效链接与锚点 |
| 输入 | 文档目录 |
| 输出 | 失效链接清单 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 开发者与技术写作者 |
处理流程分四步:
- 收集链接
- 逐个检测
- 区分内部与外部
- 给出修复建议
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 Gemini CLI 中是什么形态
Gemini CLI 会读取项目中的 GEMINI.md 作为长期上下文,还支持在 .gemini/commands/ 下用 TOML 文件定义自定义斜杠命令,把一段固定提示封装成一个命令。
项目级命令放在仓库的 .gemini/commands/,个人级放在用户目录下的 .gemini/commands/;命令中可用 {{args}} 接收调用时的参数。
示例配置
自定义命令示例(示意):
# .gemini/commands/doc-link-check.toml
description = "文档链接检查:检查文档中的失效链接与锚点"
prompt = """
你现在执行「文档链接检查」任务。
输入:{{args}}
按以下步骤处理:
1. 收集链接
2. 逐个检测
3. 区分内部与外部
4. 给出修复建议
最后输出:失效链接清单,并列出需要人工确认的内容。
"""
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在项目中新建
.gemini/commands/doc-link-check.toml - 填写 description 与 prompt,prompt 中写清步骤与输出
- 在 GEMINI.md 中补充项目约定,供命令执行时参考
- 在 CLI 中输入
/doc-link-check加参数调用 - 提交到仓库,团队共享
实操:一次完整的运行
假设你在文档仓库与文档站中发出这样的请求(虚构示例):
这是今天的文档目录,按团队的文档链接检查流程处理一下。
智能体识别到任务与「文档链接检查」相关后,会依次收集链接、逐个检测、区分内部与外部、给出修复建议。最终交付失效链接清单,并在末尾列出需要人工确认的内容。你的工作是对照原始文档目录抽查两三处关键信息,确认无误后再使用。
测试与验收
用空参数、正常参数和超长参数各调用一次命令,确认提示中的步骤与约束都生效。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准文档目录,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 把所有流程都塞进 GEMINI.md,导致每次对话上下文过长。
- 命令名与内置命令或其他命令重名,调用时混淆。
- 只写了步骤,没写交付格式,导致每次输出的失效链接清单结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 文档链接检查 · 检查清单
- 文档链接检查 · GitHub Copilot 指令与提示文件 版
- 文档链接检查 · OpenAI Agents SDK 版
- 接口文档编写 · Gemini CLI 版
- 技术文档翻译 · Gemini CLI 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。