Skip to content
Wakeplane

Getting Started

alpha · 0.1.0

Requirements

Section titled “Requirements”
  • Go 1.22+
  • SQLite (embedded via modernc.org/sqlite — no system library required)

Install

Section titled “Install”

Clone the repository and build:

Terminal window
git clone https://github.com/justyn-clark/wakeplane.git
cd wakeplane
go build ./cmd/wakeplane ./cmd/wakeplaned

Or install directly:

Terminal window
go install github.com/justyn-clark/wakeplane/cmd/wakeplane@latest
go install github.com/justyn-clark/wakeplane/cmd/wakeplaned@latest

Start the daemon

Section titled “Start the daemon”
Terminal window
wakeplaned serve --db ./wakeplane.db --addr :8080

On startup the daemon:

  1. Opens or creates the SQLite database at the given path.
  2. Runs embedded schema migrations.
  3. Starts the planner and dispatcher loops.
  4. Exposes the HTTP JSON API at the given address.

Confirm it is healthy:

Terminal window
curl http://localhost:8080/health
# {"status":"ok"}

Create your first schedule

Section titled “Create your first schedule”
Terminal window
wakeplane schedule create \
  --name daily-report \
  --type cron \
  --spec "0 9 * * *" \
  --tz "America/New_York" \
  --target-type http \
  --target-url https://internal.example.com/hooks/daily-report

Watch runs

Section titled “Watch runs”
Terminal window
wakeplane run list --schedule daily-report

Next steps

Section titled “Next steps”