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/marcosousapoza/typst-forge typst-forge --help

Commands

typst-forge init ./my-template --kind template --name my-template --namespace local --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>
  • template scaffolds import their library through Typst’s package path, for example @local/<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.3.tar.gz (12.0 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.3-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: typst_forge-0.1.3.tar.gz
  • Upload date:
  • Size: 12.0 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.3.tar.gz
Algorithm Hash digest
SHA256 f9e240484dc176ae29d06b2f6eb91ea8a69e43e3f9e4d9cb84e2a77017b04dff
MD5 82661d5d9c23fa2e545a67172ed75d1a
BLAKE2b-256 f8dbb07e63475d90964eec9415625c0fa7613a0585204b40d95384dae4bf57fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for typst_forge-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: typst_forge-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 12.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6cf5e5246dca4e3272b9dbfa37eb3787c1b44af4ca3aafcd7eac49dd9420b16e
MD5 59e04c82e48159b7b4d6f1d603fb4fdd
BLAKE2b-256 611409a7bba94b33dc956936e0673ccf6cb7353ee6fd78d667ba7031290ba0b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for typst_forge-0.1.3-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