Quick Start

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

Install (Linux / Mac)

Beam is hosted from a private artifact repository. Please reach out to your team at Somewear to get an username and password for the artifact repository.

Download Beam to ~/bin:

curl -L -u <ARTIFACTS_USERNAME> "https://us-west2-somewear-souvla.cloudfunctions.net/core-artifacts/beam/latest/beam-$(uname -m)-$(uname -s)" --output ~/bin/beam

Make binary executable:

chmod +x ~/bin/beam

Run help command to verify installation:

beam -h

Configuration

To configure Beam, you'll need to create a beam.properties file. The first property we'll add will be your core-artifact-credentials . This will allow you to update Beam from the command line as new versions are released.

Create your beam.properties file

Create a Somewear config directory if it doesn't exist already:

mkdir -p ~/.config/somewear

Within that directory, add the beam.properties file:

touch ~/.config/somewear/beam.properties

Add the core artifact credentials to your beam.properties file:

core-artifact-credentials=${SOMEWEAR_ARTIFACTS_USERNAME}:${SOMEWEAR_ARTIFACTS_PASSWORD}

Authentication

To leverage the Somewear Grid APIs you will need to provision an API key. Beam retrieves this API key from your beam.properties file.

Create your 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

Add the API key to your beam.properties file:

api-key=${SOMEWEAR_GRID_API_KEY}

Fetch Workspaces

The core work group in Somewear is a workspace. Beam allows to you retrieve the list of workspaces the Beam identity is active in from the command line:

beam workspace list

If you have not joined any workspaces with Beam, this list will be empty.

Send a Message

If you are using an API key for auth, you will need to initialize the identity by fetching the workspaces prior to sending a message. Note: this only has to be done once per API key.

A core feature of Somewear is chat. Beam allows you to send chat messages from the command line:

beam message send --direct --content "Hello from Beam!" --phone "<YOUR_PHONE_NUMBER>"