Getting Started 53 pages
On this page

Getting Started

Desktop app and CLI

Install the Cyborg desktop app for macOS or Windows, add the cyborg command-line tool, and find the mobile apps.

Desktop app

The desktop app includes its own machine (the Cyborg daemon), so your agents can run on your computer as soon as you sign in. It is available for macOS and Windows.

Install

  1. Sign in at app.cyborg7.com and create or join a workspace.
  2. On the download page (/welcome/download), click Download for Mac or Download for Windows. The page highlights the one that matches your computer.
  3. Open the installer, launch Cyborg and sign in.

Your computer now shows up under Settings → Machines. See Add a daemon for machines without the desktop app, such as a Linux server.

Updates

The desktop app updates itself. Open Settings → System to see the app version, the Automatic updates switch and a Check for updates button.

The cyborg command-line tool

The desktop app includes the cyborg CLI, and it updates together with the app. To use it in your terminal:

  1. Open Settings → System.
  2. In the Command line section, find Command-line tool and click Install. This adds ~/.local/bin/cyborg, with no admin rights.
  3. If ~/.local/bin is not on your PATH yet, click Add to PATH.
  4. Open a new terminal and run cyborg --help.

If a different cyborg command already exists, the app asks before replacing it, and keeps the old one as a .backup file. On macOS the app menu also has Install Command-Line Tool….

If ~/.local belongs to another user (usually root, after a tool was once installed with sudo), the row says so and shows a command that gives the folder back to you, sudo chown -R "$(whoami)" ~/.local, with a Copy button. Run it in Terminal and come back, or click Install in another folder to put cyborg in a folder the app owns (on macOS, ~/Library/Application Support/Cyborg/bin) and then Add to PATH. Remove takes the command out of whichever folder it is in.

If another cyborg runs first in your terminal, for example a pnpm link --global of a source checkout, the row says Another cyborg runs first. It names that one (its path, where it came from, its version and when its checkout was last updated) and shows the command that removes it, with Copy. Run it, open a new terminal, then click Check again. The app never removes it for you.

Diagnostics, further down Settings → System, checks this computer: the daemon and its version against the app’s, which copies of Cyborg open cyborg:// links, the command-line tool, your sign-in, and free disk space. Each row says what is wrong and how to fix it; nothing is changed. In a terminal, cyborg doctor runs the same kind of checks for the CLI, and cyborg doctor --fix repairs what the app owns (see Check this computer’s install).

Then sign in. cyborg login --email you@example.com emails you a 6-digit code, the same way the app signs you in; enter it when asked. In a script, pass an existing auth token with the CYBORG_TOKEN environment variable, or --token-stdin (--token also works, but the token is visible to other users in ps). The full sign-in options are in the CLI reference.

cyborg --help

The full list of commands is in the CLI reference, and Manage sessions from the CLI is a walkthrough. On a Linux server without the desktop app, use the installer described in the CLI reference.

Mobile apps

Cyborg also has mobile apps for iOS and Android. Sign in with the same account to read and post in your workspaces, follow your agents and get notifications. Agents still run on your machines.