文档运维Skill docs-ops

这个技能用于自动化管理Cursor文档的生命周期,包括文档抓取、索引验证、缓存清除和搜索索引重建等操作。关键词:文档管理、搜索索引、自动化运维、DevOps、软件文档、索引重建、缓存清理。

DevOps 0 次安装 0 次浏览 更新于 3/11/2026

名称: docs-ops 描述: “管理Cursor文档生命周期。操作: 抓取、验证、刷新、重建索引、清除缓存。” 参数提示: <操作> (抓取|验证|刷新|重建索引|清除缓存) [选项] 允许工具: 读取、写入、Bash、Glob、Grep

Cursor文档操作

通过单个整合技能管理Cursor文档的生命周期。

参数路由

操作 描述
抓取 从llms.txt源抓取文档,然后刷新和验证
验证 验证索引完整性并检测漂移(只读)
刷新 从文件系统刷新索引而不抓取
重建索引 清除并立即重建搜索索引
清除缓存 清除搜索缓存(在下一次搜索时懒重建)

解析$ARGUMENTS以确定操作。第一个令牌是操作关键字。剩余令牌作为选项传递给操作处理器。


操作: 抓取

从配置的llms.txt源抓取所有文档。

步骤

  1. 运行抓取脚本:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/core/scrape_docs.py" --parallel
  1. 抓取完成后,重建索引:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/rebuild_index.py"
  1. 验证索引:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/manage_index.py" verify

报告每个步骤的结果。


操作: 验证

运行文档索引的验证检查,不进行任何修改。

步骤

  1. 运行索引验证:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/manage_index.py" verify
  1. 运行完整验证并总结:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/maintenance/validate_index.py"
  1. 报告文档计数:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/manage_index.py" count

报告每个验证步骤的结果,突出发现的任何问题。


操作: 刷新

刷新本地索引而不从网络重新抓取。当手动修改文档文件或需要重建索引时使用此操作。

步骤

  1. 从文件系统重建索引:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/rebuild_index.py"
  1. 验证索引完整性:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/manage_index.py" verify
  1. 报告文档计数:
python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/management/manage_index.py" count

报告每个步骤的结果。


操作: 重建索引

清除并立即重建cursor-docs搜索索引。这比清除缓存 + 等待下一次搜索更快,因为它立即触发重建。

何时使用

  • 手动编辑index.yaml或文档文件后
  • 当搜索结果似乎过时或不正确时
  • 执行git pull并带有文档更改后
  • 当需要搜索立即工作时

与清除缓存的区别

操作 行为 搜索可用性
清除缓存 仅清除缓存 在下一次搜索时重建(懒)
重建索引 清除 + 重建 立即(急)

选项

  • 无选项: 显示计划并要求确认
  • –force: 跳过确认并立即重建

说明

此操作清除Cursor文档搜索缓存并立即重建索引。

检查当前状态

首先,检查当前缓存状态。报告缓存是否存在、是否有效以及上次构建时间。

请求确认

除非用户传递--force,否则显示重建计划及当前缓存状态并要求确认。解释重建需要几秒钟,搜索在重建期间不可用。

清除和重建

一旦确认(或如果传递了--force):

  1. 使用clear_cache.py脚本清除缓存
  2. 使用rebuild_index.py重建索引
  3. 使用manage_index.py verify验证重建成功

报告结果

报告新索引统计信息,包括文档计数和构建时间。确认搜索现在可用。

## 索引已重建

成功重建Cursor文档搜索索引。

**新索引统计:**
- 文档: X
- 构建时间: Xms

**搜索现在可用。**

错误处理

  • 插件未安装: 报告“cursor-ecosystem插件未找到。”
  • 重建失败: 报告脚本错误
  • 权限被拒绝: 报告并附上修复步骤

操作: 清除缓存

清除cursor-docs搜索缓存(倒排索引)。这会强制索引在下一次文档搜索时重建。

何时使用

  • 手动编辑index.yaml或文档文件后
  • 当搜索结果似乎过时或不正确时
  • 执行git pull并带有文档更改后
  • 释放磁盘空间

选项

  • 无选项: 显示将清除的内容并要求确认
  • –force: 跳过确认并立即清除

步骤1: 解析选项

检查是否存在--force标志。

force_mode = "--force" in arguments (不区分大小写)

步骤2: 定位缓存目录

cursor-docs缓存位于:

${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/.cache/

或通过安装路径:

~/.claude/plugins/cache/<marketplace>/cursor-ecosystem/<version>/skills/cursor-docs/.cache/

步骤3: 检查缓存状态

列出缓存文件:

文件 用途
inverted_index.json 搜索索引
cache_version.json 基于哈希的有效性跟踪

如果缓存目录不存在或为空,报告:“缓存已清除。无事可做。”

步骤4: 确认(除非–force)

如果不是force_mode,显示缓存清除计划:

## 缓存清除计划

**目标:** Cursor文档搜索索引

| 文件 | 大小 |
|------|------|
| inverted_index.json | X.X MB |
| cache_version.json | 512 字节 |

**总计:** X.X MB

> **注意:** 搜索索引将在下一次文档搜索时自动重建。
> 要立即重建,请在清除后使用`重建索引`操作。

**继续?** 回复“是”以继续,或使用`--force`跳过此确认。

步骤5: 清除缓存

使用clear_cache.py脚本清除:

python "${CLAUDE_PLUGIN_ROOT}/skills/cursor-docs/scripts/maintenance/clear_cache.py"

步骤6: 报告成功

## 缓存已清除

成功清除Cursor文档搜索缓存。

**已清除:**
- inverted_index.json
- cache_version.json

**后续步骤:**
- 搜索索引将在下一次搜索时自动重建
- 或使用`重建索引`操作立即重建

错误处理

  • 缓存未找到: 报告“缓存已清除或插件未安装。”
  • 权限被拒绝: 报告“权限被拒绝。尝试使用提升权限运行。”
  • 插件未安装: 报告“cursor-ecosystem插件未找到。”