TPIX Logo TPIX
PackagesNamespacesPlaygroundUpload

Quick start

TPIX is a private Typst package registry. Depending on what you need, there are two ways to use it:

  • Use packages — install packages published by others into your Typst projects.
  • Publish packages — share your own packages or templates with your team.

Using packages

Typst does not download packages from TPIX automatically — only the official Typst Universe is resolved natively. The TPIX CLI, Typstify, and the VS Code extension are therefore the main way to use TPIX packages: they install a package and its transitive dependencies into Typst's local cache, after which #import works as usual.

tpix get @mynamespace/my-package:1.0.0

Once cached, import it as usual:

#import "@mynamespace/my-package:1.0.0": *

You can also fetch every dependency of a project at once:

tpix pull          # add --dry-run to preview what would be fetched

See the TPIX Client page for installation and authentication, or Typstify for the desktop editor with built-in package management.

From the website

You can also browse Packages, open a package to read its documentation, versions and dependencies, and click Download to get the .tar.gz archive. This is handy for inspecting a package or fetching it manually, but it does not install anything into Typst's cache — for regular use, prefer the CLI or Typstify.

A note on fonts

Typst loads fonts only from --font-path, TYPST_FONT_PATHS, system fonts and its embedded set — never from packages. A template that relies on a custom font therefore renders correctly only if that font is installed or on a font path.

Templates usually ship their fonts next to the layout files under template/. Tools built on typst init — such as Typstify — copy those files into your workspace, so the fonts just work. Other editors and apps that do not do this may render with missing or substituted fonts; install the font or add its directory to TYPST_FONT_PATHS if that happens.

See Fonts for details.

Publishing packages

Publishing is for package authors. In short:

  1. Write a typst.toml manifest and your Typst sources.
  2. Bundle the package into a .tar.gz archive.
  3. Upload it to a namespace you have write access to — either from the Upload page or with tpix push.

See Create package/template for the full walkthrough.

Next steps