Typstyle

Installation

Typstyle can be installed as a command-line tool or as a library for your project.

CLI Installation

Download Binary

The easiest way to get started is to download the pre-built binary from the release page.

Package Managers

Packaging status

Typstyle is available in many package managers. Check the packaging status for your distribution.

Notably, Typstyle is available in Archlinux CN repo.

Cargo Installation

Using cargo-binstall (Recommended)

cargo binstall typstyle
cargo binstall typstyle

Building from Source

cargo install typstyle --locked
cargo install typstyle --locked
❗Important
Installing without --locked--locked may fail due to API changes: an older typstyletypstyle could depend on a newer, incompatible typstyle-coretypstyle-core. Always use --locked--locked to ensure version compatibility.

Library Installation

Typstyle is also available as a library integrated in your project.

Cargo (Rust)

[dependencies]
typstyle-core = "=0.15.2"
[dependencies]
typstyle-core = "=0.15.2"
❗Important
Typstyle follows Typst’s major and minor versioning, and even patch releases may introduce breaking changes. We recommend pinning the version in your dependency and upgrading only when you require new features.

NPM (JavaScript/TypeScript)

For web projects using WebAssembly bindings:

npm install @typstyle/typstyle-wasm-bundler
npm install @typstyle/typstyle-wasm-bundler

The @typstyle/typstyle-wasm-bundler@typstyle/typstyle-wasm-bundler package provides WebAssembly bindings for web bundlers like Webpack, Vite, and Rollup. Please see its README for details.