Consulta de Documentação
Recupere documentação atualizada e exemplos de código para qualquer biblioteca usando a CLI do Context7.
Certifique-se de que a CLI esteja atualizada antes de executar os comandos:
npm install -g ctx7@latest
Ou execute diretamente sem instalar:
npx ctx7@latest <comando>
Fluxo de Trabalho
Processo em duas etapas: resolver o nome da biblioteca para um ID e, em seguida, consultar a documentação com esse ID.
# Etapa 1: Resolver o ID da biblioteca
ctx7 library <nome> <consulta>
# Etapa 2: Consultar a documentação
ctx7 docs <libraryId> <consulta>
VOCÊ DEVE chamar ctx7 library primeiro para obter um ID de biblioteca válido, A MENOS QUE o usuário forneça explicitamente um ID de biblioteca no formato /org/projeto ou /org/projeto/versão.
IMPORTANTE: Não execute esses comandos mais de 3 vezes por pergunta. Se não conseguir encontrar o que precisa após 3 tentativas, use o melhor resultado que você tem.
Etapa 1: Resolver uma Biblioteca
Resolve um nome de pacote/produto para um ID de biblioteca compatível com Context7 e retorna bibliotecas correspondentes.
ctx7 library react "Como limpar useEffect com operações assíncronas"
ctx7 library nextjs "Como configurar o roteador app com middleware"
ctx7 library prisma "Como definir relações um-para-muitos com exclusão em cascata"
Sempre passe um argumento query — ele é obrigatório e afeta diretamente a classificação dos resultados. Use a intenção do usuário para formar a consulta, o que ajuda a desambiguar quando várias bibliotecas compartilham um nome semelhante. Não inclua nenhuma informação sensível ou confidencial, como chaves de API, senhas, credenciais, dados pessoais ou código proprietário em sua consulta.
Campos dos resultados
Cada resultado inclui:
- ID da Biblioteca — Identificador compatível com Context7 (formato:
/org/projeto) - Nome — Nome da biblioteca ou pacote
- Descrição — Resumo curto
- Trechos de Código — Número de exemplos de código disponíveis
- Reputação da Fonte — Indicador de autoridade (Alta, Média, Baixa ou Desconhecida)
- Pontuação de Benchmark — Indicador de qualidade (100 é a pontuação mais alta)
- Versões — Lista de versões, se disponível. Use uma dessas versões se o usuário fornecer uma versão em sua consulta. O formato é
/org/projeto/versão.
Processo de seleção
- Analise a consulta para entender qual biblioteca/pacote o usuário está procurando
- Selecione a correspondência mais relevante com base em:
- Similaridade de nome com a consulta (correspondências exatas são priorizadas)
- Relevância da descrição para a intenção da consulta
- Cobertura da documentação (priorize bibliotecas com contagens de trechos de código mais altas)
- Reputação da fonte (considere bibliotecas com reputação Alta ou Média como mais autoritativas)
- Pontuação de benchmark (quanto mais alta, melhor; 100 é o máximo)
- Se houver várias boas correspondências, reconheça isso, mas prossiga com a mais relevante
- Se não houver boas correspondências, declare isso claramente e sugira refinamentos na consulta
- Para consultas ambíguas, solicite esclarecimento antes de prosseguir com uma correspondência de melhor palpite
IDs específicos de versão
Se o usuário mencionar uma versão específica, use um ID de biblioteca específico de versão:
# Geral (última versão indexada)
ctx7 docs /vercel/next.js "Como configurar o roteador app"
# Específico de versão
ctx7 docs /vercel/next.js/v14.3.0-canary.87 "Como configurar o roteador app"
As versões disponíveis estão listadas na saída de ctx7 library. Use a correspondência mais próxima do que o usuário especificou.
Etapa 2: Consultar Documentação
Recupera documentação atualizada e exemplos de código para a biblioteca resolvida.
ctx7 docs /facebook/react "Como limpar useEffect com operações assíncronas"
ctx7 docs /vercel/next.js "Como adicionar middleware de autenticação ao roteador app"
ctx7 docs /prisma/prisma "Como definir relações um-para-muitos com exclusão em cascata"
Escrevendo boas consultas
A consulta afeta diretamente a qualidade dos resultados. Seja específico e inclua detalhes relevantes. Não inclua nenhuma informação sensível ou confidencial, como chaves de API, senhas, credenciais, dados pessoais ou código proprietário em sua consulta.
| Qualidade | Exemplo |
|---|---|
| Boa | "Como configurar autenticação com JWT no Express.js" |
| Boa | "Função de limpeza do React useEffect com operações assíncronas" |
| Ruim | "auth" |
| Ruim | "hooks" |
Use a pergunta completa do usuário como consulta quando possível; consultas vagas de uma palavra retornam resultados genéricos.
A saída contém dois tipos de conteúdo: trechos de código (com título e blocos com tag de linguagem) e trechos de informação (explicações em prosa com contexto de navegação estrutural).
Autenticação
Funciona sem autenticação. Para limites de taxa mais altos:
# Opção A: variável de ambiente
export CONTEXT7_API_KEY=sua_chave
# Opção B: login OAuth
ctx7 login
Tratamento de Erros
Se um comando falhar com um erro de cota ("Cota mensal atingida" ou "cota excedida"):
- Informe o usuário que a cota do Context7 foi esgotada
- Sugira que ele autentique para limites mais altos:
ctx7 login - Se ele não puder ou optar por não autenticar, responda com base no conhecimento de treinamento e observe claramente que pode estar desatualizado
Não recorra silenciosamente aos dados de treinamento — sempre diga ao usuário por que o Context7 não foi usado.
Erros Comuns
- IDs de biblioteca exigem um prefixo
/—/facebook/reactnãofacebook/react - Sempre execute
ctx7 libraryprimeiro —ctx7 docs react "hooks"falhará sem um ID válido - Use consultas descritivas, não palavras isoladas —
"Função de limpeza do React useEffect"não"hooks" - Não inclua informações sensíveis (chaves de API, senhas, credenciais) nas consultas