O companheiro inksmith-cli não-interativo valida modelos portáteis e transforma dados JSON em PDFs usando o renderizador Desktop. Ele lê o cache de licença do usuário atual; ele não abre uma janela de desktop ou se conecta ao Press.
Instalar localização
Os instaladores da Windows NSIS colocam inksmith-cli.exe ao lado da InkSmith.exe. Windows MSIX registra um apelido de execução de aplicativos. O pacote Linux Debian instala inksmith-cli em /usr/bin.
Validar um modelo
inksmith-cli validate --template path/to/template.inks
Validação verifica o pacote, esquema de modelo, e exatas combinações de fontes empacotadas. Não precisa de licença.
Entregue um PDF
inksmith-cli render --template invoice.inks --data customer.json --output invoice.pdf
--data - lê um objeto JSON de entrada padrão. Um simples arquivo de dados pode conter:
{"customer":{"name":"Ada"},"invoice":{"number":"INV-1042"}}
Entrada JSON é limitada a 1 MiB. O caminho de saída deve terminar em .pdf, nomeie um diretório existente, e ainda não existe. O CLI compromete o arquivo completo atomicamente e se recusa a substituir um resultado existente.
Lidar com resultados em uma aplicação
Comandos bem sucedidos escrevem um objeto JSON para stdout; falhas escrevem um objeto JSON para stderr. Branch no status de saída e o error.code estável, não a mensagem de exibição.
| Situação de saída | Significado |
|---|---|
| 0 | Sucesso |
| 2 | Sintaxe de comando |
| 3 | Dados de entrada ou JSON |
| 4 | Pacote de modelos ou esquema |
| 5 | PDF destino |
| 6 | Renderista ou cancelamento |
Ctrl+C cancela renderização sem cometer um PDF incompleto. Renderização usa os mesmos limites de licença em cache que exportação Desktop. Para Python completo, Node.js, e exemplos de shell, veja CLI exemplos.