Guia Central para
ctx— CLI para repository maps e busca semântica local.
- README.md — Instalação, exemplos rápidos
- Quick Start — Começar em 5 minutos
- CLI Reference — Todos os subcomandos e opções
- Arquitetura — Design interno, pipelines, módulos
- Padrões de Design — Invariantes, como estender
- API Rust — Usar
context_enginecomo biblioteca
- Code Search SoTA — Survey de BM25, embeddings, PageRank
- Decisões Técnicas — Trade-offs considerados
ctx map — Repository Map
Gera mapa curado da estrutura de código para LLMs.
- Como funciona — Pipeline: Scanner → Extractor → Ranking
- Ranking Algorithm — BM25 + Personalized PageRank
- Exemplos — Casos de uso comuns
ctx search (Catalog) — Busca Semântica
RAG local para documentação: indexação, embeddings, busca + re-ranking.
- Overview — O que é, componentes, fluxo
- Indexação — Descoberta de documentos, chunking
- Embeddings — Geração de vetores semânticos
- Re-ranking — Re-ranking contextual
- Exemplos — Casos de uso
- Especificação — Regras de negócio detalhadas
- Implementação — Detalhes técnicos
ctx exec — Command Output Compression
Comprime output de comandos shell mantendo essencial, economizando tokens.
- Overview — O que é, como funciona
- Filtering Pipeline — Os 8 estágios
- Configuration — Customização
- Metrics — Rastreamento de economia
ctx graph — Grafo de Chamadas Semântico
Mapeamento e navegação de fluxo e símbolos (callers, callees, trace, impact).
- Overview — Como funciona, subcomandos e framework routing
| Tópico | Link |
|---|---|
| Visão Geral de Pipelines | architecture/pipelines.md |
| Referência de Módulos | architecture/modules.md |
| Como Estender | architecture/extending.md |
| Decisões Arquiteturais | architecture/design-decisions.md |
| Padrões de Código | architecture/design-patterns.md |
- Visão do Produto — Por que existe, status, roadmap
- Roadmap — Próximas features
- Integração com Agentes —
ctx install/ctx uninstall(hooks Claude Code) - Troubleshooting — Problemas comuns e soluções
docs/
├── INDEX.md ← Você está aqui
├── guides/ ← How-to, quick-start, troubleshooting
│ ├── quick-start.md
│ ├── cli-reference.md
│ ├── vision.md
│ ├── roadmap.md
│ └── troubleshooting.md
├── map/ ← Subcomando `ctx map`
│ ├── README.md
│ ├── how-it-works.md
│ ├── ranking-algorithm.md
│ └── examples.md
├── search/ ← Subcomando `ctx search` (catalog)
│ ├── README.md
│ ├── overview.md
│ ├── indexing.md
│ ├── embeddings.md
│ ├── reranking.md
│ ├── examples.md
│ ├── specification.md
│ └── implementation.md
├── exec/ ← Subcomando `ctx exec`
│ ├── overview.md
│ ├── filtering-pipeline.md
│ ├── configuration.md
│ └── metrics.md
├── graph/ ← Subcomando `ctx graph`
│ └── README.md
├── architecture/ ← Design interno
│ ├── README.md
│ ├── pipelines.md
│ ├── modules.md
│ ├── extending.md
│ ├── design-decisions.md
│ └── design-patterns.md
├── api/ ← Rust crate reference
│ └── README.md
└── research/ ← Pesquisa & decisões
├── README.md
├── code-search-sota.md
└── implementation-decisions.md
| Cenário | Comece Aqui | Depois |
|---|---|---|
Usar ctx map |
map/README.md | map/how-it-works.md |
Usar ctx search |
search/README.md | search/overview.md |
Usar ctx exec |
exec/overview.md | exec/configuration.md |
Usar ctx graph |
graph/README.md | graph/README.md |
| Entender projeto | guides/vision.md | architecture/README.md |
| Implementar feature | architecture/design-patterns.md | Código + testes |
| Adicionar linguagem | architecture/extending.md | src/pipelines/map/extractors/<lang>.rs |
| Integrar com agente | guides/agent-integration.md | src/integrations/agents/<agente>.rs |
| Troubleshoot | guides/troubleshooting.md | Logs com RUST_LOG |
| Pesquisa técnica | research/README.md | PRs no git |
Documentação:
- Português nos comentários e docs
- Código em inglês
- Links sempre relativos (
path/to/file.md) - Atualizar este INDEX.md quando adicionar arquivo novo
Mudanças de Código:
- Se mudar arquitetura → atualizar
architecture/ - Se mudar CLI → atualizar
guides/cli-reference.md - Se mudar spec → atualizar
search/specification.mdoumap/how-it-works.md