Subshell Docs

Get started

Set up a Subshell server and choose where your agents will run.

New to Subshell? Read What is Subshell? to understand what it does and when it is useful.

Before you start

Use a supported Linux or macOS machine with permission to install applications. The machine must remain running while you use its server. You don't need a coding agent account to complete server setup.

Set up the server

  1. Open Subshell downloads and download Subshell Server for your operating system. See Install Subshell Server for setup details.
  2. Open the app and follow its setup assistant. It prepares the bundled server and checks for tmux.
  3. Open the setup page when the server is ready.
  4. Follow the setup experience to create your administrator account, configure the available options, and start a first session or continue to the dashboard.

The dashboard is the same web interface you can open in a browser. Your first launch opens a workspace, and later visits return to your last available workspace. Read Find your way around for the workspace selector, subshell browser, and settings.

Protect first setup

Anyone who can reach an unconfigured instance can create its first admin account. Keep the server on a trusted network until you finish setup.

Choose where agents run

The server's host can run agents too. To use it, Install an agent CLI under the server's execution account, then Launch a subshell.

To use another computer's project files and computing resources, follow Run agents on another machine. Enroll that machine as a node, install its agent CLI, and choose it in the launch dialog.

Return from another device

Follow Connect from another device to open existing sessions from another browser. Viewing a session doesn't require making that device a node.

Other installation methods

Installation covers CLI, Docker, and Proxmox deployment.

Edit on GitHub

Last updated on

On this page