Il compagno inksmith-cli non interattivo convalida modelli portatili e rende i dati JSON ai PDF utilizzando il renderer Desktop. Legge la cache di licenza Desktop dell'utente corrente; non apre una finestra desktop o si collega a Press.
Installare la posizione
Gli installatori Windows NSIS mettono inksmith-cli.exe accanto a InkSmith.exe. Windows MSIX registra un alias per l'esecuzione delle app. Il pacchetto Debian Linux installa inksmith-cli in /usr/bin.
Convalida un modello
inksmith-cli validate --template path/to/template.inks
La validazione controlla il pacchetto, lo schema dei modelli e gli binding dei caratteri imballati. Non ha bisogno di una licenza.
Render uno PDF
inksmith-cli render --template invoice.inks --data customer.json --output invoice.pdf
--data - legge un oggetto JSON dall'ingresso standard. Un semplice file di dati potrebbe contenere:
{"customer":{"name":"Ada"},"invoice":{"number":"INV-1042"}}
L'ingresso JSON è limitato a 1 MiB. Il percorso di uscita deve terminare in .pdf, nominare una directory esistente e non esiste già. Il CLI impegna il file completo atomicamente e rifiuta di sovrascrivere un risultato esistente.
Risultati della maniglia in un'applicazione
I comandi di successo scrivono un oggetto JSON versione a stdout; i guasti scrivono un oggetto JSON a stderr. Branch sullo stato di uscita e la stabile error.code, non il messaggio di visualizzazione.
| Stato dell'uscita | Significato |
|---|---|
| 0 | Successo |
| 2 | Sintassi di comando |
| 3 | Dati di input o JSON |
| 4 | Pacchetto o schema dei modelli |
| 5 | Destinazione PDF |
| 6 | Renderer o cancellazione |
Ctrl+C annulla il rendering senza commettere un PDF incompleto. Il rendering utilizza gli stessi limiti di licenza cache dell'esportazione Desktop. Per esempi completi di Python, Node.js e shell, vedere Esempi di CLI.