Context7 CLIctx7完全指南为 AI 编程助手检索最新库文档与一键配置 MCP【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7Context7 平台为 LLM 与 AI 代码编辑器提供最新的库文档服务而ctx7正是它的官方命令行客户端既能像搜索引擎一样把库名解析为 Context7 库 ID 并拉取最新文档上下文也能通过 OAuth 认证自动为 Claude Code、Cursor、OpenCode、Codex 等 AI 编码代理写入 MCP 服务配置与规则文件。读完本文你将掌握ctx7的完整安装方式、library/docs文档检索命令、setup/remove的配置与卸载机制、OAuth 登录流程以及遥测开关等全部细节。安装npx 免安装运行或全局安装ctx7以 npm 包形式发布包名为ctx7当前仓库版本 0.5.9见 package.json支持两种使用方式# 免安装直接运行推荐适合偶尔使用 npx ctx7 # 全局安装适合高频使用之后可直接调用 ctx7 命令 npm install -g ctx7环境要求Node.js 版本不低于 18package.json中engines.node声明且包以 ES Moduletype: module方式发布bin入口指向编译产物./dist/index.js。免安装的代价如果你用npx ctx7本机不会留下永久性的 CLI 安装卸载时无需任何额外操作。全局安装的卸载如果通过npm install -g ctx7安装需要单独执行npm uninstall -g ctx7来移除 CLI 本身——这与下面介绍的ctx7 remove只清理代理配置不卸载 CLI是两个不同的概念。从源码结构看CLI 基于commander构建命令体系入口在 packages/cli/src/index.ts注册了setup、remove、docs含library子命令、authlogin/logout/whoami以及upgrade、skill等命令。直接运行不带参数的npx ctx7会打印 ASCII 艺术字 banner 与快速上手提示运行npx ctx7 --help可查看全部命令与选项。快速开始从检索文档到一键配置ctx7的核心工作流只有两条主线# 主线一为你的 AI 编码代理配置 Context7 ctx7 setup # 之后想卸载配置 ctx7 remove # 主线二检索库文档 ctx7 library react ctx7 docs /facebook/react useEffect cleanup # 指定目标代理不指定时自动检测已安装的代理并交互式选择 ctx7 setup --cursor ctx7 setup --claude ctx7 setup --opencode文档检索library与docs命令查找库ctx7 librarylibrary命令把模糊的库名解析为 Context7 标准库 ID。它内部调用resolveLibrary见 packages/cli/src/utils/api.ts请求GET {baseUrl}/api/v2/libs/search同时附带libraryName参数和可选的query关键词。# 基础用法解析库名 ctx7 library react ctx7 library nextjs app router setup ctx7 library prisma database relations # 以 JSON 格式输出原始结果便于脚本处理 ctx7 library react --json输出结果TTY 终端下会为每个候选库展示标题、Context7 库 ID形如/owner/repo供docs命令直接使用、描述、代码片段数量、来源信誉Source Reputation、基准评分与可用版本并在结果顶部给出可直接复制的ctx7 docs 库 ID 问题快捷命令。从 packages/cli/src/commands/docs.ts 的实现看信誉等级按trustScore划分7为 High4为 Medium否则为 Low未知或负值时显示 Unknown。提示若你的 Context7 团队空间配置了库过滤策略结果可能只包含符合过滤条件的库CLI 会给出相应提示详见 packages/cli/src/commands/docs.ts。查询文档ctx7 docsdocs命令使用库 ID 拉取指定主题的最新文档。它内部调用getLibraryContext见 packages/cli/src/utils/api.ts请求GET {baseUrl}/api/v2/context携带libraryId与query两个必填参数。ctx7 docs /facebook/react useEffect cleanup ctx7 docs /vercel/next.js middleware authentication ctx7 docs /prisma/prisma one-to-many relations # JSON 输出返回 codeSnippets / infoSnippets 等结构化字段 ctx7 docs /facebook/react hooks --json几个关键行为值得注意库 ID 必须符合/owner/repo或/owner/repo/version格式否则会报错并提示正确的 ID 写法见 packages/cli/src/commands/docs.ts。查询建议单主题提问命令帮助文本明确建议每个独立概念单独跑一次查询除非你想了解它们如何交互。Git Bash 兼容性Windows Git Bash 会把/owner/repo重写为 Windows 路径CLI 内部通过recoverLibraryId尝试还原若仍失败官方建议在 ID 前再加一个斜杠ctx7 docs //facebook/react 问题。库重定向处理当库发生迁移时服务端返回 301 与redirectUrlCLI 会提示新 ID 并让你用新 ID 重新查询见 packages/cli/src/commands/docs.ts。输出格式非 JSON 模式下代码片段含语言标签、标题、描述与说明片段含面包屑导航会按可读的 Markdown 形式打印JSON 模式下返回完整响应对象。一键配置ctx7 setup的完整机制setup命令是ctx7的核心价值所在它自动完成 OAuth 认证、生成 API Key、写入 MCP 配置、安装规则文件与技能Skill文件四件事让你的 AI 编码代理开箱即用地访问 Context7。支持的代理与配置落点setup会自动检测本机已安装的代理也可通过标志显式指定。代理检测基于配置文件是否存在见 packages/cli/src/setup/agents.ts代理检测目录项目级检测目录全局级Claude Code.mcp.json、.claude~/.claude或$CLAUDE_CONFIG_DIRCursor.cursor~/.cursorOpenCodeopencode.json/opencode.jsonc/.opencode.json/.opencode.jsonc~/.config/opencodeCodex.codex~/.codexAntigravity.agent~/.gemini/antigravity、~/.agentGemini CLI.gemini~/.gemini配置写入路径MCP 配置、规则、技能同样在 agents.ts 中按代理定义例如Cursor 的 MCP 配置写入~/.cursor/mcp.json全局或.cursor/mcp.json项目规则写入rules/context7.mdcClaude Code 的规则写入.claude/rules/context7.md或~/.claude/rules/context7.mdOpenCode 与 Codex 的规则以追加段落方式写入AGENTS.md并用!-- context7 --标记包裹以便后续定位和卸载。两种接入模式交互式运行ctx7 setup时CLI 会询问你的代理应如何访问 Context7见 packages/cli/src/commands/setup.tsMCP server 模式默认推荐通过 MCP 协议注册 Context7 工具代理可实时调用工具获取最新库文档。HTTP 传输默认指向https://mcp.context7.com/mcpOAuth 模式为/mcp/oauth也支持--stdio以本地npx upstash/context7-mcp进程方式运行。CLI Skills 模式不启用 MCP 服务而是安装一个find-docs技能Skill引导代理用ctx7CLI 命令获取最新文档。使用--mcp、--cli标志可直接指定模式在--yes、--oauth、--stdio等非交互场景下默认走 MCP 模式。认证方式setup默认走 OAuth自动登录并生成 API Key也支持显式提供 API Key# 默认OAuth 登录若已登录则复用现有凭据 ctx7 setup # 使用已有 API Key跳过 OAuth ctx7 setup --api-key YOUR_API_KEY # 使用 OAuth 端点由 IDE 处理认证流程 ctx7 setup --oauth # 本地 stdio 方式运行 MCP 服务默认是 HTTP ctx7 setup --stdio认证逻辑在 packages/cli/src/commands/setup.ts默认情况下CLI 先尝试取有效访问令牌没有则执行设备授权登录performLogin成功后调用POST {baseUrl}/api/dashboard/api-keys生成一个名为ctx7-cli-随机hex的 API Key并把该 Key 写入对应代理的 MCP 配置中作为Authorization: Bearer头。需要注意--stdio与--oauth互斥--stdio用于本地进程而 OAuth 依赖托管的 HTTP 端点组合使用会直接报错见 packages/cli/src/commands/setup.ts。作用域与其他选项# 仅配置当前项目默认是全局配置 ctx7 setup --project # 跳过所有确认提示非交互式/CI 友好 ctx7 setup --yes # 指定代理 ctx7 setup --claude --cursor --opencode --codex --antigravity --gemini作用域--project将配置写入当前工作目录下的项目级文件如.cursor/mcp.json、.claude/rules/context7.md默认写入用户级全局文件。技能文件安装MCP 模式会从 Context7 下载context7-mcp技能并安装到对应代理的 skills 目录例如~/.cursor/skills/context7-mcp/SKILL.mdCLI 模式安装find-docs技能。技能安装失败时会给出明确错误遇到权限问题EACCES还会提示用sudo chown -R $(whoami) 目录修复见 packages/cli/src/commands/setup.ts。仓库中可看到这些技能/插件文件的真实形态例如 skills/find-docs/SKILL.md 与 plugins/claude/context7/agents/docs-researcher.md。卸载配置ctx7 removeremove别名uninstall用于清理setup写入的一切痕迹。默认同时移除所选代理的MCP 配置与CLI Skills 配置也可精确指定# 交互式自动检测已配置 Context7 的代理并勾选 ctx7 remove # 指定代理 ctx7 remove --cursor ctx7 remove --claude --project # 显式移除两种模式 ctx7 remove --cursor --all # 只移除某一种模式 ctx7 remove --cursor --cli ctx7 remove --claude --mcp从 packages/cli/src/commands/remove.ts 的实现看remove会逐项检查并清理MCP 配置从 JSON 配置如 Cursor 的mcp.json、Claude 的.claude.json中删除context7服务条目或从 TOML 配置如 Codex 的config.toml中删除context7服务器段见 remove.ts。规则文件独立规则文件如context7.md/context7.mdc直接删除追加型规则AGENTS.md/GEMINI.md则移除!-- context7 --标记包裹的段落若文件因此为空则删除文件本身见 remove.ts。技能目录删除context7-mcp或find-docs技能目录见 remove.ts。清理结果会按代理汇总打印每项的removed/not found/failed状态。如果没有检测到任何 Context7 配置remove会提示未找到可移除的配置并建议显式传入代理标志。登录认证login、whoami、logout登录用于访问需要认证的 setup 功能以及更高的文档请求速率限制README 原文Log in to access authenticated setup and higher documentation rate limits。# 登录默认自动打开浏览器完成 OAuth 设备授权 ctx7 login # 不自动打开浏览器适合无浏览器/远程环境 ctx7 login --no-browser # 查看当前登录状态与账号信息 ctx7 whoami # 退出登录 ctx7 logout登录流程基于OAuth 2.0 设备授权流RFC 8628实现见 packages/cli/src/commands/auth.ts 与 packages/cli/src/utils/auth.tsCLI 向/api/oauth/device/code请求设备授权附带客户端 ID仓库中为2veBSofhicRBguUT见 packages/cli/src/constants.ts及本机主机名用于服务端展示、增强防钓鱼能力。终端打印一个带边框的一次性代码与验证链接verification_uri_complete可用时仍同时显示裸的verification_uri方便屏幕阅读器用户手动输入符合 RFC 8628 §3.3。按回车打开浏览器完成授权后CLI 以 5 秒默认间隔轮询/api/oauth/device/token处理pending等待中、slow_down轮询间隔 5 秒、denied拒绝、expired过期、transient网络抖动同样 5 秒后继续避免 5xx 风暴等状态。授权成功后保存令牌whoami会显示登录名、邮箱与所属 Teamspace请求GET {baseUrl}/api/dashboard/whoami。令牌保存在遵循 XDG 规范的配置目录中默认~/.config/context7/credentials.json并以0600权限写入确保凭证不被同组用户读取同时支持从旧版~/.context7/目录自动迁移见 packages/cli/src/utils/storage-paths.ts。getValidAccessToken会在令牌过期前自动用refresh_token刷新见 packages/cli/src/utils/auth.ts0.5 之后的新安装持有长期有效的 API Key无需刷新。其他能力版本、升级与 API 端点版本与帮助ctx7 -v, --version查看版本号读取自package.jsonctx7 --help查看全部命令。自定义 API 端点入口支持全局--base-url url选项可在开发/私有部署场景下把 API 与认证端点指向自建服务见 packages/cli/src/index.ts。升级提示执行命令前会自动检查并提示新版本maybeShowUpgradeNotice见 packages/cli/src/index.ts另有ctx7 upgrade命令。API 请求头所有文档/搜索请求会携带X-Context7-Source: cli、X-Context7-Client-IDE: ctx7-cli、X-Context7-Client-Version与X-Context7-Transport: cli标记并优先使用CONTEXT7_API_KEY环境变量作为 Bearer 凭证见 packages/cli/src/utils/api.ts。支持的客户端一览ctx7自动检测并配置的代理及其技能目录源自 agents.ts 中AgentConfig定义与仓库文档客户端技能目录通用Amp、Codex、Gemini CLI、GitHub Copilot、OpenCode 等.agents/skills/Claude Code.claude/skills/Cursor.cursor/skills/Antigravity.agent/skills/仓库中对应的代理插件与技能实现可参考 plugins/cursor/context7/mcp.json、plugins/claude/context7/skills/context7-mcp/SKILL.md 与 plugins/agent-plugins/context7/plugin.json。关闭遥测CLI 会收集匿名使用数据用于产品改进事件上报实现见 packages/cli/src/utils/tracking.tstrackEvent会 POST 到{baseUrl}/api/v2/cli/events失败静默忽略。如需关闭设置环境变量CTX7_TELEMETRY_DISABLED# 仅对单条命令生效 CTX7_TELEMETRY_DISABLED1 ctx7 docs /facebook/react useEffect examples # 写入 shell 配置文件永久生效~/.bashrc、~/.zshrc 等 export CTX7_TELEMETRY_DISABLED1结语ctx7把让 AI 编码代理始终读到最新库文档这件事压缩成了几条命令library解析库 ID、docs拉取文档、setup一键配置 MCP 与规则、remove干净卸载、login/whoami/logout管理认证。其内部对多代理配置落点、RFC 8628 设备授权、XDG 存储规范、令牌刷新与错误提示的处理都体现了对真实开发环境的细致考量。无论是个人开发者快速接入还是 CI 环境下用--yes非交互式部署ctx7都能直接上手使用。【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考