thumuss / utpm

A package manager for typst

Unofficial typst package manager

UTPM is a package manager for local and remote packages. Create quickly new projects and templates from a singular tool, and then publish it directly to Typst!

🔥 Features

• ✨ Create packages automatically (utpm ws create)
  • ⏯️ Interactive
  • ⌨️ CLI version
• 🛠 Put your package directly into your local packages (utpm ws link)
  • 💻 Link without copying! (utpm ws link --no-copy)
• 🌐 Dependencies outsite typst!
  • 📦 Install directly from the tool
  • 🔒 Portable installer (limited for now)
• 📃 List all your packages
  • 🗃️ As a list utpm pkg list
  • 🌲 As a tree utpm pkg tree
• 💥 Customize your output (json or classic, -j in your commands)
• 🗄️ Delete and bulk delete your packages (utpm pkg unlink, utpm pkg bulk-delete)
• 🚀 Publish it directly to Typst!

And many other features!

🔎 How to use it?

The basic workflow

• Firstly, you'll need to create your typst.toml file!
• Then, edit your file! Like index.typ or lib.typ
• Finally, link your new package to typst!

Commands

🗄️ Bulk Delete

A command to delete multiple packages at once!

✨ Create

Create a typst.toml to make a package

❓ Help

Generate a help message

📦 Install

🛠 Link

🗃️ List

🚦 Package Path

🌲 Tree

A simple command to show all packages installed in your local dir like a tree!

🗄️ Unlink

⚡ Install

You will need Cargo and Rust.

The easiest way to install utpm using Cargo is:

$ cargo install --git https://github.com/Thumuss/utpm

❤️ Contribution

If you want to help me develop this package, simply make an issue or a PR!

By using this app, you contribute to it, thank you! <3

utpm's Issues

Command to download package

I think it would be neat, if one could download a package from a repo. The features would be:

• automatic installation into package path (maybe into '@utpm' as default dir?)
• usage of exclude option, so people do not have to clone the whole repo
• option to include README, excluded items and so on
• info, update, delete functionalities

Maintenance status

I've been wondering if this still is or will be maintained in the future. I've seen the lat commits on main were 3 months ago, and the last active commit on #9 was 2 months ago.

During some work on packages, specifically their docs, I frequently fix packages and checkout the PRs locally to use in my docs' generation until they land in Typst universe, this comes at the cost of using a fork of a package for the docs. Most if not all packages I work on run CI to verify that docs, examples and tests compile and pass, this is not possible without also checking out and installing those forks in CI.

I've considered using utpm for this and have tried it out locally, while it generally did what I expected it to it had some rough edges that prevent me from using it in CI. I'm wondering if you still have time to maintain this, if you need help or can't maintain it actively anymore.

If the latter is the case, consider transferring the repo to @typst-community so it can be maintained by the community in the meanwhile.

Use `tool.utpm` instead of `utpm` table

According to https://github.com/typst/packages?tab=readme-ov-file#third-party-metadata, third-party tools should attach their metadata as a sub-table under tools, so it would be great if utpm would do that by default.

Allow cloning preview packages to local namespace

Thanks first for creating this handy CLI tool!

As a developer of a Typst template package, utpm can be really helpful for me and the users of the template if two functionalities could be considered:

• Allowing "cloning" preview packages to local namespace: some command like utpm workspace clone @preview/brilliant-cv:2.0.0 creates a @local/brilliant-cv:2.0.0, and users can make local modifications to the package without worrying being overwrited or messing with the upstream version;
• A utpm workspace link --overwrite like command that overwrites the preview namespace package rather than the local one: this can be super handy for me, as a developer, to test in a WYSIWYG way my template files.

What do you think?

Thanks a lot!