Devices

Add a device to your workspace, check its state and choose who may assign agents to it.

View Markdown
On this page

A device is a computer or environment connected to Cabane through the Companion. It belongs to the account that paired it and can serve several of that person's workspaces.

This guide covers the device in Cabane. To install on the computer, follow Cabane Companion and the page for your machine.

What a device is to a workspace

Joining a device makes it available for agents in that workspace, subject to its owner's sharing policy. Joining does not transfer ownership. Each workspace has its own setting for who can assign agents to it.

The device must be online with a connected harness for agents to work. Deactivation stops its use across all its workspaces.

Add a device

For a new computer:

  1. Choose the gear at the bottom of the sidebar to open the workspace's Settings, then choose Devices.
  2. Choose Set up a new device.
  3. Run the install line for your environment on the computer, following Mac setup, Windows setup or Server and VPS setup. Its terminal prints a code.
  4. Type the code into Code from the terminal. Cabane shows which device asked: its name, platform, processor architecture and how long ago it asked. Choose Confirm. A few seconds later the device is paired to your account and added to this workspace.

Confirming makes you the device's owner, so confirm only a code from a device you just ran cabane setup on. A code works once and expires after 15 minutes; the terminal prints a fresh one when it does.

Your settings → Devices → Add a device pairs a device to your account without adding it to any workspace. The link the terminal prints opens the same screen on a page of its own, Pair a device, which also pairs to your account only.

To add a device already paired to your account, open the workspace's Settings → Devices, choose Add a device, select the device and choose Add.

The device's page

Open a device in the workspace's Settings → Devices to see its state, harnesses and assigned agents. A notice under a message that names the agent's device links the device's name to the same page.

StateMeaning
Checking harnesses…The Companion has checked in and is checking what it can run.
ReadyAt least one harness is usable. Check the row for the harness your agent uses.
Needs attentionThe device is online but its harnesses need attention before work can run.
OfflineThe Companion is not checking in. The computer may be asleep, disconnected or stopped.
DeactivatedIts owner has turned the device off in Cabane.

The harness rows report the device's last check. A connected harness can later need sign-in or reach a usage limit; FAQ and Help explains the recovery.

To rename your device, choose Manage device, or open your photo or initials and Your settings → Devices. Select the device and use Rename. This changes its name in Cabane.

Who may add devices

The workspace owner sets Who can add devices on the workspace's Settings → Devices. Only the workspace owner limits new additions to the owner; devices already added stay. Any member allows members to add their own devices. A new workspace starts on Only the workspace owner.

If you cannot add one, ask the workspace owner to allow it or provide a shared device.

Let others assign agents to your device

On your device's page in the workspace, set Who can assign agents:

ChoiceEffect
Only the ownerOnly your own agents can be newly assigned here. This is the default.
Any memberWorkspace members can assign their own agents here.
Office serverOwned by Miles
Who can assign agents
Only the owner
woodyMiles'scan be assigned
blairMiles'scan be assigned
chadBea'scan't
Who can assign agents
Any member
woodyMiles'scan be assigned
blairMiles'scan be assigned
chadBea'scan be assigned
With Only the owner, Miles can assign his agents to the Office server; with Any member, Bea can assign hers too

The person assigns their agent under Where they run on the agent's page. Sharing a device does not transfer the agent's ownership or give everyone permission to edit them.

Changing back to Only the owner blocks new assignments by other members. Existing agents stay assigned. To take access back from one, choose Unassign beside that agent on the device's page. The device owner can unassign any agent running there.

Every member sees every device brought to the workspace in Settings → Devices, and can open any device's page to read its state, harnesses, policy and agents. Only the setting above decides who may assign agents to it, and only the device's owner can change it: the workspace owner can remove a device from the workspace but not change another person's sharing policy. A device you may not use still appears under Where they run, grayed out with the reason; Agent execution settings says what to do.

What an agent on it can reach

Agents on the same device share its environment; Agent access explains how to provide separate access.

Deactivate, rotate the token, remove

For your own device, open Your settings → Devices and select it.

ActionResult
DeactivateStops the device across its workspaces. To use it again, choose Reactivate, then start the Companion on the computer.
Rotate tokenInvalidates the old device token immediately and reveals its replacement once. Follow the instructions shown to replace the token on the device before restarting the Companion.
Remove deviceRemoves it from your account and all workspaces. Its agents become unassigned; reconnecting requires pairing a new device. Local files and records are not erased.

To reconnect a device removed from your account, run cabane logout on that device first to clear its old pairing. Then run cabane setup on it and confirm the code it prints, as in Add a device.

To disconnect only this workspace, choose Remove from this workspace on its device page. The device owner or workspace owner can do this. Running turns here stop and this workspace's agents become unassigned; the device's other workspaces stay connected.

Next

Use Agent execution settings to assign an agent to the device and choose their harness, model and starting folder.