Linha de comando cee

O cee é a linha de comando do ceelab. Ele é chamado a partir de um terminal (bash, zsh, PowerShell, cmd) e se integra às automações. Ele usa o mesmo motor do aplicativo, no mesmo banco de dados e com as mesmas configurações: mesmas verificações, mesmos contadores, mesmos arquivos, mesmo histórico.

cee print shipping-label
cee print shipping-label --copies 10
cee print shipping-label --set name="Jane Doe"
cee edit --last --set name="Jane Doe"

shipping-label é o nome curto de um tipo de documento: a sua chave, visível na aba Tipos de documento (Configurações avançadas › Chave do tipo). Os modelos são criados no aplicativo; o comando serve para usá-los, nunca para criá-los nem alterá-los.

Instalação e chamada

O cee vem com o ceelab, no mesmo instalador. Ele funciona assim que o ceelab tiver sido aberto uma primeira vez no computador. Configure a impressora de etiquetas e a pasta de saída no aplicativo antes de imprimir.

No macOS, o aplicativo é instalado arrastando e soltando, sem adicionar nada ao PATH. Para digitar cee no Terminal, escolha uma das opções:

# link simbólico em uma pasta do PATH (permissões de administrador)
sudo ln -s /Applications/ceelab.app/Contents/MacOS/cee /usr/local/bin/cee
# ou: pasta do aplicativo no fim do PATH (~/.zprofile)
export PATH="$PATH:/Applications/ceelab.app/Contents/MacOS"

Comandos

Os verbos são em inglês e iguais em todos os idiomas; as mensagens seguem o idioma do aplicativo. cee COMANDO --help mostra a ajuda de um comando; cee print TIPO --help acrescenta as variáveis do tipo.

--dry-run faz todas as verificações de uma impressão real e mostra o que seria produzido, sem reservar, gravar nem imprimir nada.

cee edit --last sem valor não corrige nada: ele mostra as variáveis do último documento e os seus valores (código 2). Uma correção é recusada (código 4) quando alteraria um valor do qual depende uma fórmula, ou que um texto de modelo usa em um cálculo ({upper(product)}): nesse caso, gere um novo documento.

Variáveis do tipo

As opções -- dependem do tipo: cada variável preenchida (texto, número, data, lista de opções ou Sim/Não, pedida ao operador) é informada pelo seu nome ou com --set:

cee print product_label --product "Vis inox" --reference VX-0620
cee print product_label --set product="Vis inox" --set reference=VX-0620

• Um número pode ser escrito com vírgula (12,5); uma data, AAAA-MM-DD ou DD/MM/AAAA; uma lista de opções espera o texto exato de uma opção; um Sim/Não é escrito true ou false.
• Uma variável não informada recebe o seu valor padrão. Um número, um composto ou uma fórmula é calculado pelo ceelab: informá-lo é recusado.
• Um valor com espaços vai entre aspas. A forma --set "name=Jane Doe" funciona no bash, zsh, PowerShell e cmd.

Proteções

Todas são verificadas antes de reservar qualquer número:

• Valores: obrigatórios, números, datas, opções, Sim/Não, data que não esteja no futuro.
• Typst: o motor de renderização precisa iniciar.
• Impressora de etiquetas configurada no ceelab, para um tipo que produz uma etiqueta.
• Pasta de saída completa (/srv/etiquettes, D:\Etiquettes…) para um comando que grava um PDF: a configuração inicial, ., é relativa e é recusada.
• Verificação da primeira etiqueta: enquanto ela não tiver sido feita no aplicativo, o comando imprime só uma etiqueta por vez.

Depois da reserva, uma saída com falha fica registrada no histórico com o seu número, como no aplicativo; cee reprint ID refaz o documento.

O comando e o aplicativo podem trabalhar ao mesmo tempo no mesmo banco de dados: cada gravação espera a outra por até 5 segundos. Depois de uma atualização do ceelab, abra o aplicativo uma vez antes de usar o cee: é ele que atualiza o banco de dados.

Resposta JSON

Com --json, o comando grava um único objeto JSON na saída padrão, inclusive em caso de erro. Campos comuns: schema (versão do formato), command, ok, code e, em caso de falha, error (kind, message, details). O JSON é em ASCII, legível qualquer que seja a página de código do console.

# bash: valores salvos do documento (inclusive os números)
cee print shipping-label --set "name=Jane Doe" --json | jq '.documents[0].values'

# PowerShell
$r = cee print shipping-label --set "name=Jane Doe" --json | Out-String | ConvertFrom-Json
if ($LASTEXITCODE -ne 0) { throw $r.error.message }

Códigos de saída

Estáveis de uma versão para outra; o nome entre parênteses é o error.kind no JSON.

Registro de eventos

Cada chamada acrescenta uma linha ao registro de eventos do aplicativo (aba Logs), com o prefixo [cee]: comando, tipo ou documento visado, nomes das variáveis informadas (nunca os seus valores), código de saída e duração.