Kommandozeile

brevier --version
brevier --help
brevier <befehl> --help

pdf

Setzt eine HTML- oder Markdown-Vorlage als PDF.

brevier pdf rechnung.md --data rechnung.json -o rechnung.pdf

Der Befehl endet mit Exit-Code 1, wenn etwas nicht stimmt: kaputtes JSON, ein fehlendes Feld, ein Schema-Fehler oder eine fehlende CSS-Datei. Die Meldung sagt, was falsch ist, und wo möglich, in welcher Zeile.

E-Rechnung

Jedes PDF, das Brevier schreibt, ist PDF/A-3b. Mit --einvoice enthält das PDF außerdem die Rechnung als XML-Datei nach der Norm EN 16931. Die Software des Empfängers kann sie dann ohne Abtippen verbuchen.

brevier pdf rechnung-zugferd.html --data rechnung.json --einvoice -o rechnung.pdf

Brevier schreibt das XML aus denselben --data wie die Seite. Die Daten müssen dem Rechnungsschema folgen. Bevor Brevier die Datei schreibt, prüft es, ob die Beträge stimmen. Wenn nicht, bricht der Befehl ab und nennt das Feld. Die Vorlage rechnung-zugferd zeigt eine vollständige Rechnung.

html

Setzt eine Vorlage als HTML, mit denselben Optionen wie pdf, außer --einvoice. Das HTML ist Produktausgabe: siehe Ausgabe und Tests.

brevier html rechnung.md --data rechnung.json -o rechnung.html

preview

Zeigt eine Vorlage im Browser an und lädt die Seite automatisch neu, sobald Sie Vorlage, Daten oder Stylesheet auf der Festplatte speichern.

brevier preview rechnung.html --data rechnung.json --port 5151 --open

lint

Setzt eine Vorlage und listet die Probleme auf den Seiten: Text, der breiter ist als sein Behälter (overflow), eine Tabellenspalte, die schmaler ist als ihre angegebene Mindestbreite (table), ein Zeichen, das der Schrift fehlt (glyph), eine Überschrift allein am Seitenende (orphan), eine Tabellenzeile, die über einen Seitenumbruch reißt (split), und Trennzeilen, die die Trennregeln verletzen (hyphens). Es schreibt kein PDF. Eine Spalte gibt ihre Mindestbreite mit data-min-width auf ihrem <col> an: siehe die Lint-Anleitung.

brevier lint rechnung.html --data rechnung.json --debug-dir out/

Jedes Problem hat eine Zeile: die Seite, die Art, was falsch ist, und hinter → die Datei und Zeile des erzeugten HTML, die die Ursache enthält.

rechnung.html
  page 2    overflow  "DE893704004405320130…" wider than its box (106.1 > 38.4 mm)  → out/rechnung.debug.html:412
  → 1 problem. exit code 1
debug file: out/rechnung.debug.html (holds the document's data)

Der Befehl schreibt immer rechnung.debug.html und rechnung.debug.css, weil ein Problem ohne die Datei nicht sagt, wo es liegt. Die Dateien enthalten die Daten des Dokuments: Geben Sie sie nicht weiter, wenn die Daten privat sind.

Exit-Code 0: keine Probleme. Exit-Code 1: mindestens ein Problem, oder eine Vorlage, die sich nicht setzen lässt. Exit-Code 2: ein falscher Dateityp oder --format.

serve

Führt die Engine als HTTP-Dienst oder stdio-Prozess aus. Die Client-Bibliotheken verbinden sich im Produktivbetrieb mit diesem Dienst.

brevier serve --templates templates/ --port 8080

import

Übernimmt bestehende Vorlagen aus Word (.docx), JasperReports (.jrxml) oder BIRT (.rptdesign) und erzeugt eine HTML-Vorlage, ein CSS-Stylesheet und ein JSON-Schema. Ein Import von .jrxml oder .rptdesign schreibt auch sample.json. Für jedes Element, das er weglässt, gibt er eine Zeile Not converted: line N: <Element> aus. Vorlage importieren listet, was er umwandelt und nennt.

brevier import brief.docx -o templates/brief

batch

Setzt jede Vorlage in einem Ordner und seinen Unterordnern.

brevier batch pdf vorlagen/ -o ausgabe/
brevier batch html vorlagen/ -o ausgabe/ --pattern "*.md"

Für jede Vorlage nimmt Brevier eine JSON-Datei mit demselben Namen als Daten, wenn es eine gibt: aus rechnung.html und rechnung.json wird ausgabe/rechnung.pdf. Die Ordnerstruktur bleibt erhalten.

compile

Schreibt das HTML, das aus einer Markdown-Vorlage entsteht, neben sie. Siehe Vorlagen.

brevier compile rechnung.md

template

Schreibt eine erste Vorlage, ein Stylesheet und Beispieldaten aus einem Schema. Siehe Schema und Code.

brevier template --schema rechnung.schema.json

scaffold

Schreibt ein Schema, eine erste Vorlage und Beispieldaten aus einem JSON-Datensatz, zum Beispiel aus einer echten Rechnung Ihres Systems.

brevier scaffold --from rechnung.json

Es schreibt rechnung.schema.json, rechnung.html, rechnung.css und sample.json.

sample

Schreibt Beispieldaten aus einem Schema. Es schreibt und ändert weder eine Vorlage noch ein Stylesheet.

brevier sample --schema rechnung.schema.json

from-template

Schreibt das Schema, das eine Vorlage braucht, aus den {{ }}-Tags darin.

brevier from-template police.html

licence

Zeigt den Lizenzschlüssel, den Brevier aus BREVIER_LICENCE_KEY liest: die Firma, den Typ (production oder trial), die Schlüssel-ID, das Enddatum und die Resttage. Der Befehl läuft auch ohne Schlüssel. Bei einem fehlenden, ungültigen oder abgelaufenen Schlüssel nennt er den Grund und endet mit Exit-Code 1.

brevier licence

Jeder andere Befehl außer --help und --version endet mit Exit-Code 1 und schreibt keine Datei, solange der Schlüssel nicht gültig ist. Einen Testschlüssel für 30 Tage gibt es unter brevier.dev/pricing.