https://github.com/typst-community/typst-install

🤖 curl | sh installer script for Typst
https://github.com/typst-community/typst-install

installer installer-script powershell script shell typst typst-community

Last synced: 10 months ago
JSON representation

🤖 curl | sh installer script for Typst

• Host: GitHub
• URL: https://github.com/typst-community/typst-install
• Owner: typst-community
• License: mit
• Created: 2023-12-17T19:31:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-06T00:53:43.000Z (almost 2 years ago)
• Last Synced: 2025-03-25T22:36:21.532Z (10 months ago)
• Topics: installer, installer-script, powershell, script, shell, typst, typst-community
• Language: Shell
• Homepage:
• Size: 75.2 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Typst installer

🤖 `curl | sh` installer script for Typst \

💡 Inspired by [denoland/deno_install]

```sh

# ✨🚀

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](https://img.shields.io/static/v1?style=for-the-badge&message=Linux&color=222222&logo=Linux&logoColor=FCC624&label=)

![Windows](https://img.shields.io/static/v1?style=for-the-badge&message=Windows&color=0078D4&logo=Windows&logoColor=FFFFFF&label=)

![macOS](https://img.shields.io/static/v1?style=for-the-badge&message=macOS&color=000000&logo=macOS&logoColor=FFFFFF&label=)

Linux, macOS, WSL

```sh

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

```

Windows

```ps1

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

```

Change install location

Linux, macOS, WSL

```sh

export TYPST_INSTALL="/usr/local"

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

```

Windows

```ps1

$Env:TYPST_INSTALL = "C:\Program Files\typst"

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

```

Install specific version

Linux, macOS, WSL

```sh

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

```

Windows

```ps1

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.

```sh

The Typst compiler

Usage: typst [OPTIONS] 

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    Path to a custom CA certificate to use when making network requests [env: TYPST_CERT=]

  -h, --help          Print help

  -V, --version       Print version

```

## Development

![sh](https://img.shields.io/static/v1?style=for-the-badge&message=sh&color=4EAA25&logo=GNU+Bash&logoColor=FFFFFF&label=)

![PowerShell](https://img.shields.io/static/v1?style=for-the-badge&message=PowerShell&color=5391FE&logo=PowerShell&logoColor=FFFFFF&label=)

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!** 😉

[official Typst installation instructions]: https://github.com/typst/typst#installation

[typst/typst releases]: https://github.com/typst/typst/releases

[denoland/deno_install]: https://github.com/denoland/deno_install