typst-query(1) General Commands Manual typst-query(1)
NAME
typst-query - Processes an input file to extract provided metadata
(deprecated, use `eval` instead)
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]
DESCRIPTION
Processes an input file to extract provided metadata (deprecated, use
`eval` instead)
OPTIONS
--field
Extracts just one field from all retrieved elements
--one Expects and retrieves exactly one element
--format [default: json]
The format to serialize in
Possible values:
o json
o yaml
--pretty
Whether to pretty-print the serialized output.
Only applies to JSON format.
--target [default: paged]
The target to compile for
Possible values:
o paged: PDF and image formats
o html: HTML
o bundle: Bundle
--root
Configures the project root (for absolute paths)
May also be specified with the TYPST_ROOT environment variable.
--input
Add a string key-value pair visible through `sys.inputs`
--font-path
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
Custom path to local packages, defaults to system-dependent
location
May also be specified with the TYPST_PACKAGE_PATH environment
variable.
--package-cache-path
Custom path to package cache, defaults to system-dependent
location
May also be specified with the TYPST_PACKAGE_CACHE_PATH
environment variable.
--creation-timestamp
The document's creation date formatted as a UNIX timestamp.
For more information, see
.
May also be specified with the SOURCE_DATE_EPOCH environment
variable.
-j, --jobs
Number of parallel jobs spawned during compilation. Defaults to
number of CPUs. Setting it to 1 disables parallelism
--features
Enables in-development features that may be changed or removed
at any time
Possible values:
o html
o bundle
o a11y-extras
May also be specified with the TYPST_FEATURES environment
variable.
--diagnostic-format [default: human]
The format to emit diagnostics in
Possible values:
o human
o short
-h, --help
Print help (see a summary with '-h')
Path to input Typst file. Use `-` to read input from stdin
Defines which elements to retrieve
typst-query typst-query(1)