Skip to content

CLI

Use the BeeBuzz CLI when the sender can run a command and you want the notification content encrypted before upload.

The CLI fetches your paired device public keys, encrypts locally, and sends ciphertext to BeeBuzz.

With Homebrew:

Terminal window
brew tap beebuzz/tap https://codeberg.org/beebuzz/homebrew-tap
brew install beebuzz

With Go:

Terminal window
go install go.beebuzz.app/cli/cmd/beebuzz@latest

You can also download binaries from the CLI releases.

Check the install:

Terminal window
beebuzz version

Create an API token in the BeeBuzz web app, then run:

Terminal window
beebuzz connect

Paste the API token when prompted.

For hosted BeeBuzz, the CLI defaults to https://api.beebuzz.app.

Terminal window
beebuzz send "Build finished"

Add a body:

Terminal window
beebuzz send "Build failed" "Deploy exited with code 1"

Send to a topic:

Terminal window
beebuzz send --topic alerts "CPU high"

Set priority:

Terminal window
beebuzz send --priority high "Door opened"

Attach a local file:

Terminal window
beebuzz send --attachment ./snapshot.jpg "Motion detected"

Inline attachments sent by the CLI are encrypted before upload.

Attachment content is limited to 1 MiB.

Profiles let one CLI install talk to more than one BeeBuzz account or instance.

Terminal window
beebuzz profile list
beebuzz profile use work
beebuzz profile show work
beebuzz profile delete work
  • BEEBUZZ_API_URL overrides the API URL
  • BEEBUZZ_API_TOKEN provides the token without an interactive prompt

Precedence is:

  1. flags
  2. environment variables
  3. profile
  4. defaults

If the CLI cannot send:

  • confirm the API token belongs to the same account as the paired device
  • confirm the token can send to the target topic
  • run beebuzz keys to refresh paired device keys
  • check that the receiving device is still paired