Skip to content
Sigil

Installation

Prerequisites

Section titled “Prerequisites”
  • Bun v1.0+ — Sigil runs on Bun natively (no build step)
  • Docker — Required for database entities (Postgres, etc.)

Install

Section titled “Install”

As a project dependency

Section titled “As a project dependency”
Terminal window
bun add sigil

Globally (makes sigil CLI available everywhere)

Section titled “Globally (makes sigil CLI available everywhere)”
Terminal window
bun add -g sigil

For development (from source)

Section titled “For development (from source)”
Terminal window
git clone https://github.com/pcutter1/sigil.git
cd sigil
bun install
bun link

bun link registers the package globally — both the sigil CLI binary and the import "sigil" SDK resolve from your local clone.

Verify

Section titled “Verify”
Terminal window
sigil --help

You should see the available commands: up, down, status, init.

Next Steps

Section titled “Next Steps”

Head to the Quickstart to create your first environment.