TPIX
HomePackagesNamespacesUpload

Frequently Asked Questions

General

What is TPIX?

TPIX (Typst Package Index & eXchange) is a package registry for Typst packages and templates. It lets you publish and manage private packages for your team while also providing access to the public Typst Universe through automatic mirroring.

Is TPIX free?

Yes, TPIX is free to use. Every user gets default limits that administrators can adjust per user: 3 namespaces, 10 members per namespace, 200MB storage per namespace, 10MB per package, 30 REST API requests per minute, and 10 API keys. Contact the administrators if you need a custom quota.

What do I get by default?

You can create public or private namespaces, publish packages, invite members, enable audit logging, and use the CLI or SDK with an API key. Limits are per-user defaults and can be adjusted by an administrator.

How is TPIX different from Typst Universe?

Typst Universe is the official public package registry maintained by the Typst team. TPIX extends the ecosystem with private packages, access control, and flexible packaging options. TPIX also mirrors the entire Typst Universe, so you can access everything from one place.

Packages

How do I use a package from TPIX?

Typst does not download packages from TPIX automatically — only the official Typst Universe is supported natively. To use TPIX packages you need to download them first using the TPIX CLI or Typstify:

tpix get @mynamespace/my-package:1.0.0

Once downloaded to your local cache, you can import the package in your Typst files as usual:

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

What is the difference between TPIX packages and official Typst packages?

TPIX packages use the same typst.toml manifest format and the same set of categories and disciplines as official Typst packages. The main differences are:

  • Fonts — the official registry allows fonts but recommends against it due to duplication and usability concerns; TPIX fully supports shipping fonts without restriction.
  • Package size — the official registry discourages large files (judged case-by-case); TPIX has more generous limits.
  • Licensing — the official registry follows specific license guidelines; TPIX offers more flexibility in license options.
  • Naming — TPIX follows the same naming rules as official Typst packages.
  • Manual download — you must use the TPIX CLI or Typstify to download packages before Typst can use them.
  • Publishing — upload directly with tpix push instead of submitting a GitHub PR to the typst/packages repository.
  • Access control — packages can be private, scoped to specific namespaces with per-user permissions.

What package formats are supported?

Packages must be .tar.gz archives containing at least a typst.toml manifest and a Typst entrypoint file. Use tpix bundle to create a properly formatted archive from a package directory. See the Documentation page for the full workflow.

Can I publish the same version twice?

By default, no. Package versions are immutable, so uploading the same version again will be rejected. However, namespace owners can enable version overwriting in the namespace settings, which allows replacing an existing version. To make changes without overwriting, publish a new version with an incremented version number.

How do I create and publish a package?

  1. Create a directory with a typst.toml manifest and your Typst source files.
  2. Bundle it: tpix bundle ./my-package
  3. Upload it: tpix push my-package.tar.gz mynamespace

See the Documentation page for a detailed walkthrough.

Authentication

How do I log in?

For the website, sign in with your identity provider (Google, GitHub, etc.).

For CLI or SDK access, create a permanent API key in Settings → API Keys and configure the client with that key. Device code login is no longer supported.

Namespaces

What is a namespace?

A namespace is a grouping for packages (e.g., @preview, @myteam). Each namespace has its own access control and package index. TPIX does not distinguish between user and team namespaces — any namespace can have multiple members with different permission levels.

Can I create my own namespace?

Registered users can create public or private namespaces and invite members with read, write, or owner permissions. Default limits are 3 namespaces per user and 10 members per namespace including the owner; administrators can adjust these per user. Manage namespaces from the Namespaces page or via the TPIX CLI.

What is the @preview namespace?

The @preview namespace contains packages mirrored from the official Typst Universe. It is read-only and updated automatically.

How does TPIX prevent name squatting?

TPIX maintains a reserved namespace list that administrators manage. Reserved names cannot be registered by regular users. Administrators can bind a reserved name to a specific user (by username or email), so that only that user may claim it.

TPIX also enforces a Trademark & Name Squatting Policy (see the Terms of Service): maliciously hoarding organization/brand names or bulk-registering unused namespaces is prohibited. If a namespace involves a legitimate registered trademark or official entity name, TPIX may freeze, transfer, or reclaim it after verifying ownership.

What happens when a namespace is frozen?

A frozen namespace becomes read-only: publishing new package versions is blocked with an error asking the owner to migrate to a new namespace. Existing packages and downloads keep working so downstream builds are not broken.

What happens during a namespace dispute?

If a dispute is raised, administrators verify ownership and may:

  1. Freeze the namespace to stop new publications.
  2. Rename the namespace (for example acme → john-acme) to free the original name.
  3. Bind/reserve the freed name to the rightful owner so they can claim it.

During this process, read access is preserved where possible so existing downstream dependencies continue to build. To report a namespace dispute, contact the administrators.

How do I claim a reserved namespace?

If a namespace is reserved and bound to your account by an administrator, simply create the namespace with that name as you normally would. If a name you need is reserved but not bound to you, contact the administrators with evidence of ownership.

Typstify

What is Typstify?

Typstify is a modern desktop editor for Typst with built-in package management, real-time rendering, and offline-first design. With TPIX integration, you can browse, download, and manage TPIX packages directly from Typstify.