Scroll to navigation

typst-compile(1) General Commands Manual typst-compile(1)

NAME

typst-compile - Compiles an input file into a supported output format

SYNOPSIS

typst-compile [--root] [--font-path] [--diagnostic-format] [-f|--format] [--open] [--ppi] [--flamegraph] [-h|--help] <INPUT> [OUTPUT]

DESCRIPTION

Compiles an input file into a supported output format

OPTIONS

Configures the project root (for absolute paths)
May also be specified with the TYPST_ROOT environment variable.
Adds additional directories to search for fonts
May also be specified with the TYPST_FONT_PATHS environment variable.
The format to emit diagnostics in

[possible values: human, short]

The format of the output file, inferred from the extension by default

[possible values: pdf, png, svg]

Opens the output file using the default viewer after compilation
The PPI (pixels per inch) to use for PNG export
Produces a flamegraph of the compilation process
Print help
<INPUT>
Path to input Typst file
[OUTPUT]
Path to output file (PDF, PNG, or SVG)
typst-compile