Obelisk Workflow Engine

Quick Start

# Download latest release from GitHub
curl -L --tlsv1.2 -sSf https://raw.githubusercontent.com/obeli-sk/obelisk/main/download.sh | bash
# Optionally place the binary on PATH

# Ask a coding agent to create JavaScript components and deployment.toml
obelisk generate prompt 'Create a workflow that fans out weather
  lookups for a list of cities in parallel' | claude

# Start the server with the generated deployment
obelisk server run --deployment deployment.toml

The prompt includes the matching Obelisk docs context for your installed version. Prefer to write the deployment file by hand? See the Getting Started guide.

Docker

# Start Obelisk in a container
docker run --rm --name obelisk \
  -p 8080:8080 -p 5005:5005 -p 9090:9090 \
  getobelisk/obelisk

# In another terminal, use the same Docker image to deploy an app
git clone https://github.com/obeli-sk/demo-tutorial
cd demo-tutorial
docker run --rm --network container:obelisk \
  -v "$PWD":/app -w /app \
  getobelisk/obelisk deployment apply deployment.toml

# Trigger the demo workflow
curl http://127.0.0.1:9090/parallel

deployment apply uploads the deployment and hot-redeploys the running server. See the Getting Started guide for the full tutorial.

cargo (b)install

# Download and install binary from GitHub:
cargo binstall obelisk
# or, if cargo-binstall is not available, build the latest release from crates.io
cargo install --locked obelisk

Building requires protoc, see project's README for details.

Download latest release from GitHub

Choose your platform:

Build from Source

git clone https://github.com/obeli-sk/obelisk && cd obelisk
cargo build --release

Building requires protoc, see project's README for details.

Nix Flake

Built artifacts are stored in the obeli-sk Cachix cache.
Make sure experimental features flakes and nix-command are enabled.

To pull pre-built binaries from the cache, add it to your Nix config (either with the cachix CLI or by editing /etc/nix/nix.conf or ~/.config/nix/nix.conf):

# Option 1: cachix CLI
nix run nixpkgs#cachix -- use obeli-sk

# Option 2: append to nix.conf
extra-substituters = https://obeli-sk.cachix.org
extra-trusted-public-keys = obeli-sk.cachix.org-1:31iM9GWSEhAXvvuTWQ7CvAcwvgRzsuJ9yJghywSd3Jw=

nix run github:obeli-sk/obelisk/latest
# Install into user's profile
nix profile install github:obeli-sk/obelisk/latest

Installation Guide