• English
  • Installation

    Shipplane Lite ships as a single binary (shipplane-lite).

    Supported platforms

    • macOS: arm64 (Apple Silicon) only — no Intel (x64) build.
    • Linux: x64 and arm64.

    Homebrew (macOS and Linux)

    brew install adityals/shipplane/shipplane-lite

    Manual download

    Use the release binary on systems without Homebrew, such as a plain Linux host. Replace linux-x64 with linux-arm64 on ARM hosts such as Graviton or Raspberry Pi:

    curl -fL -o shipplane-lite https://github.com/adityals/shipplane/releases/latest/download/shipplane-lite-linux-x64

    Optionally verify the download before installing it. Use the checksum for the same architecture as the binary:

    curl -fL -o shipplane-lite.sha256 https://github.com/adityals/shipplane/releases/latest/download/shipplane-lite-linux-x64.sha256
    sha256sum -c shipplane-lite.sha256

    Then make the binary executable and move it onto your PATH:

    chmod +x shipplane-lite
    sudo mv shipplane-lite /usr/local/bin/shipplane-lite

    Upgrade

    • Homebrew: brew upgrade shipplane-lite
    • Manual: re-run the curl command above — there's no in-binary self-update.

    Every version's notes and binaries are on the releases page. Check it before upgrading across a minor version — task type params occasionally change.

    macOS Gatekeeper

    The binary is unsigned, so macOS may block it as software from an unidentified developer on the first run. Clear the quarantine flag once after installation:

    xattr -d com.apple.quarantine "$(command -v shipplane-lite)"

    Run

    shipplane-lite serve

    This starts an HTTP server on port 3000 by default. Open http://localhost:3000 to use the UI. Running shipplane-lite without a subcommand starts the same server.

    See Configuration to change the host and port, load a config file, or seed workflows on startup. The same binary also controls workflows from the terminal; see the CLI.