CLI
Vectora oferece uma interface CLI completa para configuração, indexação e debugging. Use para automação, CI/CD ou desenvolvimento local.
Use vectora --help para ver todos os comandos, ou vectora [command] --help para detalhes específicos.
Estrutura Geral
vectora [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS]Global Flags
--version, -v # Mostra versão
--help, -h # Mostra ajuda
--config PATH # Caminho customizado ao vectora.yaml
--namespace NS # Override namespace padrão (default: local)
--debug # Ativa modo debug (verbose logging)
--quiet, -q # Suprime output (exceto erros)
--json # Output em JSON para automaçãoExemplos:
vectora --version
vectora --debug index
vectora --namespace staging init
vectora --config ./custom.yaml search "query"Commands
A interface de linha de comando do Vectora é organizada em subcomandos lógicos que facilitam o gerenciamento de todo o ciclo de vida do seu projeto.
vectora init
Inicializa um novo projeto Vectora.
vectora init [OPTIONS]
OPTIONS:
--name NAME # Nome do projeto (default: diretório)
--type TYPE # Tipo: codebase|docs|hybrid (default: codebase)
--namespace NS # Namespace customizado (default: org-project-env)
--trust-folder PATH # Trust folder (default: .)
--providers YAML # Config de providers (veja config docs)Exemplos:
vectora init --name "Meu App" --type codebase
# Cria vectora.config.yaml + .vectora/
vectora init --namespace kaffyn-backend-prod --type codebase
# Cria com namespace específicovectora index
Indexa arquivos no namespace.
vectora index [OPTIONS]
OPTIONS:
--force # Reindexar mesmo se não houver mudanças detectadas
--incremental # Apenas arquivos novos/modificados (default: true)
--exclude PATTERN # Excluir globs (ex: bin/**, .git/**)
--include PATTERN # Incluir apenas globs (ex: pkg/**, cmd/**)
--dry-run # Simula a indexação sem persistir dados
--watch # Observa mudanças no filesystem (modo dev)Exemplos:
# Indexar incremental (padrão)
vectora index
# Reindexar tudo
vectora index --force
# Apenas arquivos Go
vectora index --include "**/*.go"
# Modo desenvolvimento (watch)
vectora index --watch
# Verificar o que seria indexado
vectora index --dry-runvectora search
Busca semântica pela CLI.
vectora search QUERY [OPTIONS]
OPTIONS:
--strategy STRATEGY # semantic|structural|hybrid (default: semantic)
--top-k NUM # Quantidade de resultados (default: 10)
--format FORMAT # text|json|markdown (default: text)
--include-snippets # Incluir trecho de código
--compare-baseline # Comparar com versão anteriorExemplos:
# Busca simples
vectora search "Como faz login?"
# Busca estrutural para relações de código
vectora search "Quem chama getUserById?" --strategy structural
# Output em JSON
vectora search "validação" --format json
# Busca com snippets de código
vectora search "middleware" --include-snippetsvectora analyze
Análise profunda com LLM (Gemini).
vectora analyze QUERY [OPTIONS]
OPTIONS:
--model MODEL # llm a usar (default: gemini-3-flash)
--context NUM # Quantos chunks usar (default: 10)
--output FILE # Salvar em arquivo (ex: report.md)
--compare-baseline # Comparar com análise anteriorExemplos:
# Análise simples
vectora analyze "Como funciona autenticação?"
# Análise profunda
vectora analyze "Revise esse código para segurança" --model gemini-pro --context 20
# Salvar em arquivo
vectora analyze "Escreva documentação de API" --output docs/api.mdvectora config
Gerencia configuração.
vectora config [SUBCOMMAND]
SUBCOMMANDS:
get KEY # Obter valor
set KEY VALUE # Definir valor
list # Listar tudo
validate # Validar config atual
reset # Reset para padrão
show-schema # Mostrar schema YAMLExemplos:
# Ver configuração atual
vectora config list
# Ver chave específica
vectora config get project.namespace
# Definir chave
vectora config set context_engine.strategy semantic
# Validar config
vectora config validate
# Ver schema disponível
vectora config show-schemavectora namespace
Gerenciar namespaces.
vectora namespace [SUBCOMMAND]
SUBCOMMANDS:
create --name NS # Criar novo namespace
delete --name NS # Deletar namespace (PERMANENTE)
list # Listar todos os namespaces
info --name NS # Detalhes de um namespace
reset --name NS # Limpar chunks de um namespaceExemplos:
# Listar namespaces
vectora namespace list
# Criar novo
vectora namespace create --name kaffyn-new-project
# Ver detalhes
vectora namespace info --name kaffyn-vectora-prod
# Limpar namespace
vectora namespace reset --name kaffyn-old-projectvectora mcp
Inicia servidor MCP para Claude Code, Cursor, etc.
vectora mcp [OPTIONS]
OPTIONS:
--port PORT # Porta (default: 9090)
--host HOST # Host (default: localhost)
--namespace NS # Namespace padrão
--no-auth # Desabilitar autenticação (dev only)Exemplos:
# Iniciar servidor
vectora mcp
# Com porta customizada
vectora mcp --port 9091
# Servidor público
vectora mcp --host 0.0.0.0 --port 9090vectora server
Inicia HTTP server completo (com UI, webhooks).
vectora server [OPTIONS]
OPTIONS:
--port PORT # Porta (default: 3000)
--host HOST # Host (default: localhost)
--ui # Ativar dashboard web
--webhooks # Ativar suporte a webhooks
--cert FILE # Certificado SSL/TLS
--key FILE # Chave SSL/TLSExemplos:
# Servidor básico
vectora server
# Com UI web
vectora server --ui
# HTTPS com certificado
vectora server --cert cert.pem --key key.pemvectora auth
Gerencia autenticação SSO e tokens de acesso.
vectora auth [COMMAND]
COMMANDS:
login # Inicia fluxo SSO via navegador
logout # Encerra sessão local
status # Mostra usuário logado e validade do token
token # Gerencia personal access tokens (PAT)Exemplos:
# Login interativo (abre navegador para SSO, Systray UI sincroniza automaticamente)
vectora auth login
# Verificar status da conta
vectora auth statusvectora logs
Ver logs de execução.
vectora logs [OPTIONS]
OPTIONS:
--level LEVEL # debug|info|warn|error (default: info)
--service SERVICE # Filtrar por serviço
--since DURATION # Últimas N horas (ex: 24h)
--follow, -f # Stream logs em tempo real
--format FORMAT # text|json (default: text)Exemplos:
# Ver logs recentes
vectora logs --since 1h
# Debug logs em tempo real
vectora logs --level debug --follow
# Logs apenas de busca
vectora logs --service search --since 24h
# JSON para parsing
vectora logs --format json | jq '.[]'vectora metrics
Ver métricas de operação.
vectora metrics [OPTIONS]
OPTIONS:
--period PERIOD # 24h|7d|30d (default: 24h)
--export FORMAT # csv|json|prometheus (default: text)
--output FILE # Salvar em arquivoEjemplos:
# Métricas do último dia
vectora metrics --period 24h
# Exportar como CSV
vectora metrics --period 7d --export csv --output metrics.csv
# Formato Prometheus
vectora metrics --export prometheusvectora audit
Ver log de auditoria (quem fez o quê).
vectora audit [OPTIONS]
OPTIONS:
--action ACTION # Filtrar por ação (search|index|delete)
--user USER # Filtrar por usuário
--since DURATION # Desde quando (ex: 7d)
--limit NUM # Limite de linhas (default: 100)Exemplos:
# Auditoria completa
vectora audit
# Buscas dos últimos 7 dias
vectora audit --action search --since 7d
# Deletions por usuário
vectora audit --action delete --user "seu-email@company.com"vectora health
Verifica saúde do sistema.
vectora health [OPTIONS]
OPTIONS:
--detailed # Mostrar detalhes de cada componente
--fix # Tentar corrigir problemasExemplos:
# Saúde rápida
vectora health
# Com detalhes
vectora health --detailed
# Tentar corrigir
vectora health --fixExit Codes
0 # Sucesso
1 # Erro genérico
2 # Erro de configuração
3 # API error
4 # Autenticação falhou
5 # Namespace não encontradoVariáveis de Ambiente
Substitua options de CLI:
VECTORA_NAMESPACE=staging vectora search "..."
VECTORA_LOG_LEVEL=debug vectora index
VECTORA_CONFIG=./custom.yaml vectora init
VECTORA_TRUST_FOLDER=./src vectora indexPróximo: Architecture Overview
External Linking
| Concept | Resource | Link |
|---|---|---|
| MCP | Model Context Protocol Specification | modelcontextprotocol.io/specification |
| MCP Go SDK | Go SDK for MCP (mark3labs) | github.com/mark3labs/mcp-go |
| Anthropic Claude | Claude Documentation | docs.anthropic.com/ |
| Gemini API | Google AI Studio Documentation | ai.google.dev/docs |
| GitHub Actions | Automate your workflow from idea to production | docs.github.com/en/actions |
Parte do ecossistema Vectora · Open Source (MIT) · Contribuidores