https://github.com/Thumuss/utpm

A package manager for typst
https://github.com/Thumuss/utpm

package-manager typst utpm

Last synced: 3 months ago
JSON representation

A package manager for typst

• Host: GitHub
• URL: https://github.com/Thumuss/utpm
• Owner: Thumuss
• License: mit
• Created: 2023-06-18T11:53:56.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-09-17T14:03:37.000Z (4 months ago)
• Last Synced: 2024-09-18T17:10:17.529Z (4 months ago)
• Topics: package-manager, typst, utpm
• Language: Rust
• Homepage:
• Size: 2.16 MB
• Stars: 30
• Watchers: 1
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-typst - utpm - Package manager for local and remote packages (Integrations & Tools / CLI Tools)

README

        


![UTPM logo](./assets/logo.svg)

> _Unofficial typst package manager_

**UTPM** is a _package manager_ for **[local](https://github.com/typst/packages#local-packages)** and **remote** packages. Create quickly new _projects_ and _templates_ from a **singular tool**, and then **publish** it _directly_ to **Typst**!

[![Thumuss - utpm](https://img.shields.io/static/v1?label=Thumuss&message=utpm&color=blue&logo=github)](https://github.com/Thumuss/utpm "Go to GitHub repo")

[![stars - utpm](https://img.shields.io/github/stars/Thumuss/utpm?style=social)](https://github.com/Thumuss/utpm)

[![forks - utpm](https://img.shields.io/github/forks/Thumuss/utpm?style=social)](https://github.com/Thumuss/utpm)




[![GitHub tag](https://img.shields.io/github/tag/Thumuss/utpm?include_prereleases=&sort=semver&color=blue)](https://github.com/Thumuss/utpm/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![issues - utpm](https://img.shields.io/github/issues/Thumuss/utpm)](https://github.com/Thumuss/utpm/issues)



## 🔥 Features

- [x] ✨ Create packages automatically (`utpm ws create`)

  - [x] ⏯️ Interactive

  - [x] ⌨️ CLI version

- [x] 🛠 Put your package directly into your local packages (`utpm ws link`)

  - [x] 💻 Link without copying! (`utpm ws link --no-copy`)

- [x] 🌐 Dependencies outsite typst!

  - [x] 📦 Install directly from the tool

  - [x] 🔒 Portable installer (limited for now)

- [x] 📃 List all your packages

  - [x] 🗃️ As a list `utpm pkg list`

  - [x] 🌲 As a tree `utpm pkg tree`

- [ ] 💥 Customize your output (json or classic, `-j` in your commands)

- [x] 🗄️ 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](#create) your `typst.toml` file!_

- _Then, edit your file! Like `index.typ` or `lib.typ`_

- _Finally, [link](#link) your new package to typst!_

### Commands

#### 🗄️ Bulk Delete

_A command to delete multiple packages at once!_

![bulk-delete.gif](./assets/gifs/bulk_delete.gif)



#### ✨ Create

_Create a `typst.toml` to make a package_

![create_cli.gif](./assets/gifs/create_cli.gif)





#### ❓ Help

_Generate a help message_

![help.gif](./assets/gifs/help.gif)





#### 📦 Install

![install.gif](./assets/gifs/install.gif)





#### 🛠 Link

![link.gif](./assets/gifs/link.gif)





#### 🗃️ List

![list.gif](./assets/gifs/list.gif)





#### 🚦 Package Path

![packages-path.gif](./assets/gifs/packages-path.gif)





#### 🌲 Tree

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

![tree.gif](./assets/gifs/tree.gif)





#### 🗄️ Unlink

![unlink.gif](./assets/gifs/unlink.gif)



## ⚡ Install

You will need Cargo and Rust.

The easiest way to install utpm using Cargo is:

```bash

$ 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