Skip to content

Referência da CLI ​

Referência gerada automaticamente a partir do registro de comandos da CLI finnest. Os resumos, descrições e opções aparecem em inglês, exatamente como em finnest <comando> --help. Para instalar a CLI, veja Instalação da CLI.

Configuração ​

  • finnest setup — Prepare an Operator workstation for first deploy.
  • finnest target — List, show, and switch the active deployment target.

Deploy e ciclo de vida ​

  • finnest admin — Print the Finnest admin URL for a deployment target.
  • finnest dcr — Fetch/summarize an SSA, safely inspect and reconcile OFB or OPIN receiver DCR state, or read its HTTP trail.
  • finnest deploy — Deploy Finnest for a deployment target.
  • finnest destroy — Preview or destroy a deployment target, including its data.
  • finnest kc — Open a local tunnel to the Keycloak admin console of a deployment target.
  • finnest pause — Stop the deployed cluster compute for a target.
  • finnest resume — Start a paused cluster for a deployment target.
  • finnest smoke — Run smoke checks for a deployment target.
  • finnest undeploy — Tear down a deployment target’s compute while keeping its data.

Operação ​

Diagnóstico e suporte ​

  • finnest config — Inspect effective configuration, provenance, and goal readiness.
  • finnest cost — Read AWS month-to-date costs by day and service.
  • finnest doctor — Run preflight checks for a deployment target.
  • finnest evidence — List local run evidence and export an index of its run ids.
  • finnest health — Validate a deployed Finnest runtime target end to end.
  • finnest ofb — Smoke-test the OFB receiver and initiator of a target: a plan by default, real reads with --live, one real write on request.
  • finnest opin — Read and operate OPIN readiness (the default, opin status), Directory, conformance, receiver trail, consents, connections, PCM, MOP, retention and compliance watch; verify runs mTLS acceptance.
  • finnest recover — Classify failed deploy evidence and print the safe recovery path.
  • finnest runs — List past runs and open one.
  • finnest schema — Emit the command schema.
  • finnest status — Show deployment status for one target.
  • finnest support — Collect a redacted support bundle.
  • finnest version — Print CLI and pinned infrastructure tool versions.

Instalação e atualização ​

Opções globais de saída ​

Aceitas por todos os comandos:

  • --json — Emit a schema-versioned JSON envelope to stdout.
  • --output <format> — Select text, json, or ndjson output.
  • --no-color — Disable ANSI color without changing the output content mode.
  • --no-evidence — Do not write .finnest run evidence.

A saída --json segue o schema do envelope da CLI, exceto em finnest schema, que emite o próprio documento, sem envelope.

Finnest Power — plataforma Open Finance Brasil e Open Insurance Brasil. Contato: oi@finnest.com.br