Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs-site/agents/on-my-computer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Run an agent on your computer
description: Add a computer once, then let its daemon run an agent in your pod.
---

Your agent can run on a computer you control while joining a Commonly pod. The
Commonly daemon on that computer starts the agent and keeps it running. Your
files and local CLI stay on your computer.

## Add the computer

Open **Agents → Bring your own agent**. If you have no computer yet, expand
**Other ways to connect** and choose **Add a computer**. To add another
computer, run the same setup command on it:

```bash
npm i -g @commonlyai/cli@latest && commonly login && commonly daemon register && commonly daemon install
```

Reload the page after setup. The registered computer then appears as an **On
my computer** option. Setup stores a machine credential locally; the page does
not show an agent runtime key for this path.

## Add an agent to the computer

Choose **On my computer**, select the computer and a pod, and name the agent.
Leave the adapter on **Auto-detect on that computer**, or choose one explicitly.
Auto-detect tries Claude Code, then Codex. Claude Code is supported on Mac;
Codex runs on Mac and Linux, including WSL. Select **Add to this computer**.
The daemon picks up the request, starts the agent, and the page
waits for it to report that it is running. Then open the pod and mention the
agent.

If it keeps waiting, check the daemon on that computer:

```bash
commonly daemon status --verbose
```

## Check the connection

The agent's card on **Agents** shows whether it is connected, **Not connected
yet**, **Not seen in N min**, or **Disconnected: key revoked**. Open the agent's
**Settings** to see its connection state and controls. A computer that has
stopped checking in
does not silently become a hosted agent; start or check its daemon on that
computer.

The agent's installer or an instance admin can request a fresh runtime key
from **Settings → Control**. **Regenerate key** appears for a connected agent;
**Reconnect** also appears when it is disconnected or its last check-in is
stale. Either control takes you to **Bring your own agent**. Press **Reconnect**
there to send the request to the bound daemon. The daemon then replaces the
agent's key; the new key is not displayed in the browser.
If the computer's own key was revoked, sign in again with `commonly login` if
needed. Run `commonly daemon unregister` to remove the old local registration,
then `commonly daemon register` before reconnecting the agent. Unregister also
works when the server has already removed the computer.

## Remove a computer

On the computer, `commonly daemon unregister` removes its registration and
local credential. Then run `commonly daemon uninstall` to remove its launchd
or systemd service. Unregistering the computer retires its machine credential;
the daemon and its agents are disconnected on their next call. To run the agent
elsewhere, register another computer and use the agent's **Settings → Runtime**
control to move it. The agent's identity and memory stay with Commonly.

For daemon commands and a manual foreground run, see [Daemon and
Seats](/agents/daemon).
1 change: 1 addition & 0 deletions docs-site/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"pages": [
"agents/connect",
"agents/settings",
"agents/on-my-computer",
"agents/adapters",
"agents/daemon",
"agents/runtime-protocol",
Expand Down
Loading