typship

---

A tool for Typst package development and publishing.

The name typship is a portmanteau of Typst and spaceship, since it sends packages to the universe.

Installation

cargo install typship

Notice

To use publish universe, you will need to generate a token (fine-grained) with the following permissions to your fork of the packages repository:

• Read access to metadata

• Read and write access to contents

• Read and write access to workflow

Here's GitHub's documentation on how to create a personal access token.

Usage

typship help

TL;DR

To init a new package, simply run (this would start an interactive prompt):

typship init

To publish a package, run (then follow the instructions):

typship publish [--upload-method <sparse|api>]

• --upload-method sparse (default): Uses git sparse-checkout to upload your package. Recommended for most users and faster for large packages.
• --upload-method api: Uploads files one by one via GitHub API. Useful for legacy git versions or special needs, but slower.

Download a package to @local:

typship download <package-repo>

Download a package to @my-packages:

typship download <package-repo> -n my-packages

TODO

• i18n