Install Cerulion - Cerulion Docs

One command. Everything included. The installer sets up the Cerulion CLI, core libraries, and shell completions automatically.

Cerulion installation — one command sets up the CLI, core libraries, and shell completions

Brew, script, or Docker. Cerulion handles the rest.

Package managers not yet available — The installation methods below (brew install, install script) will not work until public launch. During closed alpha, you’ll receive a direct download link after requesting access.

Install

macOS
Linux
Windows
Docker

brew install cerulion/tap/cerulion

Installs on both Intel and Apple Silicon Macs

Requirements & alternatives

Requirements:

macOS 12 (Monterey) or later
Homebrew package manager

What happens:

Adds the Cerulion tap: cerulion/tap
Installs the universal binary (Intel + Apple Silicon)
Sets up zsh completions automatically

Alternative — Direct download:

curl -L "https://get.cerulion.com/macos" -o cerulion.tar.gz
tar -xzf cerulion.tar.gz
sudo mv cerulion /usr/local/bin/

curl -fsSL https://get.cerulion.com | sh

Supports Ubuntu 20.04+, Debian 11+, Fedora 36+, and Arch

Requirements & alternatives

Requirements:

glibc 2.31+ (Ubuntu 20.04+, Debian 11+, Fedora 36+)
curl or wget

What the script does:

Detects your architecture (x86_64 or aarch64)
Downloads the appropriate binary
Installs to ~/.local/bin (or /usr/local/bin with sudo)
Sets up shell completions for your detected shell

Manual installation:

# x86_64
curl -L "https://get.cerulion.com/linux-x86_64" -o cerulion.tar.gz

# ARM64
curl -L "https://get.cerulion.com/linux-aarch64" -o cerulion.tar.gz

tar -xzf cerulion.tar.gz
mv cerulion ~/.local/bin/

Shell completions:

# Bash
cerulion completions bash >> ~/.bashrc

# Zsh
cerulion completions zsh >> ~/.zshrc

# Fish
cerulion completions fish > ~/.config/fish/completions/cerulion.fish

wsl --install -d Ubuntu
# Then inside WSL:
curl -fsSL https://get.cerulion.com | sh

Zero-copy transports require WSL2. Native Windows support is on our roadmap.

Why WSL2 & setup steps

Cerulion’s zero-copy transport uses shared memory (iceoryx2), which requires POSIX-compatible APIs. WSL2 provides a full Linux kernel that supports these operations natively.

Enable WSL2

Open PowerShell as Administrator:

wsl --install -d Ubuntu

Restart your computer when prompted.

Open Ubuntu

Launch “Ubuntu” from the Start menu and complete the initial setup.

Install Cerulion

Inside the Ubuntu terminal:

curl -fsSL https://get.cerulion.com | sh

Verify

cerulion --help

For the best experience, use Windows Terminal and VS Code with the WSL extension.

docker pull cerulion/cerulion:latest
docker run -it --rm cerulion/cerulion:latest cerulion --help

Dockerfile usage

FROM cerulion/cerulion:latest
COPY . /app
WORKDIR /app
# Build your nodes — replace 'my_node' with your actual node type
RUN cerulion node build my_node

The Docker image includes all dependencies and is ideal for CI/CD pipelines.

Verify Installation

cerulion --help

You should see the Cerulion command list. If you get command not found, restart your terminal to pick up the updated PATH.

Managing Your Installation

Upgrade

Cerulion can update itself:

cerulion upgrade

This downloads the latest signed release, verifies the signature, and replaces the binary. Your configuration and projects are preserved.

Run cerulion upgrade --check to see if an update is available without installing it.

Uninstall

macOS
Linux
Windows
Docker

brew uninstall cerulion
brew untap cerulion/tap

rm ~/.local/bin/cerulion
# Or if installed with sudo:
sudo rm /usr/local/bin/cerulion

Inside WSL:

rm ~/.local/bin/cerulion

To fully remove WSL Ubuntu (optional):

wsl --unregister Ubuntu

docker rmi cerulion/cerulion:latest

To remove all Cerulion images:

docker images | grep cerulion | awk '{print $3}' | xargs docker rmi

Configuration files in ~/.config/cerulion/ are preserved. Remove them manually if needed.

Troubleshooting

Command not found: cerulion

The binary isn’t in your PATH. Add it:

# For ~/.local/bin installation
export PATH="$HOME/.local/bin:$PATH"

Add this line to your ~/.bashrc, ~/.zshrc, or shell config file.

Permission denied

The install script needs write access. Either:

# Install to user directory (no sudo needed)
curl -fsSL https://get.cerulion.com | sh

# Or install system-wide with sudo
curl -fsSL https://get.cerulion.com | sudo sh

iceoryx2 not ready

Shared memory transport requires proper permissions:

# Check shared memory limits
cat /proc/sys/kernel/shmmax

# Increase if needed (requires root)
sudo sysctl -w kernel.shmmax=2147483648

On Docker, run with --ipc=host or --shm-size=1g.

macOS Gatekeeper warning

If macOS blocks the binary:

xattr -d com.apple.quarantine /usr/local/bin/cerulion

Or open System Settings → Privacy & Security (macOS 13+) / System Preferences → Security & Privacy (macOS 12) and click Allow.

Installation verified? Jump straight to the Quickstart and build your first camera-to-display pipeline in 5 minutes.

Cerulion

AI Tools

​Install

​Verify Installation

​Managing Your Installation

​Troubleshooting

Install

Verify Installation

Managing Your Installation

Troubleshooting