README.md

Typst installer

🤖 curl | sh installer script for Typst
💡 Inspired by denoland/deno_install

# ✨🚀 curl -fsSL https://typst.community/typst-install/install.sh | sh typst compile paper.typ

🚀 Easy to get started; just one shell command!
🟦 Works on Windows too

👀 Don't want to use curl | sh? Follow the official Typst installation instructions and download a binary from typst/typst releases.

Usage

Linux, macOS, WSL

curl -fsSL https://typst.community/typst-install/install.sh | sh

Windows

irm https://typst.community/typst-install/install.ps1 | iex

Change install location

Linux, macOS, WSL

export TYPST_INSTALL="/usr/local"
curl -fsSL https://typst.community/typst-install/install.sh | sh

Windows

$Env:TYPST_INSTALL = "C:\Program Files\typst"
irm https://typst.community/typst-install/install.ps1 | iex

Install specific version

Linux, macOS, WSL

curl -fsSL https://typst.community/typst-install/install.sh | sh -s 0.10.0

Windows

v="0.10.0"; irm https://typst.community/typst-install/install.ps1 | iex

Now you can use typst! It's installed to ~/.typst/* by default.

The Typst compiler

Usage: typst [OPTIONS] <COMMAND>

Commands:
  compile  Compiles an input file into a supported output format [aliases: c]
  watch    Watches an input file and recompiles on changes [aliases: w]
  query    Processes an input file to extract provided metadata
  fonts    Lists all discovered fonts in system and custom font paths
  update   Self update the Typst CLI
  help     Print this message or the help of the given subcommand(s)

Options:
  -v, --verbosity...  Sets the level of logging verbosity: -v = warning & error, -vv = info, -vvv = debug, -vvvv = trace
      --cert <CERT>   Path to a custom CA certificate to use when making network requests [env: TYPST_CERT=]
  -h, --help          Print help
  -V, --version       Print version

Development

GitHub Pages is enabled and pulls straight from the main branch's root folder. That's how the https://typst.community/typst-install/install.sh script is published. That means it's a good idea to make sure that the main branch always works! 😉