Skip to content
Wakeplane

Getting Started

Use one of these supported install paths for Wakeplane. The canonical repository is github.com/justyn-clark/wakeplane.

Operator warning: installability does not change the security model. Wakeplane supports single-operator bearer auth for /v1/..., but it has no RBAC or multi-tenancy. Bind it to localhost, a trusted subnet, VPN, Tailscale, or a reverse-proxied private network.

Option 1: GitHub Releases

Section titled “Option 1: GitHub Releases”

Preferred for operators. Tagged releases publish platform archives and a checksum file on the GitHub Releases page.

For the fastest path on macOS or Linux:

Terminal window
curl -fsSL https://wakeplane.dev/install.sh | sh

By default, this installs wakeplane and wakeplaned to ~/.local/bin. Override with INSTALL_DIR=/usr/local/bin or pin a version with WAKEPLANE_VERSION=v0.2.0-beta.1.

Published for v0.2.0-beta.1:

  • wakeplane_0.2.0-beta.1_darwin_arm64.tar.gz
  • wakeplane_0.2.0-beta.1_linux_amd64.tar.gz
  • wakeplane_0.2.0-beta.1_linux_arm64.tar.gz
  • checksums.txt

Example verification flow:

Terminal window
curl -fsSLO https://github.com/justyn-clark/wakeplane/releases/download/v0.2.0-beta.1/wakeplane_0.2.0-beta.1_linux_amd64.tar.gz
curl -fsSLO https://github.com/justyn-clark/wakeplane/releases/download/v0.2.0-beta.1/checksums.txt
grep 'wakeplane_0.2.0-beta.1_linux_amd64.tar.gz' checksums.txt | sha256sum -c -
tar -xzf wakeplane_0.2.0-beta.1_linux_amd64.tar.gz
./wakeplane version

Each archive contains both wakeplane and wakeplaned.

Option 2: go install

Section titled “Option 2: go install”

The repo currently declares go 1.25.0 in go.mod.

Terminal window
go install github.com/justyn-clark/wakeplane/cmd/wakeplane@v0.2.0-beta.1
go install github.com/justyn-clark/wakeplane/cmd/wakeplaned@v0.2.0-beta.1
wakeplane version

Option 3: Source build

Section titled “Option 3: Source build”
Terminal window
git clone https://github.com/justyn-clark/wakeplane.git
cd wakeplane
go build ./cmd/wakeplane
go build ./cmd/wakeplaned
./wakeplane version

Smoke test after install

Section titled “Smoke test after install”
Terminal window
./wakeplane version
WAKEPLANE_DB_PATH=./wakeplane.db \
WAKEPLANE_HTTP_ADDR=:8080 \
WAKEPLANE_WORKER_ID=wrk_local \
./wakeplane serve

In another terminal:

Terminal window
curl http://localhost:8080/healthz
curl http://localhost:8080/readyz

The version, healthz, and readyz checks are enough for the initial install smoke test. Create schedules with the API or CLI after you have chosen a working directory and manifest location.