Skip to content

VS Code

The carryOn VS Code extension brings persistent terminal sessions directly into your editor.

  • Persistent terminals - carryOn sessions appear as regular VS Code terminal tabs. Close the editor, reopen it, and your sessions are still running.
  • Session browser sidebar - a dedicated sidebar panel lists all active sessions. Start, attach, rename, and kill sessions without leaving VS Code.
  • Project auto-detection - when you open a workspace that contains a .carryon.json file, the extension can automatically start the terminals defined in it, including split layouts and per-terminal colors.
  • Multiple client tracking - see which clients (other VS Code windows, CLI sessions, the web UI) are attached to each session.

The carryOn CLI must be installed and available on your PATH. The extension communicates with the daemon over its Unix socket and does not bundle its own copy of the CLI.

If the CLI is not found automatically, you can set the path manually in the extension settings.

Once available, you will be able to install the extension from the VS Code Marketplace by searching for carryOn.

SettingDefaultDescription
carryon.cliPathauto-detect from PATHPath to the carryon binary. Leave empty to use automatic detection.
carryon.autoOpenTerminalsfalseAutomatically open terminals defined in .carryon.json when a project is opened.

The extension spawns carryon attach in a VS Code terminal emulator for each session you open. It sets the environment variables CARRYON_CLIENT_TYPE=vscode and CARRYON_CLIENT_NAME=<appName> so the daemon can identify the connection as coming from VS Code.

The extension connects to the daemon socket at ~/.carryon/daemon.sock for sidebar functionality such as listing sessions and receiving status updates.