Skip to content

README.md

Latest commit

 

History

History
151 lines (110 loc) · 5.4 KB

README.md

File metadata and controls

151 lines (110 loc) · 5.4 KB
Raw

@precisa-saude/datasus-cli

CLI para microdados DATASUS — download, decodificação e agregação com saída JSON (default) ou JSONL.

Comandos

datasus-viz cnes --uf <UF> --year <YYYY> --month <MM> [--top N] [--limit N] [--raw|--labeled] [--format json|jsonl]

Use datasus-viz <comando> --help para detalhes de cada comando.

Flags de subset (todos os comandos):

  • --limit N — para a leitura após N registros. Essencial pra smoke test em datasets grandes. Como arquivos DATASUS frequentemente vêm ordenados por UF/data, --limit combinado com agregação não é estatisticamente representativo — use pra exploração.
  • --labeled — projeta cada registro via labelEstabelecimento, emitindo um objeto enxuto com todos os códigos DATASUS decodificados em pt-BR (tipo, gestão, esfera, natureza jurídica, leitos agregados, serviços de apoio, matriz atividade×convênio, competência ISO). Default de formato: JSONL.
  • --raw — emite registros brutos do DATASUS (150+ colunas com códigos). Mutuamente exclusivo com --labeled. Default de formato: JSONL.

Testar localmente

A partir da raiz do monorepo:

pnpm install
pnpm turbo run build --filter=@precisa-saude/datasus-cli

# direto pelo bin compilado
node packages/cli/dist/index.js cnes --uf AC --year 2024 --month 1

# via pnpm exec (usa a bin registrada no workspace)
pnpm exec datasus-viz cnes --uf AC --year 2024 --month 1

# modo dev (tsx, sem build)
pnpm -F @precisa-saude/datasus-cli dev cnes --uf AC --year 2024 --month 1

Para linkar globalmente (opcional):

pnpm -F @precisa-saude/datasus-cli link --global
datasus-viz --help

Saída

JSON-first. Stdout recebe o resultado, stderr recebe progresso de download (barra ao vivo em TTY, linha-resumo em pipe) e logs — permitindo pipe direto para jq e amigos.

CNES — top tipos de estabelecimento

datasus-viz cnes --uf AC --year 2024 --month 1 --top 5 agrega por TP_UNID com label pt-BR:

[
  { "count": 521, "key": "Pronto Socorro Especializado" },
  { "count": 226, "key": "Centro de Saúde / Unidade Básica" },
  { "count": 171, "key": "Clínica / Centro de Especialidade" },
  { "count": 76, "key": "Unidade de Apoio Diagnose e Terapia (SADT Isolado)" },
  { "count": 73, "key": "Farmácia" }
]

JSONL — uma linha por registro

datasus-viz cnes --uf AC --year 2024 --month 1 --top 3 --format jsonl:

{"count":521,"key":"Pronto Socorro Especializado"}
{"count":226,"key":"Centro de Saúde / Unidade Básica"}
{"count":171,"key":"Clínica / Centro de Especialidade"}

--labeled — estabelecimentos decodificados em pt-BR

datasus-viz cnes --uf AC --year 2024 --month 1 --labeled --limit 1 --format json projeta cada registro via labelEstabelecimento, emitindo tipo, gestão, natureza jurídica, leitos agregados, etc. — tudo legível:

[
  {
    "cnes": "0258555",
    "cnpj": "84306737000127",
    "nomeFantasia": null,
    "municipio": { "codigo": "120001", "nome": "Acrelândia", "uf": "AC" },
    "competencia": "2024-01",
    "tipo": { "codigo": "04", "rotulo": "Policlínica" },
    "gestao": { "codigo": "M", "rotulo": "Municipal" },
    "naturezaJuridica": { "codigo": "1244", "rotulo": "Município (administração direta)" },
    "vinculoSUS": { "codigo": "1", "rotulo": "Vinculada ao SUS" },
    "clientela": { "codigo": "02", "rotulo": "SUS e outras fontes" },
    "instalacoes": [
      { "codigo": "QTINST15", "quantidade": 1, "rotulo": "Consultórios indiferenciados" }
    ],
    "leitos": { "total": 0, "porEspecialidade": [] },
    "servicosApoio": [
      { "codigo": "SERAP09", "modalidade": "terceirizado", "rotulo": "Hemoterapia" }
    ],
    "matrizAtividadeConvenio": [
      {
        "atividade": "AP02",
        "atividadeRotulo": "Média complexidade",
        "convenio": "CV01",
        "convenioRotulo": "SUS"
      }
    ]
  }
]

--raw — registros brutos

datasus-viz cnes --uf AC --year 2024 --month 1 --raw --limit 1 emite cada registro CNES-ST completo como JSONL (uma linha, 150+ campos DATASUS com códigos). Usa-se pra inspecionar schema ou alimentar pipelines externos.

Pipeline com jq

# só o estabelecimento top
datasus-viz cnes --uf SP --year 2024 --month 1 | jq '.[0]'

# filtrar CNES-ST por tipo específico em streaming
datasus-viz cnes --uf SP --year 2024 --month 1 --raw \
  | jq -c 'select(.TP_UNID == "01") | {cnes: .CNES, nome: .FANTASIA}'

# contagem por gestão a partir do modo labeled
datasus-viz cnes --uf SP --year 2024 --month 1 --labeled \
  | jq -s 'group_by(.gestao.rotulo) | map({gestao: .[0].gestao.rotulo, count: length})'

Smoke test end-to-end

examples/cnes-smoke-test.sh exercita os três modos acima contra o FTP DATASUS real — útil como verificação de release.

Progresso de download

Em TTY: barra interativa com %, bytes transferidos/total e velocidade — redesenhada in-place:

CNES-ST SP/2024/03 [████████░░░░░░░░░░░░░░░░]  35%  6.0 MB / 17.0 MB  4.2 MB/s

Em pipe/log (não-TTY): uma linha-resumo ao final, evitando ruído em arquivos:

CNES-ST SP/2024/03 17.0 MB em 4.1s (4.2 MB/s)

Cache hit (arquivo já baixado): uma linha única e imediata:

CNES-ST AC/2024/01 (cache, 60.6 KB)

O cache mora em $XDG_CACHE_HOME/datasus-viz (ou ~/.cache/datasus-viz como fallback), preservando a estrutura do FTP. Para forçar re-download, apague o arquivo.