Skip to main content

A local manager for Typst templates and packages

Project description

Typst Forge

Typst Forge is a small local manager for Typst packages and templates.

It can:

  • scaffold a new Typst repo with git, typst.toml, src, and template/ when needed
  • install local development repos into Typst's package directory
  • install release repos from GitHub or any git URL
  • manage installed packages/templates with versioned registry entries
  • fall back between symlink and copy modes for platform-friendly installs

Install

Run the CLI from a checkout with uv:

uv run typst-forge --help

To run the published package from PyPI, use uvx:

uvx typst-forge --help

To run directly from this checkout without installing it, use uvx:

uvx --from . typst-forge --help

You can also run it directly from GitHub:

uvx --from git+https://github.com/<owner>/typst-forge typst-forge --help

Commands

typst-forge init ./my-template --kind template --name my-template --version 0.1.0
typst-forge init ./my-package --kind package --name my-package --version 0.1.0
typst-forge install ./my-package --link-mode copy
typst-forge install github:owner/repo@v1.2.3
typst-forge list
typst-forge status my-package
typst-forge update my-package
typst-forge remove my-package

Versioning

  • local repos use the typst.toml package version unless a matching git tag is present at HEAD
  • GitHub and other git URLs install from release tags
  • tags can be written as v1.2.3 or 1.2.3; the stored Typst version is normalized to 1.2.3
  • installed entries live under ~/.local/share/typst/packages/<namespace>/<package>/<version>

Tests

Run the in-repo test suite with:

uv run python -m unittest discover -s tests -v

Publishing

The GitHub Actions workflow in .github/workflows/publish.yml publishes tagged releases to PyPI with trusted publishing.

Create and push a version tag like v0.1.0 to trigger it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typst_forge-0.1.2.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typst_forge-0.1.2-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file typst_forge-0.1.2.tar.gz.

File metadata

  • Download URL: typst_forge-0.1.2.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for typst_forge-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f3ec009b880ca2dc329eb879d78fa595d8ad5c89bc25d1b5d95dd23487d6e0cc
MD5 345a0b54b98697872a1baf4c5df7ba21
BLAKE2b-256 9a1bf2ebbcb6f2eddbb7ad762517d0933ec4d66c3a49c17ff10dd57ddcace0db

See more details on using hashes here.

Provenance

The following attestation bundles were made for typst_forge-0.1.2.tar.gz:

Publisher: publish.yml on marcosousapoza/typst-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file typst_forge-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: typst_forge-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for typst_forge-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a67b3f3a392048a13fb19b8ccc13bb8f55fa75f8833038175e96a40e97a6772f
MD5 663d8d73644c836158ecfafbff5cd05c
BLAKE2b-256 5f0918986da54a33eb303837988f4e55ba1e2cb92944c2bdee18907350fae8b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for typst_forge-0.1.2-py3-none-any.whl:

Publisher: publish.yml on marcosousapoza/typst-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page