Installation

macOS


Toucan can be installed using the following methods:

  • Homebrew - recommended
  • Mint
  • Prebuilt Binary (available from 1.0.0.beta.4)
  • PKG Installer (available from version 1.0.0.beta.4)
  • Compile from source for custom or development builds

Homebrew is the preferred method for macOS environments. With Homebrew installed, Toucan can be installed using the official tap:

brew tap toucansites/toucan
brew install toucan

Or install directly without tapping:

brew install toucansites/toucan/toucan

To verify:

toucan --help

Install with Mint

To use Toucan with Mint, install it as a SwiftPM-compatible CLI tool:

mint install toucansites/toucan

Or run it without a global install:

mint run toucansites/toucan

Prebuilt Binary from GitHub Releases

Toucan is available for direct download via GitHub Releases, offering prebuilt universal binaries for macOS.

Each release archive includes the full CLI suite:

  • toucan
  • toucan-init
  • toucan-generate
  • toucan-serve
  • toucan-watch

Install with PKG Installer

Toucan is distributed as a macOS .pkg installer. Download the .pkg file from the GitHub Releases page and install it via Finder or the terminal.

Manual install (via Finder)

  1. Download the .pkg file for the desired version
  2. Double-click the file to run the macOS Installer
  3. Follow the installation prompts

Terminal install

sudo installer -pkg toucan-<version>.pkg -target /

The installer will place the toucan CLI tools into /usr/local/bin.

Once installed, verify:

toucan --help

Compile from source

For instructions on compiling from source, see Compile from source.