문서 조회
Context7 CLI를 사용하여 모든 라이브러리의 현재 문서와 코드 예제를 검색합니다.
명령어를 실행하기 전에 CLI가 최신 버전인지 확인하세요:
npm install -g ctx7@latest
또는 설치하지 않고 직접 실행할 수 있습니다:
npx ctx7@latest <command>
워크플로우
두 단계 과정: 라이브러리 이름을 ID로 변환한 후 해당 ID로 문서를 조회합니다.
# 1단계: 라이브러리 ID 변환
ctx7 library <name> <query>
# 2단계: 문서 조회
ctx7 docs <libraryId> <query>
사용자가 명시적으로 /org/project 또는 /org/project/version 형식의 라이브러리 ID를 제공하지 않는 한, 반드시 먼저 ctx7 library를 호출하여 유효한 라이브러리 ID를 얻어야 합니다.
중요: 질문당 이 명령어를 3번 이상 실행하지 마십시오. 3회 시도 후에도 필요한 내용을 찾지 못했다면, 가장 좋은 결과를 사용하십시오.
1단계: 라이브러리 변환
패키지/제품 이름을 Context7 호환 라이브러리 ID로 변환하고 일치하는 라이브러리를 반환합니다.
ctx7 library react "How to clean up useEffect with async operations"
ctx7 library nextjs "How to set up app router with middleware"
ctx7 library prisma "How to define one-to-many relations with cascade delete"
항상 query 인수를 전달하세요. 필수이며 결과 순위에 직접적인 영향을 미칩니다. 사용자의 의도를 사용하여 쿼리를 구성하면, 여러 라이브러리가 비슷한 이름을 가질 때 구분하는 데 도움이 됩니다. 쿼리에 API 키, 비밀번호, 자격 증명, 개인 데이터 또는 독점 코드와 같은 민감하거나 기밀 정보를 포함하지 마십시오.
결과 필드
각 결과에는 다음이 포함됩니다:
- 라이브러리 ID — Context7 호환 식별자 (형식:
/org/project) - 이름 — 라이브러리 또는 패키지 이름
- 설명 — 간단한 요약
- 코드 스니펫 — 사용 가능한 코드 예제 수
- 소스 평판 — 권위 지표 (높음, 중간, 낮음 또는 알 수 없음)
- 벤치마크 점수 — 품질 지표 (100이 최고 점수)
- 버전 — 사용 가능한 경우 버전 목록. 사용자가 쿼리에서 버전을 제공한 경우 해당 버전 중 하나를 사용하십시오. 형식은
/org/project/version입니다.
선택 과정
- 쿼리를 분석하여 사용자가 찾고 있는 라이브러리/패키지를 파악합니다
- 다음 기준에 따라 가장 관련성 높은 일치 항목을 선택합니다:
- 쿼리와의 이름 유사성 (정확히 일치하는 항목 우선)
- 쿼리 의도와의 설명 관련성
- 문서 적용 범위 (코드 스니펫 수가 많은 라이브러리 우선)
- 소스 평판 (높음 또는 중간 평판의 라이브러리를 더 권위 있게 고려)
- 벤치마크 점수 (높을수록 좋으며, 100이 최대)
- 여러 좋은 일치 항목이 있는 경우 이를 인정하되 가장 관련성 높은 항목으로 진행합니다
- 좋은 일치 항목이 없는 경우 이를 명확히 밝히고 쿼리 개선 사항을 제안합니다
- 모호한 쿼리의 경우, 최선의 추측으로 진행하기 전에 명확히 요청합니다
버전별 ID
사용자가 특정 버전을 언급한 경우, 버전별 라이브러리 ID를 사용하십시오:
# 일반 (최신 색인)
ctx7 docs /vercel/next.js "How to set up app router"
# 버전별
ctx7 docs /vercel/next.js/v14.3.0-canary.87 "How to set up app router"
사용 가능한 버전은 ctx7 library 출력에 나열됩니다. 사용자가 지정한 내용과 가장 가까운 일치 항목을 사용하십시오.
2단계: 문서 조회
변환된 라이브러리의 최신 문서와 코드 예제를 검색합니다.
ctx7 docs /facebook/react "How to clean up useEffect with async operations"
ctx7 docs /vercel/next.js "How to add authentication middleware to app router"
ctx7 docs /prisma/prisma "How to define one-to-many relations with cascade delete"
좋은 쿼리 작성법
쿼리는 결과 품질에 직접적인 영향을 미칩니다. 구체적으로 작성하고 관련 세부 정보를 포함하십시오. 쿼리에 API 키, 비밀번호, 자격 증명, 개인 데이터 또는 독점 코드와 같은 민감하거나 기밀 정보를 포함하지 마십시오.
| 품질 | 예시 |
|---|---|
| 좋음 | "How to set up authentication with JWT in Express.js" |
| 좋음 | "React useEffect cleanup function with async operations" |
| 나쁨 | "auth" |
| 나쁨 | "hooks" |
가능하면 사용자의 전체 질문을 쿼리로 사용하십시오. 모호한 한 단어 쿼리는 일반적인 결과를 반환합니다.
출력에는 두 가지 유형의 콘텐츠가 포함됩니다: 코드 스니펫 (제목이 있고 언어 태그가 지정된 블록)과 정보 스니펫 (이동 경로 컨텍스트가 있는 설명 텍스트).
인증
인증 없이도 작동합니다. 더 높은 요청 한도를 위해서는:
# 옵션 A: 환경 변수
export CONTEXT7_API_KEY=your_key
# 옵션 B: OAuth 로그인
ctx7 login
오류 처리
명령어가 할당량 오류로 실패하는 경우 ("월 할당량에 도달했습니다" 또는 "할당량 초과"):
- 사용자에게 Context7 할당량이 소진되었음을 알립니다
- 더 높은 한도를 위해 인증을 제안합니다:
ctx7 login - 사용자가 인증할 수 없거나 인증하지 않기로 선택한 경우, 훈련 데이터를 기반으로 답변하고 이것이 오래된 정보일 수 있음을 명확히 명시합니다
조용히 훈련 데이터로 대체하지 마십시오. 항상 Context7이 사용되지 않은 이유를 사용자에게 알리십시오.
일반적인 실수
- 라이브러리 ID는
/접두사가 필요합니다 —/facebook/react는 되지만facebook/react는 안 됩니다 - 항상 먼저
ctx7 library를 실행하십시오 —ctx7 docs react "hooks"는 유효한 ID 없이 실패합니다 - 한 단어가 아닌 설명적인 쿼리를 사용하십시오 —
"React useEffect cleanup function"은 되지만"hooks"는 안 됩니다 - 쿼리에 민감한 정보(API 키, 비밀번호, 자격 증명)를 포함하지 마십시오