// Generated by scripts/gen_cli_help.py from the help texts of the upstream
// typst CLI at the pinned revision. Do not edit.
///|
let help_main_short : String =
#|Typst 0.15.1 (e58a63af)
#|
#|Usage: typst [OPTIONS]
#|
#|Commands:
#| compile Compiles an input file into a supported output format [alias: c]
#| watch Watches an input file and recompiles on changes [alias: w]
#| init Initializes a new project from a template
#| eval Evaluates a piece of Typst code, optionally in the context of a
#| document
#| fonts Lists all discovered fonts in system and custom font paths
#| completions Generates shell completion scripts
#| info Displays debugging information about Typst
#| help Print this message or the help of the given subcommand(s)
#|
#|Options:
#| --color Whether to use color. When set to `auto`, uses color if
#| the terminal supports it [default: auto] [possible
#| values: auto, always, never]
#| --cert Path to a custom CA certificate to use when making
#| network requests [env: TYPST_CERT=]
#| -h, --help Print help
#| -V, --version Print version
#|
#|Resources:
#| Tutorial: https://typst.app/docs/tutorial/
#| Reference documentation: https://typst.app/docs/reference/
#| Templates & Packages: https://typst.app/universe/
#| Forum for questions: https://forum.typst.app/
///|
let help_main_long : String =
#|Typst 0.15.1 (e58a63af)
#|
#|Usage: typst [OPTIONS]
#|
#|Commands:
#| compile Compiles an input file into a supported output format [alias: c]
#| watch Watches an input file and recompiles on changes [alias: w]
#| init Initializes a new project from a template
#| eval Evaluates a piece of Typst code, optionally in the context of a
#| document
#| fonts Lists all discovered fonts in system and custom font paths
#| completions Generates shell completion scripts
#| info Displays debugging information about Typst
#| help Print this message or the help of the given subcommand(s)
#|
#|Options:
#| --color Whether to use color. When set to `auto`, uses color if
#| the terminal supports it [default: auto] [possible
#| values: auto, always, never]
#| --cert Path to a custom CA certificate to use when making
#| network requests [env: TYPST_CERT=]
#| -h, --help Print help
#| -V, --version Print version
#|
#|Resources:
#| Tutorial: https://typst.app/docs/tutorial/
#| Reference documentation: https://typst.app/docs/reference/
#| Templates & Packages: https://typst.app/universe/
#| Forum for questions: https://forum.typst.app/
///|
let help_compile_short : String =
#|Compiles an input file into a supported output format
#|
#|Usage: typst compile [OPTIONS] [OUTPUT]
#|
#|Arguments:
#| Path to input Typst file. Use `-` to read input from stdin
#| [OUTPUT] Path to output file (PDF, PNG, SVG, or HTML). Use `-` to write
#| output to stdout
#|
#|Options:
#| -f, --format
#| The format of the output file, inferred from the extension by default
#| [possible values: pdf, png, svg, html, bundle]
#| --root
#| Configures the project root (for absolute paths) [env: TYPST_ROOT=]
#| -i, --input
#| Add a string key-value pair visible through `sys.inputs`
#| --font-path
#| Adds additional directories that are recursively searched for fonts
#| [env: TYPST_FONT_PATHS=]
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path` [env: TYPST_IGNORE_SYSTEM_FONTS=]
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered [env:
#| TYPST_IGNORE_EMBEDDED_FONTS=]
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#| [env: TYPST_PACKAGE_PATH=]
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp [env:
#| SOURCE_DATE_EPOCH=]
#| --pretty[=]
#| Whether to pretty-print produced output [possible values: true, false]
#| --pages
#| Which pages to export. When unspecified, all pages are exported
#| --pdf-standard
#| One (or multiple comma-separated) PDF standards that Typst will
#| enforce conformance with [possible values: 1.4, 1.5, 1.6, 1.7, 2.0,
#| a-1b, a-1a, a-2b, a-2u, a-2a, a-3b, a-3u, a-3a, a-4, a-4f, a-4e, ua-1]
#| --pdf-tagged[=]
#| Enables or disables PDF tagging [possible values: true, false]
#| --ppi
#| The PPI (pixels per inch) to use for PNG export
#| --deps
#| File path to which a list of current compilation's dependencies will
#| be written. Use `-` to write to stdout
#| --deps-format
#| File format to use for dependencies [default: json] [possible values:
#| json, zero, make]
#| -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 [env: TYPST_FEATURES=] [possible values: html, bundle,
#| a11y-extras]
#| --diagnostic-format
#| The format to emit diagnostics in [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human] [possible values: human, short]
#| --open[=]
#| Opens the output file with the default viewer or a specific program
#| after compilation. Ignored if output is stdout
#| --timings
#| Produces performance timings of the compilation process.
#| (experimental)
#| -h, --help
#| Print help (see more with '--help')
///|
let help_compile_long : String =
#|Compiles an input file into a supported output format
#|
#|Usage: typst compile [OPTIONS] [OUTPUT]
#|
#|Arguments:
#|
#| Path to input Typst file. Use `-` to read input from stdin
#|
#| [OUTPUT]
#| Path to output file (PDF, PNG, SVG, or HTML). Use `-` to write output
#| to stdout.
#|
#| For output formats emitting one file per page (PNG & SVG), a page
#| number template must be present if the source document renders to
#| multiple pages. Use `{p}` for page numbers, `{0p}` for zero padded
#| page numbers and `{t}` for page count. For example,
#| `page-{0p}-of-{t}.png` creates `page-01-of-10.png`,
#| `page-02-of-10.png`, and so on.
#|
#|Options:
#| -f, --format
#| The format of the output file, inferred from the extension by default
#|
#| [possible values: pdf, png, svg, html, bundle]
#|
#| --root
#| Configures the project root (for absolute paths)
#|
#| [env: TYPST_ROOT=]
#|
#| -i, --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).
#|
#| [env: TYPST_FONT_PATHS=]
#|
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path`
#|
#| [env: TYPST_IGNORE_SYSTEM_FONTS=]
#|
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered
#|
#| [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#|
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_PATH=]
#|
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#|
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp.
#|
#| For more information, see
#| .
#|
#| [env: SOURCE_DATE_EPOCH=]
#|
#| --pretty[=]
#| Whether to pretty-print produced output.
#|
#| This formats the output in a more human-readable, but less
#| space-efficient way. Affects HTML, SVG, and PDF export, but not PNG
#| export.
#|
#| [possible values: true, false]
#|
#| --pages
#| Which pages to export. When unspecified, all pages are exported.
#|
#| Pages to export are separated by commas, and can be either simple page
#| numbers (e.g. '2,5' to export only pages 2 and 5) or page ranges (e.g.
#| '2,3-6,8-' to export page 2, pages 3 to 6 (inclusive), page 8 and any
#| pages after it).
#|
#| Page numbers are one-indexed and correspond to physical page numbers
#| in the document (therefore not being affected by the document's page
#| counter).
#|
#| --pdf-standard
#| One (or multiple comma-separated) PDF standards that Typst will
#| enforce conformance with
#|
#| Possible values:
#| - 1.4: PDF 1.4
#| - 1.5: PDF 1.5
#| - 1.6: PDF 1.6
#| - 1.7: PDF 1.7
#| - 2.0: PDF 2.0
#| - a-1b: PDF/A-1b
#| - a-1a: PDF/A-1a
#| - a-2b: PDF/A-2b
#| - a-2u: PDF/A-2u
#| - a-2a: PDF/A-2a
#| - a-3b: PDF/A-3b
#| - a-3u: PDF/A-3u
#| - a-3a: PDF/A-3a
#| - a-4: PDF/A-4
#| - a-4f: PDF/A-4f
#| - a-4e: PDF/A-4e
#| - ua-1: PDF/UA-1
#|
#| --pdf-tagged[=]
#| Enables or disables PDF tagging.
#|
#| By default, even when not producing a `PDF/UA-1` document, a tagged
#| PDF document is written to provide a baseline of accessibility. In
#| some circumstances (for example when trying to reduce the size of a
#| document) it can be desirable to disable PDF tags.
#|
#| [possible values: true, false]
#|
#| --ppi
#| The PPI (pixels per inch) to use for PNG export.
#|
#| [default: 144]
#|
#| --deps
#| File path to which a list of current compilation's dependencies will
#| be written. Use `-` to write to stdout
#|
#| --deps-format
#| File format to use for dependencies
#|
#| Possible values:
#| - json: Encodes as JSON, failing for non-Unicode paths
#| - zero: Separates paths with NULL bytes and can express all paths
#| - make: Emits in Make format, omitting inexpressible paths
#|
#| [default: json]
#|
#| -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
#|
#| [env: TYPST_FEATURES=]
#| [possible values: html, bundle, a11y-extras]
#|
#| --diagnostic-format
#| The format to emit diagnostics in
#|
#| [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human]
#| [possible values: human, short]
#|
#| --open[=]
#| Opens the output file with the default viewer or a specific program
#| after compilation. Ignored if output is stdout.
#|
#| When passing a specific program, the name must be attached with an
#| equals sign (`--open=VIEWER`).
#|
#| --timings
#| Produces performance timings of the compilation process.
#| (experimental)
#|
#| The resulting JSON file can be loaded into a tracing tool such as
#| . It does not contain any sensitive
#| information apart from file names and line numbers.
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_watch_short : String =
#|Watches an input file and recompiles on changes
#|
#|Usage: typst watch [OPTIONS] [OUTPUT]
#|
#|Arguments:
#| Path to input Typst file. Use `-` to read input from stdin
#| [OUTPUT] Path to output file (PDF, PNG, SVG, or HTML). Use `-` to write
#| output to stdout
#|
#|Options:
#| -f, --format
#| The format of the output file, inferred from the extension by default
#| [possible values: pdf, png, svg, html, bundle]
#| --root
#| Configures the project root (for absolute paths) [env: TYPST_ROOT=]
#| -i, --input
#| Add a string key-value pair visible through `sys.inputs`
#| --font-path
#| Adds additional directories that are recursively searched for fonts
#| [env: TYPST_FONT_PATHS=]
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path` [env: TYPST_IGNORE_SYSTEM_FONTS=]
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered [env:
#| TYPST_IGNORE_EMBEDDED_FONTS=]
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#| [env: TYPST_PACKAGE_PATH=]
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp [env:
#| SOURCE_DATE_EPOCH=]
#| --pretty[=]
#| Whether to pretty-print produced output [possible values: true, false]
#| --pages
#| Which pages to export. When unspecified, all pages are exported
#| --pdf-standard
#| One (or multiple comma-separated) PDF standards that Typst will
#| enforce conformance with [possible values: 1.4, 1.5, 1.6, 1.7, 2.0,
#| a-1b, a-1a, a-2b, a-2u, a-2a, a-3b, a-3u, a-3a, a-4, a-4f, a-4e, ua-1]
#| --pdf-tagged[=]
#| Enables or disables PDF tagging [possible values: true, false]
#| --ppi
#| The PPI (pixels per inch) to use for PNG export
#| --deps
#| File path to which a list of current compilation's dependencies will
#| be written. Use `-` to write to stdout
#| --deps-format
#| File format to use for dependencies [default: json] [possible values:
#| json, zero, make]
#| -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 [env: TYPST_FEATURES=] [possible values: html, bundle,
#| a11y-extras]
#| --diagnostic-format
#| The format to emit diagnostics in [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human] [possible values: human, short]
#| --open[=]
#| Opens the output file with the default viewer or a specific program
#| after compilation. Ignored if output is stdout
#| --timings
#| Produces performance timings of the compilation process.
#| (experimental)
#| --no-fullscreen
#| Stops the watcher from taking over the terminal
#| --no-serve
#| Disables the built-in HTTP server for HTML export
#| --no-reload
#| Disables the injected live reload script for HTML export. The HTML
#| that is written to disk isn't affected either way
#| --port
#| The port where HTML is served
#| -h, --help
#| Print help (see more with '--help')
///|
let help_watch_long : String =
#|Watches an input file and recompiles on changes
#|
#|Usage: typst watch [OPTIONS] [OUTPUT]
#|
#|Arguments:
#|
#| Path to input Typst file. Use `-` to read input from stdin
#|
#| [OUTPUT]
#| Path to output file (PDF, PNG, SVG, or HTML). Use `-` to write output
#| to stdout.
#|
#| For output formats emitting one file per page (PNG & SVG), a page
#| number template must be present if the source document renders to
#| multiple pages. Use `{p}` for page numbers, `{0p}` for zero padded
#| page numbers and `{t}` for page count. For example,
#| `page-{0p}-of-{t}.png` creates `page-01-of-10.png`,
#| `page-02-of-10.png`, and so on.
#|
#|Options:
#| -f, --format
#| The format of the output file, inferred from the extension by default
#|
#| [possible values: pdf, png, svg, html, bundle]
#|
#| --root
#| Configures the project root (for absolute paths)
#|
#| [env: TYPST_ROOT=]
#|
#| -i, --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).
#|
#| [env: TYPST_FONT_PATHS=]
#|
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path`
#|
#| [env: TYPST_IGNORE_SYSTEM_FONTS=]
#|
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered
#|
#| [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#|
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_PATH=]
#|
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#|
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp.
#|
#| For more information, see
#| .
#|
#| [env: SOURCE_DATE_EPOCH=]
#|
#| --pretty[=]
#| Whether to pretty-print produced output.
#|
#| This formats the output in a more human-readable, but less
#| space-efficient way. Affects HTML, SVG, and PDF export, but not PNG
#| export.
#|
#| [possible values: true, false]
#|
#| --pages
#| Which pages to export. When unspecified, all pages are exported.
#|
#| Pages to export are separated by commas, and can be either simple page
#| numbers (e.g. '2,5' to export only pages 2 and 5) or page ranges (e.g.
#| '2,3-6,8-' to export page 2, pages 3 to 6 (inclusive), page 8 and any
#| pages after it).
#|
#| Page numbers are one-indexed and correspond to physical page numbers
#| in the document (therefore not being affected by the document's page
#| counter).
#|
#| --pdf-standard
#| One (or multiple comma-separated) PDF standards that Typst will
#| enforce conformance with
#|
#| Possible values:
#| - 1.4: PDF 1.4
#| - 1.5: PDF 1.5
#| - 1.6: PDF 1.6
#| - 1.7: PDF 1.7
#| - 2.0: PDF 2.0
#| - a-1b: PDF/A-1b
#| - a-1a: PDF/A-1a
#| - a-2b: PDF/A-2b
#| - a-2u: PDF/A-2u
#| - a-2a: PDF/A-2a
#| - a-3b: PDF/A-3b
#| - a-3u: PDF/A-3u
#| - a-3a: PDF/A-3a
#| - a-4: PDF/A-4
#| - a-4f: PDF/A-4f
#| - a-4e: PDF/A-4e
#| - ua-1: PDF/UA-1
#|
#| --pdf-tagged[=]
#| Enables or disables PDF tagging.
#|
#| By default, even when not producing a `PDF/UA-1` document, a tagged
#| PDF document is written to provide a baseline of accessibility. In
#| some circumstances (for example when trying to reduce the size of a
#| document) it can be desirable to disable PDF tags.
#|
#| [possible values: true, false]
#|
#| --ppi
#| The PPI (pixels per inch) to use for PNG export.
#|
#| [default: 144]
#|
#| --deps
#| File path to which a list of current compilation's dependencies will
#| be written. Use `-` to write to stdout
#|
#| --deps-format
#| File format to use for dependencies
#|
#| Possible values:
#| - json: Encodes as JSON, failing for non-Unicode paths
#| - zero: Separates paths with NULL bytes and can express all paths
#| - make: Emits in Make format, omitting inexpressible paths
#|
#| [default: json]
#|
#| -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
#|
#| [env: TYPST_FEATURES=]
#| [possible values: html, bundle, a11y-extras]
#|
#| --diagnostic-format
#| The format to emit diagnostics in
#|
#| [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human]
#| [possible values: human, short]
#|
#| --open[=]
#| Opens the output file with the default viewer or a specific program
#| after compilation. Ignored if output is stdout.
#|
#| When passing a specific program, the name must be attached with an
#| equals sign (`--open=VIEWER`).
#|
#| --timings
#| Produces performance timings of the compilation process.
#| (experimental)
#|
#| The resulting JSON file can be loaded into a tracing tool such as
#| . It does not contain any sensitive
#| information apart from file names and line numbers.
#|
#| --no-fullscreen
#| Stops the watcher from taking over the terminal.
#|
#| With this flag, the watcher will only ever print normal output lines,
#| not clear or reconfigure the terminal.
#|
#| --no-serve
#| Disables the built-in HTTP server for HTML export
#|
#| --no-reload
#| Disables the injected live reload script for HTML export. The HTML
#| that is written to disk isn't affected either way
#|
#| --port
#| The port where HTML is served.
#|
#| Defaults to the first free port in the range 3000-3005.
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_init_short : String =
#|Initializes a new project from a template
#|
#|Usage: typst init [OPTIONS] [DIR]
#|
#|Arguments:
#| The template to use, e.g. `@preview/charged-ieee`
#| [DIR] The project directory, defaults to the template's name
#|
#|Options:
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#| [env: TYPST_PACKAGE_PATH=]
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#| -h, --help
#| Print help (see more with '--help')
///|
let help_init_long : String =
#|Initializes a new project from a template
#|
#|Usage: typst init [OPTIONS] [DIR]
#|
#|Arguments:
#|
#| The template to use, e.g. `@preview/charged-ieee`.
#|
#| You can specify the version by appending e.g. `:0.1.0`. If no version
#| is specified, Typst will default to the latest version.
#|
#| Supports both local and published templates.
#|
#| [DIR]
#| The project directory, defaults to the template's name
#|
#|Options:
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_PATH=]
#|
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_query_short : String =
#|Processes an input file to extract provided metadata (deprecated, use `eval`
#|instead)
#|
#|Usage: typst query [OPTIONS]
#|
#|Arguments:
#| Path to input Typst file. Use `-` to read input from stdin
#| Defines which elements to retrieve
#|
#|Options:
#| --field
#| Extracts just one field from all retrieved elements
#| --one
#| Expects and retrieves exactly one element
#| --format
#| The format to serialize in [default: json] [possible values: json,
#| yaml]
#| --pretty
#| Whether to pretty-print the serialized output
#| --target
#| The target to compile for [default: paged] [possible values: paged,
#| html, bundle]
#| --root
#| Configures the project root (for absolute paths) [env: TYPST_ROOT=]
#| -i, --input
#| Add a string key-value pair visible through `sys.inputs`
#| --font-path
#| Adds additional directories that are recursively searched for fonts
#| [env: TYPST_FONT_PATHS=]
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path` [env: TYPST_IGNORE_SYSTEM_FONTS=]
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered [env:
#| TYPST_IGNORE_EMBEDDED_FONTS=]
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#| [env: TYPST_PACKAGE_PATH=]
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp [env:
#| SOURCE_DATE_EPOCH=]
#| -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 [env: TYPST_FEATURES=] [possible values: html, bundle,
#| a11y-extras]
#| --diagnostic-format
#| The format to emit diagnostics in [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human] [possible values: human, short]
#| -h, --help
#| Print help (see more with '--help')
///|
let help_query_long : String =
#|Processes an input file to extract provided metadata (deprecated, use `eval`
#|instead)
#|
#|Usage: typst query [OPTIONS]
#|
#|Arguments:
#|
#| Path to input Typst file. Use `-` to read input from stdin
#|
#|
#| Defines which elements to retrieve
#|
#|Options:
#| --field
#| Extracts just one field from all retrieved elements
#|
#| --one
#| Expects and retrieves exactly one element
#|
#| --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.
#|
#| --target
#| The target to compile for
#|
#| Possible values:
#| - paged: PDF and image formats
#| - html: HTML
#| - bundle: Bundle
#|
#| [default: paged]
#|
#| --root
#| Configures the project root (for absolute paths)
#|
#| [env: TYPST_ROOT=]
#|
#| -i, --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).
#|
#| [env: TYPST_FONT_PATHS=]
#|
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path`
#|
#| [env: TYPST_IGNORE_SYSTEM_FONTS=]
#|
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered
#|
#| [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#|
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_PATH=]
#|
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#|
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp.
#|
#| For more information, see
#| .
#|
#| [env: SOURCE_DATE_EPOCH=]
#|
#| -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
#|
#| [env: TYPST_FEATURES=]
#| [possible values: html, bundle, a11y-extras]
#|
#| --diagnostic-format
#| The format to emit diagnostics in
#|
#| [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human]
#| [possible values: human, short]
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_eval_short : String =
#|Evaluates a piece of Typst code, optionally in the context of a document
#|
#|Usage: typst eval [OPTIONS]
#|
#|Arguments:
#| The piece of Typst code to evaluate
#|
#|Options:
#| --in
#| A file in whose context to evaluate the code. Can be used to
#| introspect the document. Use `-` to read input from stdin
#| --target
#| The target to compile for [default: paged] [possible values: paged,
#| html, bundle]
#| --format
#| The format to serialize in [default: json] [possible values: json,
#| yaml, raw]
#| --pretty
#| Whether to pretty-print the serialized output
#| --root
#| Configures the project root (for absolute paths) [env: TYPST_ROOT=]
#| -i, --input
#| Add a string key-value pair visible through `sys.inputs`
#| --font-path
#| Adds additional directories that are recursively searched for fonts
#| [env: TYPST_FONT_PATHS=]
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path` [env: TYPST_IGNORE_SYSTEM_FONTS=]
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered [env:
#| TYPST_IGNORE_EMBEDDED_FONTS=]
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#| [env: TYPST_PACKAGE_PATH=]
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp [env:
#| SOURCE_DATE_EPOCH=]
#| -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 [env: TYPST_FEATURES=] [possible values: html, bundle,
#| a11y-extras]
#| --diagnostic-format
#| The format to emit diagnostics in [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human] [possible values: human, short]
#| -h, --help
#| Print help (see more with '--help')
///|
let help_eval_long : String =
#|Evaluates a piece of Typst code, optionally in the context of a document
#|
#|Usage: typst eval [OPTIONS]
#|
#|Arguments:
#|
#| The piece of Typst code to evaluate
#|
#|Options:
#| --in
#| A file in whose context to evaluate the code. Can be used to
#| introspect the document. Use `-` to read input from stdin
#|
#| --target
#| The target to compile for
#|
#| Possible values:
#| - paged: PDF and image formats
#| - html: HTML
#| - bundle: Bundle
#|
#| [default: paged]
#|
#| --format
#| The format to serialize in
#|
#| Possible values:
#| - json
#| - yaml
#| - raw: Prints the output without any additional formatting or
#| escaping (only supports strings and bytes)
#|
#| [default: json]
#|
#| --pretty
#| Whether to pretty-print the serialized output.
#|
#| Only applies to JSON format.
#|
#| --root
#| Configures the project root (for absolute paths)
#|
#| [env: TYPST_ROOT=]
#|
#| -i, --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).
#|
#| [env: TYPST_FONT_PATHS=]
#|
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path`
#|
#| [env: TYPST_IGNORE_SYSTEM_FONTS=]
#|
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered
#|
#| [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#|
#| --package-path
#| Custom path to local packages, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_PATH=]
#|
#| --package-cache-path
#| Custom path to package cache, defaults to system-dependent location
#|
#| [env: TYPST_PACKAGE_CACHE_PATH=]
#|
#| --creation-timestamp
#| The document's creation date formatted as a UNIX timestamp.
#|
#| For more information, see
#| .
#|
#| [env: SOURCE_DATE_EPOCH=]
#|
#| -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
#|
#| [env: TYPST_FEATURES=]
#| [possible values: html, bundle, a11y-extras]
#|
#| --diagnostic-format
#| The format to emit diagnostics in
#|
#| [env: TYPST_DIAGNOSTIC_FORMAT=]
#| [default: human]
#| [possible values: human, short]
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_fonts_short : String =
#|Lists all discovered fonts in system and custom font paths
#|
#|Usage: typst fonts [OPTIONS]
#|
#|Options:
#| --font-path Adds additional directories that are recursively
#| searched for fonts [env: TYPST_FONT_PATHS=]
#| --ignore-system-fonts Ensures system fonts won't be searched, unless
#| explicitly included via `--font-path` [env:
#| TYPST_IGNORE_SYSTEM_FONTS=]
#| --ignore-embedded-fonts Ensures fonts embedded into Typst won't be
#| considered [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#| --variants Also lists style variants of each font family
#| -h, --help Print help (see more with '--help')
///|
let help_fonts_long : String =
#|Lists all discovered fonts in system and custom font paths
#|
#|Usage: typst fonts [OPTIONS]
#|
#|Options:
#| --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).
#|
#| [env: TYPST_FONT_PATHS=]
#|
#| --ignore-system-fonts
#| Ensures system fonts won't be searched, unless explicitly included via
#| `--font-path`
#|
#| [env: TYPST_IGNORE_SYSTEM_FONTS=]
#|
#| --ignore-embedded-fonts
#| Ensures fonts embedded into Typst won't be considered
#|
#| [env: TYPST_IGNORE_EMBEDDED_FONTS=]
#|
#| --variants
#| Also lists style variants of each font family
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
let help_update_short : String =
#|Self update the Typst CLI
#|
#|Usage: typst update [OPTIONS] [VERSION]
#|
#|Arguments:
#| [VERSION] Which version to update to (defaults to latest)
#|
#|Options:
#| --force Forces a downgrade to an older version (required for
#| downgrading)
#| --revert Reverts to the version from before the last update
#| (only possible if `typst update` has previously ran)
#| --backup-path Custom path to the backup file created on update and
#| used by `--revert`, defaults to system-dependent
#| location [env: TYPST_UPDATE_BACKUP_PATH=]
#| -h, --help Print help
///|
let help_update_long : String =
#|Self update the Typst CLI
#|
#|Usage: typst update [OPTIONS] [VERSION]
#|
#|Arguments:
#| [VERSION] Which version to update to (defaults to latest)
#|
#|Options:
#| --force Forces a downgrade to an older version (required for
#| downgrading)
#| --revert Reverts to the version from before the last update
#| (only possible if `typst update` has previously ran)
#| --backup-path Custom path to the backup file created on update and
#| used by `--revert`, defaults to system-dependent
#| location [env: TYPST_UPDATE_BACKUP_PATH=]
#| -h, --help Print help
///|
let help_completions_short : String =
#|Generates shell completion scripts
#|
#|Usage: typst completions
#|
#|Arguments:
#| The shell to generate completions for [possible values: bash, elvish,
#| fish, nushell, powershell, zsh]
#|
#|Options:
#| -h, --help Print help
///|
let help_completions_long : String =
#|Generates shell completion scripts
#|
#|Usage: typst completions
#|
#|Arguments:
#| The shell to generate completions for [possible values: bash, elvish,
#| fish, nushell, powershell, zsh]
#|
#|Options:
#| -h, --help Print help
///|
let help_info_short : String =
#|Displays debugging information about Typst
#|
#|Usage: typst info [OPTIONS]
#|
#|Options:
#| -f, --format The format to serialize in, if it should be
#| machine-readable [possible values: json, yaml]
#| --pretty Whether to pretty-print the serialized output
#| -h, --help Print help (see more with '--help')
///|
let help_info_long : String =
#|Displays debugging information about Typst
#|
#|Usage: typst info [OPTIONS]
#|
#|Options:
#| -f, --format
#| The format to serialize in, if it should be machine-readable.
#|
#| If no format is passed the output is displayed human-readable. Note
#| that human-readable format truncates the build commit hash value.
#|
#| [possible values: json, yaml]
#|
#| --pretty
#| Whether to pretty-print the serialized output.
#|
#| Only applies to JSON format.
#|
#| -h, --help
#| Print help (see a summary with '-h')
///|
/// The help texts: (command, long?, text without the final newline).
let help_texts : ReadOnlyArray[(String, Bool, String)] = [
("", false, help_main_short),
("", true, help_main_long),
("compile", false, help_compile_short),
("compile", true, help_compile_long),
("watch", false, help_watch_short),
("watch", true, help_watch_long),
("init", false, help_init_short),
("init", true, help_init_long),
("query", false, help_query_short),
("query", true, help_query_long),
("eval", false, help_eval_short),
("eval", true, help_eval_long),
("fonts", false, help_fonts_short),
("fonts", true, help_fonts_long),
("update", false, help_update_short),
("update", true, help_update_long),
("completions", false, help_completions_short),
("completions", true, help_completions_long),
("info", false, help_info_short),
("info", true, help_info_long),
]