Quick Start - Linux / Mac

Beam is a flexible agent that is designed to run on servers, desktop machines, embedded computers, and any other general purpose computer.

1. Install

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

This script will download the Beam binary, make it executable, and verify it's on your path.

After a successful installation, you'll see Beam's help printed out.

2. Set up an API key

Create an API Key

An API key can be provisioned from the Somewear Grid Web App within your organization admin portal. You will find API key management under the "API Keys" section at https://somewear.app/app/settings/organization/settings.

If you do not have access to the "API Keys" section, please reach out to the Somewear team to have this activated

Click "Create API Key" to provision an API key for Beam

Copy and paste your new API key into Beam's terminal prompt and hit enter.

Activate this key for a Workspace

Before this API key can start sending & receiving data, you need to add it to a Workspace. Click on the gear icon to on the right side of your new API key.

Click on the gear icon to add the API key to a Workspace.

Toggle the Workspace you want this API key to be a member of.

Beam will automatically activate the first Workspace that you joined. You can see your list of Workspaces and activate a different workspace with beam workspace activate.

4. Beam Up

Run beam up to connect your machine to Somewear. On first usage, you'll be prompted for an API key. This will create a config file for you at ~/.config/somewear/beam.properties.

5. Send a Message

You can see

beam message send --content 'Hello from Beam'