Install Beam, connect it to your Organization, and send a test message — all from the command line.

Install Beam

curl -fsSL https://get.somewear.app/beam/install-beam.sh | bash

This downloads the Beam binary, makes it executable, and adds it to your path. A successful install prints Beam’s help text.

Create an API key

An API key comes from your Organization’s admin dashboard, under Integrations → API Keys at somewear.app/app/settings/organization/integrations.

Note

If you don’t see the Integrations page or the API Keys section, ask the Somewear team to enable it for your Organization.

Copy the key somewhere safe, like a password manager — you’ll paste it in shortly.

Activate the key for a Workspace

An API key can’t send or receive data until it’s added to a Workspace. Click the gear icon next to your new key, then toggle on the Workspace you want this key to act on.

Beam automatically activates the first Workspace you join. To see your Workspaces or switch which one is active, run beam workspace activate.

Connect Beam to your Organization

Run:

sudo beam up

On first run, Beam asks for your API key — paste in the one you created above. This writes a config file to ~/.config/somewear/beam.properties.

Note

beam up keeps Beam running in the background as a daemon. Most other Beam commands need that daemon running.

Send a test message

beam message send --content 'Hello from Beam'

If that message reaches your Workspace, Beam is installed and authenticated correctly.