Subshell Docs

Installation

Install the Subshell server and the machines that will run your agents.

Use the desktop apps for most installations. Download them from Subshell downloads, choosing the app for the machine's role.

AppInstall it onWhat it sets up
Install Subshell ServerThe machine hosting your instance.The server binary and setup assistant, including service and recovery options.
Install Subshell ClientAnother machine where you want to run agents or watch sessions.The desktop interface and bundled node binary, with a node-management window for enrollment.
  1. Install Subshell Server and complete the server's setup experience.
  2. Install Subshell Client on each additional execution machine.
  3. Follow Desktop node setup to enroll that machine with your server.

The server's own machine can run agents too. Add nodes when you want to run agents on other machines. Install coding agent CLIs under the account that will execute them; the desktop apps supply Subshell's binaries, not the agent CLIs.

CLI installation

Use the CLI when a machine is headless or you prefer terminal-based setup. These install the same server and node components used by the desktop apps.

ComponentInstructions
Server on LinuxInstall on Linux.
Server on macOSInstall on macOS.
Node on Linux or macOSEnroll a node with the CLI.
Selected or offline server releaseInstall the server manually.

The server includes its web interface. A release binary does not require Bun, a repository checkout, or a separate frontend service.

Container deployments

Run Subshell in Docker and Run the server in Proxmox LXC cover dedicated server deployments. Proxmox nodes covers a separate execution container.

Browser access

Open your server's address in any supported browser to watch and control sessions. Browser and PWA access covers standalone browser installation and phones or tablets. A device used only to access the web interface does not need a node installation.

Before choosing a machine

Agents run under the OS account hosting their node, with that account's filesystem access. Choose a trusted execution account and directory.

Next steps

Follow Get started for the recommended desktop setup, or Desktop node setup if your server is already running.

Edit on GitHub

Last updated on

On this page