context7

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Context7

Search and retrieve library documentation using the Context7 API. Get relevant, up-to-date documentation snippets for any programming library.

使用Context7 API搜索和检索类库文档。获取任意编程类库的相关、最新文档片段。

Setup

安装配置

Create an account at https://context7.com/dashboard
Create an API key

Add to your shell profile (

~/.profile

~/.zprofile

for zsh):

bash

export CONTEXT7_API_KEY="your-api-key-here"

Install dependencies (run once):
bash
```
cd {baseDir}
npm install
```

在https://context7.com/dashboard创建账户
创建API密钥
添加到你的Shell配置文件（zsh用户为~/.profile或~/.zprofile）：
bash
```
export CONTEXT7_API_KEY="your-api-key-here"
```
安装依赖（运行一次）：
bash
```
cd {baseDir}
npm install
```

Search Libraries

搜索类库

Find libraries by name to get their IDs:

bash

{baseDir}/search.js "react"                    # Search for React libraries
{baseDir}/search.js "nextjs" -n 5              # Get 5 results
{baseDir}/search.js "typescript"               # Search TypeScript libs

通过名称查找类库以获取其ID：

bash

{baseDir}/search.js "react"                    # Search for React libraries
{baseDir}/search.js "nextjs" -n 5              # Get 5 results
{baseDir}/search.js "typescript"               # Search TypeScript libs

Options

选项

```
-n <num>
```
- Number of results (default: 3, max: 20)

```
-n <num>
```
- 结果数量（默认值：3，最大值：20）

Get Documentation

获取文档

Retrieve documentation for a specific library:

bash

{baseDir}/docs.js "/facebook/react" "how to use useState"
{baseDir}/docs.js "/vercel/next.js" "app router setup"
{baseDir}/docs.js "/microsoft/typescript" "generics" --format txt

检索特定类库的文档：

bash

{baseDir}/docs.js "/facebook/react" "how to use useState"
{baseDir}/docs.js "/vercel/next.js" "app router setup"
{baseDir}/docs.js "/microsoft/typescript" "generics" --format txt

Options

选项

```
--format <type>
```
- Output format:
```
json
```
(default) or
```
txt
```

```
--format <type>
```
- 输出格式：
```
json
```
（默认）或
```
txt
```

Complete Workflow

完整工作流程

First, search for the library to find its ID:
bash
```
{baseDir}/search.js "react"
```

Then, get documentation using the library ID:

bash

{baseDir}/docs.js "/facebook/react" "useEffect cleanup"

首先，搜索类库以找到其ID：
bash
```
{baseDir}/search.js "react"
```

然后，使用类库ID获取文档：

bash

{baseDir}/docs.js "/facebook/react" "useEffect cleanup"

Output Format

输出格式

Search Results

搜索结果

--- Library 1 ---
ID: /facebook/react
Name: React
Description: A JavaScript library for building user interfaces
Snippets: 1250
Trust Score: 95
Versions: v18.2.0, v17.0.2

--- Library 2 ---
...

--- Library 1 ---
ID: /facebook/react
Name: React
Description: A JavaScript library for building user interfaces
Snippets: 1250
Trust Score: 95
Versions: v18.2.0, v17.0.2

--- Library 2 ---
...

Documentation Results (JSON format)

文档结果（JSON格式）

--- Doc 1 ---
Title: Using the Effect Hook
Source: react.dev/reference/react/useEffect
Content:
  The Effect Hook lets you perform side effects...

--- Doc 2 ---
...

--- Doc 1 ---
Title: Using the Effect Hook
Source: react.dev/reference/react/useEffect
Content:
  The Effect Hook lets you perform side effects...

--- Doc 2 ---
...

Documentation Results (Text format)

文档结果（文本格式）

[Plain text documentation ready for LLM context]

[Plain text documentation ready for LLM context]

When to Use

使用场景

Getting up-to-date documentation for libraries
Understanding API usage and best practices
Finding code examples and patterns
Learning about specific library features

获取类库的最新文档
了解API使用方法和最佳实践
查找代码示例和模式
了解特定类库的功能