Installing the Loom CLI
Loom ships as a single Go binary. It runs on Linux, macOS, and Windows; install it once and use it across every Loom project on the machine.
With go install (recommended)
If you have Go 1.22 or newer:
go install github.com/orbweaver-dev/loom@latest
The binary lands in $(go env GOPATH)/bin/loom. Make sure that directory is on your $PATH.
From source
git clone https://github.com/orbweaver-dev/loom.git
cd loom
go build -o /usr/local/bin/loom .
Verify the install
loom --help
You should see the full command list: add, check, deploy, eject, new, report, serve, stitch, sync, weave, plus the standard Cobra completion and help subcommands.
What you'll need next
| For | Set this |
|---|---|
loom serve |
LOOM_SECRET (32+ random bytes, e.g. openssl rand -hex 32) |
loom serve, loom stitch |
DATABASE_URL (mysql://user:pass@host/dbname?tls=true) |
loom new (real GitHub repo) |
GITHUB_TOKEN |
loom sync |
ORBWEAVER_API_KEY (Frappe key:secret) |
You don't need any of these to try Loom — loom new, loom add model, loom check, and loom weave work with no environment configuration. Set them when you reach the corresponding step.
Updating
Re-run go install github.com/orbweaver-dev/loom@latest to pick up new releases. Loom follows semver; minor releases are backwards-compatible.
Was this article helpful?