context7

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Context7 Documentation Fetcher

Context7 文档获取工具

Retrieve current library documentation via Context7 API.
通过Context7 API获取最新的库文档。

Authentication

认证

This skill requires a Context7 API key in
CONTEXT7_API_KEY
.
Recommended setup options:
  1. Export it in your shell profile (global):
bash
export CONTEXT7_API_KEY="your-context7-key"
  1. Use a local
    .env
    file (per-repo):
bash
cp skills/context7/.env.example .env
set -a; source .env; set +a
此技能需要在
CONTEXT7_API_KEY
中配置Context7 API密钥。
推荐的设置选项:
  1. 在shell配置文件中全局导出:
bash
export CONTEXT7_API_KEY="your-context7-key"
  1. 使用本地
    .env
    文件(按仓库配置):
bash
cp skills/context7/.env.example .env
set -a; source .env; set +a

Workflow

工作流程

1. Search for the library

1. 搜索库

bash
python3 ~/.codex/skills/context7/scripts/context7.py search "<library-name>"
Example:
bash
python3 ~/.codex/skills/context7/scripts/context7.py search "next.js"
Returns library metadata including the
id
field needed for step 2.
bash
python3 ~/.codex/skills/context7/scripts/context7.py search "<library-name>"
示例:
bash
python3 ~/.codex/skills/context7/scripts/context7.py search "next.js"
返回库的元数据,包括步骤2所需的
id
字段。

2. Fetch documentation context

2. 获取文档上下文

bash
python3 ~/.codex/skills/context7/scripts/context7.py context "<library-id>" "<query>"
Example:
bash
python3 ~/.codex/skills/context7/scripts/context7.py context "/vercel/next.js" "app router middleware"
Options:
  • --type txt|md
    - Output format (default: txt)
  • --tokens N
    - Limit response tokens
bash
python3 ~/.codex/skills/context7/scripts/context7.py context "<library-id>" "<query>"
示例:
bash
python3 ~/.codex/skills/context7/scripts/context7.py context "/vercel/next.js" "app router middleware"
选项:
  • --type txt|md
    - 输出格式(默认:txt)
  • --tokens N
    - 限制响应的token数量

Quick Reference

快速参考

TaskCommand
Find React docs
search "react"
Get React hooks info
context "/facebook/react" "useEffect cleanup"
Find Supabase
search "supabase"
Get Supabase auth
context "/supabase/supabase" "authentication row level security"
任务命令
查找React文档
search "react"
获取React Hooks信息
context "/facebook/react" "useEffect cleanup"
查找Supabase
search "supabase"
获取Supabase认证信息
context "/supabase/supabase" "authentication row level security"

When to Use

使用场景

  • Before implementing any library-dependent feature
  • When unsure about current API signatures
  • For library version-specific behavior
  • To verify best practices and patterns
  • 在实现任何依赖库的功能之前
  • 不确定当前API签名时
  • 需要了解库特定版本的行为时
  • 验证最佳实践和模式时