typst-query(1)

πŸ“¦
version 0.14.2 Β· 3 versions
, in alpine 3.24, nixos 26.05

hey bestie!! welcome to typst-query(1) from the General Commands Manual πŸ’…βœ¨ this is the page that processes an input file to extract provided metadata, and yes we're gonna make it cute.

🌸 NAME 🌸

typst-query β€” processes an input file to extract provided metadata πŸ”₯

✨ SYNOPSIS ✨

typst-query [--field] [--one] [--format] [--pretty] [--target] [--root]
[--input] [--font-path] [--ignore-system-fonts]
[--ignore-embedded-fonts] [--package-path] [--package-cache-path]
[--creation-timestamp] [-j|--jobs] [--features] [--diagnostic-format]
[-h|--help] <INPUT> <SELECTOR>

πŸ’– DESCRIPTION πŸ’–

Processes an input file to extract provided metadata 🫢 that's the whole vibe: you give it an input file, it pulls out the metadata you asked for. iconic behavior, no cap.

πŸŽ€ OPTIONS πŸŽ€

okay bestie, option-by-option, and we are not skipping a single one πŸ’…

  • --field=FIELD β€” extracts just one field from all retrieved elements 🎯
  • --one β€” expects and retrieves exactly one element ☝️
  • --format=FORMAT [default: json] β€” the format to serialize in ✨ possible values: json, yaml
  • --pretty β€” whether to pretty-print the serialized output. Only applies to JSON format. πŸ’–
  • --target=TARGET [default: paged] β€” the target to compile for. Possible values:
    • paged: PDF and image formats
    • html: HTML
  • --root=DIR β€” configures the project root (for absolute paths). May also be specified 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 multiple paths are specified, they are separated by the system's path separator (: on Unix-like systems and ; on Windows). May also be specified with the TYPST_FONT_PATHS environment variable ✨
  • --ignore-system-fonts β€” ensures system fonts won't be searched, unless explicitly included via --font-path. May also be specified with the TYPST_IGNORE_SYSTEM_FONTS environment variable πŸš«πŸ”€
  • --ignore-embedded-fonts β€” ensures fonts embedded into Typst won't be considered. May also be specified with the TYPST_IGNORE_EMBEDDED_FONTS environment variable 🚫πŸͺ„
  • --package-path=DIR β€” custom path to local packages, defaults to system-dependent location. May also be specified with the TYPST_PACKAGE_PATH environment variable πŸ“¦
  • --package-cache-path=DIR β€” custom path to package cache, defaults to system-dependent location. May also be specified 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/. May also be specified 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, a11y-extras]. May also be specified with the TYPST_FEATURES environment variable.
  • --diagnostic-format=DIAGNOSTIC_FORMAT [default: human] β€” the format to emit diagnostics in 🩺 [possible values: human, short]
  • -h, --help β€” print help (see a summary with -h) πŸ™‹β€β™€οΈ
  • <INPUT> β€” path to input Typst file. Use - to read input from stdin πŸ“₯
  • <SELECTOR> β€” defines which elements to retrieve πŸ”

okay that's the whole page bestie!! footer sign-off: source/version typst-query and typst-query(1) from the General Commands Manual β€” date? not listed on this footer, ngl πŸ™ˆπŸ’– stay slaying with ur metadata extraction ✨

πŸ“¦ where this page comes from