quillmark-cli 0.113.0

Command-line interface for Quillmark, a schema-driven document engine
quillmark-cli-0.113.0 is not a library.

Quillmark CLI

quillmark, the command-line interface to Quillmark: renders Markdown with card-yaml blocks through a quill into PDF, SVG, or PNG.

Maintained by TTQ.

Installation

cargo install quillmark-cli

The binary lands at ~/.cargo/bin/quillmark. To build from a checkout instead:

cargo install --path crates/bindings/cli

Quick start

# Render a document; output defaults to document.pdf
quillmark render ./quills/usaf_memo document.md

# Omit the markdown file to render the quill's seeded document
quillmark render ./quills/usaf_memo -o preview.pdf

# Pipe the artifact instead of writing a file
quillmark render ./quills/usaf_memo document.md --stdout | evince -

Commands

Every command takes a <QUILL_PATH> pointing at a quill directory.

quillmark render [OPTIONS] <QUILL_PATH> [MARKDOWN_FILE]

Renders a document. With MARKDOWN_FILE omitted, the quill's seeded document is rendered instead, so a quill previews without any authored input.

  • -o, --output <FILE> — output path (default: the input filename with the format's extension)
  • -f, --format <FORMAT> — pdf (default), svg, or png
  • --stdout — write the artifact to stdout; all chatter moves to stderr
  • --output-data <DATA_FILE> — also write the compiled JSON data handed to the backend
  • --quiet — suppress warnings and the output-destination line

quillmark schema <QUILL_PATH>

Prints the quill's field schema as YAML.

quillmark blueprint <QUILL_PATH>

Prints an annotated Markdown blueprint: a starting document with every declared field, !must_fill where a value is expected.

quillmark validate <QUILL_PATH> [-v]

Checks the quill's configuration: Quill.yaml parse errors, example:/default: literals against their declared types, and referenced files. -v adds advisory warnings such as missing field descriptions. Exits 1 where the configuration is invalid.

quillmark info <QUILL_PATH>

Prints the quill's identity — name, version, author, backend — and its field, card and defaults counts.

Exit codes

0 on success, --help, and --version. 2 where argument parsing rejected the invocation before any command ran — an unknown flag, a missing argument, an unknown subcommand. 1 where the command ran and refused — an invalid quill, a missing file, a failed render, an argument value the command itself rejects (-f docx). Diagnostics go to stderr.

Links

License

Licensed under the Apache License, Version 2.0. See LICENSE.