Getting Started
Install
Grab a prebuilt binary or build the beam CLI from source with Go.
The beam CLI is a single, statically-linked Go binary. You only need the
edge Worker if you're deploying your own hub — to use an
existing beam, the CLI is all you need.
Prebuilt binary
Grab the archive for your OS/arch from the
Releases page, extract beam,
and drop it on your PATH:
# example for a macOS arm64 build — adjust the asset name for your platform
tar xzf beam_*_darwin_arm64.tar.gz
mv beam /usr/local/bin/
beam --versionWith Go
Requires Go 1.22+.
# Build the CLI onto your PATH (~/go/bin is already there for most Go installs):
go build -o ~/go/bin/beam ./cli
# Or install straight from the repo (lands at ~/go/bin/cli — rename to beam):
go install github.com/Arjia-Labs/beam/cli@latest
mv ~/go/bin/cli ~/go/bin/beamVerify
beam --version
beam --helpYou should see the command tree:
Usage: beam <command> [flags]
beam - tunnel webhooks from the beam server to a local URL.
Commands:
webhook listen <name> Listen for webhooks and replay them to a local URL.
webhook send <name> Send a delivery to a beam hub.Next
- Quickstart — forward your first webhook.
- Config file — stop retyping your token.