@acheimorumbi/cli
v0.4.0
Published
CLI da Achei Morumbi — acessa o backend para recuperar imóveis, baixar documentos (matrícula, convenção…) e atualizar o cadastro. Pensado para operar junto de um assistente que lê os documentos e devolve o diff.
Maintainers
Readme
@acheimorumbi/cli
CLI de acesso ao backend da Achei Morumbi. Recupera um imóvel já pré-cadastrado com seus documentos, baixa os arquivos (matrícula, convenção…) para leitura, e atualiza o cadastro do imóvel.
Foi pensada para operar junto de um assistente (aqui no chat): o CLI puxa o
imóvel e baixa os documentos; o assistente lê a matrícula, anota o diff e as
incongruências (nome do proprietário divergente, documentação errada — os
clássicos de matrícula), e devolve os campos a preencher — que voltam pelo
update.
Instalação
npm install -g @acheimorumbi/cli
# ou, sem instalar:
npx @acheimorumbi/cli <comando>Zero dependências (só built-ins do Node ≥ 18). O token do usuário fica em
~/.acheimorumbi/config.json — nunca versionado, e a senha nunca é gravada.
Uso
# 1. Autentica (a senha é digitada por você — o CLI não guarda senha)
acheimorumbi login # produção
acheimorumbi login --dev # desenvolvimento (sessão/token separados)
# 2. Puxa o imóvel (por ID ou por REFERÊNCIA) + baixa os documentos
acheimorumbi pull 1234 --dir ./imovel-1234
acheimorumbi pull --ref AP3895 --dir ./imovel-3895
# → ./imovel-3895/imovel.json
# → ./imovel-3895/documentos/MATRICULA-...pdf, ...
# → ./imovel-3895/documentos.json
# (o assistente lê a matrícula, compara com o imovel.json e monta um diff.json)
# 3. Atualiza o cadastro com o que foi extraído
acheimorumbi update --ref AP3895 --file diff.jsonAmbiente
--dev(ou-dev) usa a API de desenvolvimento (https://api.dev.crm.acheimorumbi.com).--prod(default) usa produção (https://api.acheimorumbi.com).- A flag pode vir em qualquer posição. Cada ambiente tem seu próprio token
(faça
loginelogin --devseparadamente).
Referência do imóvel
Os comandos de imóvel aceitam:
<id>posicional (número) — ex.:pull 3895;--id <n>— explícito;--ref <referência>— oexternalIddo imóvel (ex.:AP3895).
O posicional em texto também é tratado como referência (pull AP3895).
Comandos
| Comando | O que faz |
|---|---|
| login [--email <e>] | Autentica no ambiente ativo; salva só o token |
| logout | Remove o token do ambiente ativo |
| whoami | Mostra a sessão do ambiente ativo |
| config [get] / config set apiUrl <url> | Vê ambiente/sessões / muda a API padrão |
| property <id\|--ref R> [--json] | Resumo (bloco de matrícula) ou JSON cru |
| docs <id\|--ref R> | Lista os documentos do imóvel |
| pull <id\|--ref R> [--dir <p>] [--type MATRICULA] | Salva imovel.json + baixa os documentos |
| download <fileId> [--dir <p>] [--out <nome>] | Baixa um arquivo específico |
| update <id\|--ref R> --file <j.json> \| --data '<json>' | PATCH parcial do imóvel |
Condomínios
Mesmos verbos, prefixo condo (referência = slug; documentos: matrícula-mãe,
convenção, regulamento):
| Comando | O que faz |
|---|---|
| condo <id\|--ref slug> [--json] | Resumo do condomínio (com registro) + documentos |
| condo docs <id\|--ref slug> | Lista os documentos do condomínio |
| condo pull <id\|--ref slug> [--dir <p>] [--type MATRICULA] | Salva condominio.json + baixa os documentos |
| condo update <id\|--ref slug> --file <j.json> \| --data '<json>' | PATCH parcial |
Campos de registro do condomínio: registrationNumber (matrícula-mãe) ·
registryOffice · registryOfficeCity · conventionRegistration.
Projetos / demandas de programação
Comando project (alias demanda) — espelha o módulo projetos do backend
(árvore fractal → kanban) para gerenciar demandas de código de forma dinâmica.
Requer o cargo com projects:* (hoje MASTER).
| Comando | O que faz |
|---|---|
| project list [--parent root\|<id>] [--status s] [--json] | Backlog (raiz) ou subtarefas |
| project show <id> · project brief <id> | Resumo · briefing em Markdown |
| project tree <id> · project stages [--parent …] | Árvore de subtarefas · colunas do kanban |
| project create --name "…" [--parent id] [--priority p] [--deadline d] [--data '<json>'] | Nova demanda |
| project update <id> [--status done] [--data/--file <json>] · project move <id> --stage <id> | Andar no kanban |
| project comment <id> "texto" · project comments <id> | Registrar/ler discussão |
| project link\|links\|attach\|attachments\|labels\|automations\|indicators\|focus … | Superfície completa |
Fluxo do agente: brief para entender → move/update para andar → comment
para registrar. Prompt pronto em acheimorumbi-backend/AGENTE-projetos-cli.md.
Variáveis de ambiente
ACHEIMORUMBI_API_URL— sobrescreve a API (quando não usa--dev/--prod)ACHEIMORUMBI_PASSWORD— senha paraloginnão-interativo (CI)
Campos de matrícula do imóvel
registrationNumber · registryOffice · registryOfficeCity · statusRegistry
· acquiredRegistry. O update aceita esses e qualquer outro campo do cadastro
(parcial).
