tytanic(1)

💅 tytanic(1) — General Commands Manual 💅

okay bestie, welcome to the group chat for tytanic — manual name is right up there, and we're getting into every single detail. no skips, no cap. 🫶

🌸 NAME 🌸

tytanic — Run and manage tests for Typst projects 🎀

✨ SYNOPSIS ✨

the whole vibe is tt, and the synopsis is literally:

tt [-r|--root] [-j|--jobs] [--vcs] [--use-embedded-fonts]
[--no-use-embedded-fonts] [--use-system-fonts] [--no-use-system-fonts]
[--font-path] [--package-path] [--package-cache-path] [--certificate]
[--color] [-v|--verbose]... [-h|--help] [-V|--version] <subcommands>

💖 DESCRIPTION 💖

Run and manage tests for Typst projects. that's the whole mission, bestie — iconic. ✨

🎀 OPTIONS 🎀

• -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.
• --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
• -h, --help — Print help (see a summary with -h).
• -V, --version — Print version.

🦋 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.

👑 SUBCOMMANDS 👑

• tytanic-status(1) — Show information about the current project
• tytanic-list(1) — List the tests in the current project
• tytanic-run(1) — Compile and compare tests
• tytanic-update(1) — Compile and update tests
• tytanic-new(1) — Create a new test
• tytanic-delete(1) — Remove tests
• tytanic-util(1) — Utility commands

💀 EXTRA 💀

Exit Codes:

• 0 — Success
• 1 — At least one test failed
• 2 — The requested operation failed
• 3 — An unexpected error occurred

⭐ VERSION ⭐

v0.4.1 — periodt. 👑

💖 that's the whole manual, bestie — the footer says tytanic 0.4.1 (source/version) and tytanic(1) for the General Commands Manual, and there's literally no separate date line to quote, so no invented dates here. 💖