tytanic-update(1)

📦 version 0.4.1, in nixpkgs unstable

🦋 tytanic-update — the tt update page, bestie edition 💅

okay so you found tytanic-update(1), the part of the tytanic manual where we compile stuff and update tests. this is the general commands manual and honestly it ate. let's go 🎀

✨ NAME ✨

tytanic-update — compile and update tests 🧚

✨ SYNOPSIS ✨

tt update [--timestamp] [--warnings] [--diagnostic-format] [--compare]
[--no-compare] [--max-delta] [--max-deviations] [--dir] [-r|--root]
[-j|--jobs] [--ppi] [--render-bleed] [--vcs] [--export-ephemeral]
[--use-embedded-fonts] [--no-export-ephemeral] [--no-use-embedded-fonts]
[--optimize-refs] [--use-system-fonts] [--no-optimize-refs]
[--no-use-system-fonts] [-f|--fail-fast] [--font-path]
[-F|--no-fail-fast] [--package-path] [-e|--expression]
[--package-cache-path] [--certificate] [-s|--skip] [--color]
[-S|--no-skip] [--force] [-v|--verbose]... [-h|--help] [TEST]

like yes that's a lot of flags, but we're gonna get through them together, no cap 🫶

🌸 DESCRIPTION 🌸

Compile and update tests. that's the whole vibe. it compiles ur tests and updates them. periodt 💅

✨ OPTIONS ✨

  • --timestamp <now|<UNIX_TIMESTAMP>> [default: 0] — the timestamp used for compilation ⏰. for more info, see https://reproducible-builds.org/specs/source-date-epoch/. may also be specified with the SOURCE_DATE_EPOCH environment variable.
  • --warnings <WHAT> [default: emit] — how to handle warnings. the possible values are:
    • ignore: ignore warnings 🙈
    • emit: emit warnings
    • promote: promote warnings to errors 🔥
  • --diagnostic-format <FORMAT> [default: human] — the diagnostic format to use. possible values:
    • human: display richly formatted messages showing the source code and context 🎀
    • short: display short single-line diagnostics
  • --compare — compare tests if they have references (this is the default) 👑
  • --no-compare — don't compare tests
  • --max-delta <MAX_DELTA> — the maximum allowed delta per pixel. so like, if a single channel (red/green/blue/alpha component) of a pixel differs by more than this much between reference and output, the pixel is counted as a deviation. defaults to 1, and can be configured in the manifest.
  • --max-deviations <MAX_DEVIATIONS> — the maximum allowed deviations per comparison. if a reference and output image have more than this, then it's counted as a comparison failure 😭. defaults to 0, and can be configured in the manifest.
  • --dir <DIR> — the document direction. this is used to correctly align images with different dimensions when generating diff images. defaults to ltr, and can be configured in the manifest. possible values:
    • ltr: the document is read left-to-right
    • rtl: the document is read right-to-left
  • -r, --root <ROOT> — the project root directory. if none is given, then the first ancestor with a typst.toml is used. may also be specified with the TYPST_ROOT environment variable 🌱
  • -j, --jobs <JOBS> — the number of threads to use for compilation 🧵
  • --ppi <PPI> — the pixel-per-inch value to use for export. defaults to 144.0, and can be configured in the manifest.
  • --render-bleed <RENDER_BLEED> — whether the rendered export should have it's bleed regions rendered. defaults to false, and can be configured in the manifest. possible values:
    • true
    • false
  • --vcs <VCS> [default: auto] — the version control system to use. possible values:
    • auto: auto detect the VCS from the current directory 🔍
    • git: Git
    • sapling: a git-compatible VCS developed at Meta
    • jujutsu: a git-compatible VCS
  • --export-ephemeral — export ephemeral documents (the default ✨). ephemeral documents are those which are created for each test run, i.e. non-persistent ones.
  • --no-export-ephemeral — don't export temporaries
  • --optimize-refs — optimize persistent references (default 👑
  • --no-optimize-refs — don't optimize persistent references
  • -f, --fail-fast — abort after the first test failure (default)
  • -F, --no-fail-fast — don't abort after the first test failure
  • -e, --expression <EXPR> — a test set expression for filtering tests. see the language reference and guide at https://typst-community.github.io/tytanic/index.html for more info 🦋
  • -s, --skip — automatically remove skipped tests from test sets (default). equivalent to wrapping the test set expression in (...) ~ skip().
  • -S, --no-skip — don't automatically remove skipped tests from test sets
  • --force — update all included tests, even if they didn't fail 💪
  • -h, --help — print help (see a summary with -h)
  • [TEST] — the tests to operate on. this will always ignore the [skip] annotation and fail if a test can't be found. like it does not care, bestie 💀

🎀 FONT OPTIONS 🎀

  • --use-embedded-fonts — use embedded fonts (default)
  • --no-use-embedded-fonts — don't use embedded fonts
  • --use-system-fonts — use system fonts
  • --no-use-system-fonts — don't use system fonts (default)
  • --font-path <DIR> — add a directory to read fonts from (can be repeated 🔁). may also be specified with the TYPST_FONT_PATHS environment variable.

🍓 PACKAGE OPTIONS 🍓

  • --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.
  • --certificate <CERTIFICATE> — path to a custom CA certificate to use when making network requests 🔐. may also be specified with the TYPST_CERT environment variable.

🌈 OUTPUT OPTIONS 🌈

  • --color[=<WHEN>] [default: auto] — when to use colorful output 🌸. if set to auto, color will only be enabled if a capable terminal is detected. possible values:
    • auto
    • always
    • never
  • -v, --verbose — produce more logging output [-v ... -vvvvv]. logs are written to stderr, and the increasing number of verbose flags corresponds to the log levels ERROR, WARN, INFO, DEBUG, TRACE 🫶
ngl the -v thing is giving main character energy — stack them up to -vvvvv and you get the whole lore.
lowkey reminder before you dip: [TEST] always ignores the [skip] annotation and fails if a test can't be found. no soft launches here 💅

okay bye bestie, go update those tests — this page is from the update section of the tytanic manual, version whatever's current at 2026-04-26, iykyk 🦋✨🎀

📦 where this page comes from