CLI-Beispiele

Der Desktop CLI akzeptiert eine tragbare .inks-Vorlage und JSON-Daten. Diese Beispiele halten die Daten aus Befehlszeilenargumenten heraus und behandeln das versionierte JSON-Ergebnis.

Python: Rendern eines Kunden 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"])

Verwenden Sie einen anderen Ausgabenamen für jedes Rendering. InkSmith weigert sich, eine bestehende PDF zu ersetzen.

Node.js: validieren vor dem Rendern

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);

Der Windows NSIS-Installer platziert inksmith-cli.exe neben InkSmith.exe; Verwenden Sie diesen vollständigen Pfad, wenn sich die ausführbare Datei nicht auf PATH befindet.

Shell: Verwenden Sie eine JSON-Datei

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

Ein erfolgreicher Befehl sendet ein einzelnes JSON-Objekt auf stdout aus. Ein Fehler sendet ein einzelnes JSON-Objekt auf stderr aus und verlässt es mit einem Nicht-Null-Status. Siehe Desktop CLI für Limits und Exit-Codes.

Datenschutzhinweis: Wenn Sie Daten über --data - übergeben, erscheint Kunden-JSON nicht in der Prozessargumentliste; eine temporäre Datendatei ist nicht nötig.