VectorGov CLI
CLI para busca semântica em legislação brasileira — projetado para humanos no terminal e agentes de IA via stdin/stdout.
Novidades:
- 0.3.6 — coluna "Referência" usa
hit.citation(Art. 75 da Lei 14.133/2021) — formato jurídico brasileiro- 0.3.5 — créditos exibidos no rodapé de todos os comandos pagos
- 0.3.2 — zero truncamento de conteúdo + TTY detection automática (pipes recebem
llmpor padrão)- 0.3.1 — parsing GNU-style: flags e argumentos em qualquer ordem (
search "ETP" --top-k 3ousearch --top-k 3 "ETP")
⚡ Quickstart (1 minuto)
pip install vectorgov-cli
vectorgov auth login # ou: export VECTORGOV_API_KEY=vg_...
vectorgov search "O que é ETP?"
[1/5] Art. 18 da Lei 14.133/2021 (score: 0.97)
Art. 18. A fase preparatória do processo licitatório é caracterizada pelo planejamento ...
EVIDENCE: https://vectorgov.io/api/v1/evidence/leis%3ALEI-14133-2021%23ART-018
PDF: https://vectorgov.io/api/v1/evidence/download/source/LEI-14133-2021
---
🤖 Para LLMs e agentes: defina
export VECTORGOV_OUTPUT=llme todos os comandos retornam texto puro otimizado (sem ANSI, ~40% menos tokens). Quando o stdout não é um terminal, o CLI detecta automaticamente e usallmpor padrão.
🌳 Qual comando usar?
graph TD
A[Quero consultar legislação] --> B{Sei a referência exata?<br/>Ex: 'Art. 75 da Lei 14.133'}
B -->|Sim| C[vectorgov lookup<br/>📌 referência legal]
B -->|Não| D{Que tipo de busca?}
D -->|Linguagem natural| E{Preciso de análise<br/>jurídica completa?}
D -->|Texto literal exato| F[vectorgov grep<br/>🔍 busca textual]
D -->|Sigla/termo curado| G[vectorgov fs-search<br/>📚 índice curado]
E -->|Não, só os artigos| H{Quero também<br/>artigos relacionados?}
E -->|Sim, com pareceres| I[vectorgov smart-search<br/>⚖️ análise premium 💰💰]
H -->|Sim, via grafo| J[vectorgov hybrid<br/>🕸️ semântica + grafo]
H -->|Não| K[vectorgov search<br/>🎯 semântica simples]
H -->|Quero máxima cobertura| L[vectorgov merged<br/>🌊 dual-path RRF]
K --> M{Quero o texto<br/>completo de um artigo?}
J --> M
M -->|Sim, sei o ID| N[vectorgov read]
M -->|Sim, sei a referência| O[vectorgov explain]
M -->|Quero contexto<br/>pronto para LLM| P[vectorgov context<br/>🤖 busca + prompt]
| Comando | Latência | Custo | Pra que serve |
|---|---|---|---|
vectorgov search |
2-7s | 💰 | Busca semântica simples |
vectorgov smart-search |
5-18s | 💰💰 | Análise jurídica completa |
vectorgov hybrid |
3-10s | 💰 | Semântica + grafo de citações |
vectorgov merged |
2-5s | 💰 | Dual-path: hybrid + filesystem (RRF) |
vectorgov lookup |
< 1s | 💰 | Resolve "Art. X da Lei Y" |
vectorgov grep |
< 1s | 💰 | Busca textual literal |
vectorgov fs-search |
< 1s | 💰 | Índice curado |
vectorgov read |
< 1s | free | Lê texto canônico completo |
🧭 Decisão por caso de uso: veja a Cheat Sheet — 1 página com comparações detalhadas, padrões idiomáticos e troubleshooting.
📋 Os 20 comandos do CLI
🔍 Busca (9)
| Comando | O que faz |
|---|---|
search |
Busca semântica simples (3 modos: fast/balanced/precise) |
smart-search |
Análise jurídica completa com Juiz LLM (Premium 💰💰) |
hybrid |
Semântica + expansão por grafo de citações (1-2 hops) |
lookup |
Resolve referência legal → dispositivo exato (com batch e pipe) |
grep |
Busca textual literal |
fs-search |
Índice curado determinístico |
merged |
hybrid + filesystem unificados via RRF |
read |
Lê texto canônico completo (free) |
explain |
lookup + read em uma chamada |
🤖 LLM helpers (3)
| Comando | O que faz |
|---|---|
context |
Bloco completo (busca + prompt) pronto para LLM |
tokens |
Estima tokens antes de mandar para LLM (free) |
prompts |
System prompts pré-otimizados (list/show) |
📊 Info & feedback (4)
| Comando | O que faz |
|---|---|
docs list/info |
Lista normas indexadas e mostra metadados (free) |
audit logs/stats |
Histórico e estatísticas de uso (free) |
quota |
Uso do plano e créditos restantes (free) |
feedback send |
Like/dislike de resultado (free) |
🛠️ Setup & config (4)
| Comando | O que faz |
|---|---|
auth login/status/logout |
Salva/consulta/remove API key |
config list/get/set/delete |
Gerencia ~/.vectorgov/config.yaml |
init |
Cria arquivos AI (CLAUDE.md, .cursorrules, AGENTS.md) |
version |
Mostra versão (--version ou -V) |
📖 Reference técnica completa: cada comando com flags, formatos, exemplos avançados em docs/commands.md.
🍳 Receitas comuns
Receita 1 — Buscar e colar em ChatGPT/Claude
vectorgov context "Quando dispensar licitação?"
Gera bloco completo (busca + system prompt jurídico) pronto para colar em qualquer LLM.
Receita 2 — Resolver referência legal
vectorgov lookup "Art. 75 da Lei 14.133"
Retorna o texto consolidado do artigo (caput + parágrafos + incisos).
Receita 3 — Batch de referências
vectorgov lookup "Art. 75, Art. 18 e Art. 33 da Lei 14.133"
# ou
printf "Art. 75 da Lei 14.133\nArt. 33 da Lei 14.133" | vectorgov lookup --pipe
Receita 4 — Filtrar por norma específica
vectorgov search "credenciamento" --doc LEI-14133-2021 --top-k 10
Receita 5 — Inicializar projeto AI
vectorgov init --all
# Cria CLAUDE.md, .cursorrules, AGENTS.md
Receita 6 — Estimar tokens antes do LLM
vectorgov tokens "dispensa de licitação" --top-k 10
Receita 7 — Pipeline shell com jq
# Capturar query_id e mandar feedback
QUERY_ID=$(vectorgov search --raw "ETP" | jq -r '.query_id')
vectorgov feedback send $QUERY_ID --like
🍳 Mais receitas: docs/recipes.md tem 20 fluxos completos.
📤 Formatos de saída
Todos os comandos de busca suportam: table (padrão), json, text, llm e --raw.
vectorgov search "ETP" # table (interativo)
vectorgov search "ETP" --output json # JSON com syntax highlight
vectorgov search "ETP" --output llm # texto puro (otimizado para LLM)
vectorgov search --raw "ETP" | jq '.hits[0]' # JSON bruto para pipes
💡 TTY detection: o CLI detecta automaticamente quando o stdout não é um terminal (pipe, redirect, CI/CD) e usa
llmpor padrão. Não precisa configurar nada para integrar com agentes.
🌐 Variáveis de ambiente
| Variável | Descrição |
|---|---|
VECTORGOV_API_KEY |
API key (alternativa a auth login) |
VECTORGOV_OUTPUT |
Output padrão: llm, table, json, text |
VECTORGOV_DEFAULT_MODE |
Modo padrão: fast, balanced, precise |
VECTORGOV_DEFAULT_TOP_K |
Número padrão de resultados |
📁 Arquivo de configuração
~/.vectorgov/config.yaml:
api_key: vg_sua_chave
default_mode: balanced
default_top_k: 5
default_output: table # ou llm, json, text
🤖 Para LLMs e agentes
Esta seção é específica para agentes de IA e LLMs que vão consumir o CLI via stdin/stdout.
Setup recomendado
# Defina o formato padrão como 'llm' para a sessão
export VECTORGOV_OUTPUT=llm
# Ou inicialize um projeto AI completo
vectorgov init --all
Características projetadas para agentes
- TTY detection:
vectorgov search "ETP" | tee out.txtautomaticamente usa formatollm - Texto puro: sem ANSI, sem JSON, separadores
---entre hits, linksEVIDENCE:ePDF:explícitos - Eficiência de tokens: ~40% menos que JSON, ~60% menos que tabela Rich
- Citation pronta: cada hit traz
Art. 75 da Lei 14.133/2021no formato jurídico brasileiro - GNU-style parsing: flags e argumentos em qualquer ordem (igual a
git,curl,kubectl) - Sub-segundo para
lookup,read,grep,fs-search,quota,auth,config
Para integração programática (Python)
Quando for consumir programaticamente, prefira o SDK Python ao invés de fazer parse do output:
pip install vectorgov
from vectorgov import VectorGov
vg = VectorGov() # lê VECTORGOV_API_KEY
result = vg.search("ETP")
for hit in result:
label = hit.citation or hit.source
print(f"[{hit.score:.0%}] {label}")
print(hit.text[:200])
Veja vectorgov-sdk-docs para a documentação completa do SDK.
✅ Provando a veracidade
Toda resposta do CLI inclui links de evidência verificável:
EVIDENCE:— link para o trecho destacado na norma originalPDF:— link para download do PDF oficial
Exemplo:
$ vectorgov search "ETP" --output llm
[1/3] Art. 18 da Lei 14.133/2021 (score: 0.97)
Art. 18. A fase preparatória do processo licitatório é caracterizada pelo planejamento ...
EVIDENCE: https://vectorgov.io/api/v1/evidence/leis%3ALEI-14133-2021%23ART-018
PDF: https://vectorgov.io/api/v1/evidence/download/source/LEI-14133-2021
---
Os links têm validade de 30 minutos após a busca. Use-os para auditoria, citação em respostas de LLM, ou redirecionar usuários humanos para a fonte oficial.
📖 Documentação completa
| Recurso | Quando usar |
|---|---|
| 🧭 Cheat Sheet | Lookup rápido — todos os 20 comandos em 1 página |
| 📖 Reference de comandos | Detalhe técnico de cada comando |
| 🍳 Receitas | 20 fluxos completos por caso de uso |
| 📜 CHANGELOG | Histórico de versões |
🆘 Ajuda
# Ajuda geral
vectorgov --help
# Ajuda de comando específico
vectorgov search --help
vectorgov lookup --help
# Versão
vectorgov --version # ou -V
🤝 Suporte
📜 Licença
MIT. Veja LICENSE.
Metadata
Release files for vectorgov-cli 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vectorgov_cli-0.5.1.tar.gz | 43.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vectorgov_cli-0.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 107.5 kB
Release files / vectorgov_cli-0.5.1.tar.gz
| Download URL | vectorgov_cli-0.5.1.tar.gz |
|---|---|
| Size | 43.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a23db6c38a43bfe5aa2364604bb794036f144aeaa671be3ad5a4befe239a2d6
|
|
BLAKE2b-256 checksum How to use checksums |
8685e78b257970bba1967a535d5c8e1d70e5c1f265a456e89885a6340efc2758
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Release files / vectorgov_cli-0.5.1-py3-none-any.whl
| Download URL | vectorgov_cli-0.5.1-py3-none-any.whl |
|---|---|
| Size | 64.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a1cfa78dfa6665529bc853c5e0fbc952226c32d093a3c5064ca26166693f52b
|
|
BLAKE2b-256 checksum How to use checksums |
f8c211323e3b379d1248f55672257d1e9f5014983c7b8d4c12d4c174a222b3c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|