Exemplos da CLI

O Desktop CLI aceita um modelo .inks portátil e dados JSON. Esses exemplos mantêm os dados fora dos argumentos da linha de comando e manuseiam o resultado do JSON.

Python: renderize um cliente PDF

import json
import subprocess

customer = {"customer": {"name": "Ada"}}
result = subprocess.run(
    [
        "inksmith-cli", "render",
        "--template", "invoice.inks",
        "--data", "-",
        "--output", "invoice-ada.pdf",
    ],
    input=json.dumps(customer),
    capture_output=True,
    text=True,
    check=False,
)

payload = json.loads(result.stdout if result.returncode == 0 else result.stderr)
if result.returncode != 0:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")

print(payload["output"])

Use um nome de saída diferente para cada renderização. InkSmith recusa substituir um PDF existente.

Node.js: validar antes de renderizar

import { spawnSync } from "node:child_process";

function runInkSmith(args, data) {
  const result = spawnSync("inksmith-cli", args, {
    encoding: "utf8",
    input: data === undefined ? undefined : JSON.stringify(data),
  });
  if (result.error) throw result.error;
  const payload = JSON.parse(result.status === 0 ? result.stdout : result.stderr);
  if (result.status !== 0) {
    throw new Error(payload.error.code + ": " + payload.error.message);
  }
  return payload;
}

runInkSmith(["validate", "--template", "invoice.inks"]);
const output = runInkSmith(
  ["render", "--template", "invoice.inks", "--data", "-", "--output", "invoice-ada.pdf"],
  { customer: { name: "Ada" } },
);
console.log(output.output);

O instalador Windows NSIS coloca inksmith-cli.exe ao lado de InkSmith.exe; use esse caminho completo se o executável não estiver em PATH.

Shell: use um arquivo JSON

inksmith-cli validate --template invoice.inks
inksmith-cli render --template invoice.inks --data customer.json --output invoice-ada.pdf

Um comando bem sucedido emite um único objeto JSON no stdout. Uma falha emite um único objeto JSON no stderr e sai com um estado não-zero. Ver Ecrã CLI para limites e códigos de saída.

Dica de privacidade: Passar dados através --data - mantém o cliente JSON fora da lista de argumentos do processo e evita um arquivo de dados temporário.