Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 3.88 KB

README.md

File metadata and controls

98 lines (73 loc) · 3.88 KB
Raw

UTPM logo

Unofficial Typst package manager

UTPM is a package manager for local and remote Typst packages. Quickly create and manage projects and templates on your system, and publish them directly to Typst Universe.

Thumuss - utpm stars - utpm forks - utpm
GitHub tag License issues - utpm

🔥 Features

  • ✨Create packages rapidly (utpm workspace create)
    • ⏯️ Alias shorthand e.g. (workspace = ws)
    • ⌨️ Intuitive Clap CLI
  • 🛠 Manage existing packages (utpm ws link --no-copy)
    • 🔗 Link remote and local packages (utpm workspace link)
    • 🗄️ Delete and bulk delete your packages (utpm pkg unlink, utpm pkg bulk-delete)
  • 🌐 Dependencies outside of Typst!
    • 📦 Support for third party application and plugins
    • 🔒 Portable installer (limited for now)
  • 📃 Visualization
    • 🗃️ list utpm pkg list
    • 🌲 tree utpm pkg tree
  • 🚀 Automated publication directly to Typst Universe!

...And more soon!

Warning

UTPM is still in active development, and some features may not be fully implemented. Contributions are welcome!

⚡Install

Requires Cargo and Rust.

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

🎰 Usage

Further usage information can be found by running utpm --help or utpm <command> --help on any of the sub commands. Documentation is still in progress, feel free to ask questions in the issues section. Currently the github documentation is pretty much a mirror of the help command.

Usage: utpm [OPTIONS] <COMMAND>

Commands:
  workspace  Create, edit, delete your workspace for your package [aliases: ws]
  packages   use packages related to Typst [aliases: pkg]
  generate   Generate shell completions [aliases: gen]
  help       Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose <VERBOSE>  Gives you more information, permet debug
  -h, --help               Print help
  -V, --version            Print version

Workspace (ws): Manage Your Project Workspace

  • link (l): Link your project to existing directories.
  • create (c) (Deprecated): Creates a typst.toml file. Use init instead.
  • install (i): Install dependencies listed in typst.toml.
  • add (a): Add and install new dependencies.
  • delete (d): Remove specific dependencies.
  • init: Initialize a new workspace for a Typst package.
  • publish (p) (WIP): Intended for publishing packages.
  • clone (WIP): Clone an existing workspace.

Packages (pkg): Manage Typst Packages

  • tree (t): Display all packages in a directory as a tree.
  • list (l): List all packages in a directory in a flat list.
  • path (p): Show the path to the Typst packages folder.
  • unlink (u): Remove a previously installed package.
  • bulk-delete (bd): Delete multiple packages at once.

generate (gen): Generate Shell Completions

❤️ 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