typst-eval(1)

✨ typst-eval(1) ✨

okay bestie, welcome to typst-eval(1) from the General Commands Manual 💖 This is the page for the command that evaluates a piece of Typst code, and it can do it in the context of a document if you feel like it. Lowkey powerful, highkey useful.

🎀 NAME 🎀

typst-eval — evaluates a piece of Typst code, optionally in the context of a document. It's giving tiny evaluator with main-character energy 💅.

🦋 SYNOPSIS 🦋

typst-eval [--in] [--target] [--format] [--pretty] [--root] [--input]
[--font-path] [--ignore-system-fonts] [--ignore-embedded-fonts]
[--package-path] [--package-cache-path] [--creation-timestamp]
[-j|--jobs] [--features] [--diagnostic-format] [-h|--help] <EXPRESSION>

🌸 DESCRIPTION 🌸

typst-eval evaluates a piece of Typst code, and optionally it does that in the context of a document. That's the whole vibe: evaluate now, contextualize if needed ✨.

👑 OPTIONS 👑

• --in <IN> — a file whose context the code gets evaluated in. You can use it to introspect the document. Set it to - to read input from stdin 🫶
• --target <TARGET> — the target to compile for. Default: paged. Possible values:
  • paged: PDF and image formats
  • html: HTML
  • bundle: Bundle
• --format <FORMAT> — the format to serialize in. Default: json. Possible values:
  • json
  • yaml
• --pretty — whether to pretty-print the serialized output. Only applies to JSON format 💅
• --root <DIR> — configures the project root (for absolute paths). You can also set this with the TYPST_ROOT environment variable.
• --input <key=value> — add a string key-value pair visible through sys.inputs ✨
• --font-path <DIR> — adds additional directories that are recursively searched for fonts. If you pass multiple paths, separate them with the system's path separator (: on Unix-like systems and ; on Windows). You can also set this with the TYPST_FONT_PATHS environment variable.
• --ignore-system-fonts — ensures system fonts won't be searched, unless explicitly included via --font-path. You can also set this with the TYPST_IGNORE_SYSTEM_FONTS environment variable.
• --ignore-embedded-fonts — ensures fonts embedded into Typst won't be considered. You can also set this with the TYPST_IGNORE_EMBEDDED_FONTS environment variable.
• --package-path <DIR> — custom path to local packages, defaults to system-dependent location. You can also set this with the TYPST_PACKAGE_PATH environment variable.
• --package-cache-path <DIR> — custom path to package cache, defaults to system-dependent location. You can also set this with the TYPST_PACKAGE_CACHE_PATH environment variable.
• --creation-timestamp <UNIX_TIMESTAMP> — the document's creation date formatted as a UNIX timestamp 🕰️ For more information, see <https://reproducible-builds.org/specs/source-date-epoch/>. You can also set this with the SOURCE_DATE_EPOCH environment variable.
• -j, --jobs <JOBS> — number of parallel jobs spawned during compilation. Defaults to number of CPUs. Setting it to 1 disables parallelism ⚡
• --features <FEATURES> — enables in-development features that may be changed or removed at any time. Possible values:
  • html
  • bundle
  • a11y-extras

You can also set this with the TYPST_FEATURES environment variable.

bestie, those features are literally in development — they may be changed or removed at any time, so don't treat them as forever-stable, okay? 💀

• --diagnostic-format <DIAGNOSTIC_FORMAT> — the format to emit diagnostics in. Default: human. Possible values:
  • human
  • short
• -h, --help — prints help. And yes, it points you to a summary with -h.
• <EXPRESSION> — the actual piece of Typst code to evaluate 💖

xoxo 💖 — typst-eval, page typst-eval(1), from the General Commands Manual. That's the footer vibe; no extra date stamped on this copy, bestie 🫶