tytanic-run(1)

📦 version 0.4.1, in nixpkgs unstable

💅 NAME 💅

okay bestie, you're reading tytanic-run(1) from the General Commands Manual — the tt run command. It compiles and compares tests, and yes, she ate. 💖

✨ SYNOPSIS ✨

tt run [--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] [-v|--verbose]... [-h|--help] [TEST]

🌸 DESCRIPTION 🌸

Compile and compare tests. That's the whole main-character job, bestie — compiling and comparing, no cap. ✨

🎀 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. Possible values:
    • 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 (default). 💅
  • --no-compare — Don't compare tests.
  • --max-delta <MAX_DELTA> — The maximum allowed delta per pixel. 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, 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 is counted as a comparison failure. Defaults to 0, 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, 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, can be configured in the manifest. 🖼️
  • --render-bleed <RENDER_BLEED> — Whether the rendered export should have its bleed regions rendered. Defaults to false, 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 (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.
  • -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. 🔥

🦋 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, the increasing number of verbose flags corresponds to the log levels ERROR, WARN, INFO, DEBUG, TRACE. 👑

okay that's the whole tytanic-run(1) page, bestie 💖 the footer just gives us run and tytanic-run(1) — no source version or date listed, so no extra lore there. mwah! 🎀🫶

📦 where this page comes from