Documentation
Welcome to the carryOn documentation. carryOn is a terminal session manager that keeps your sessions alive through crashes, disconnects, and device switches.
Getting started
Section titled “Getting started”New to carryOn? Start here:
- Installation - install the CLI on macOS, Linux, or Windows
- Your first session - create, detach, and reattach a session
- Basic commands - essential commands for daily use
Architecture
Section titled “Architecture”- Architecture overview - how all the components fit together
- Security - encryption, threat model, and credential storage
Reference
Section titled “Reference”- CLI commands - complete command reference
- .carryon.json - per-project terminal configuration
- Protocol reference - IPC protocol for client developers
Clients
Section titled “Clients”- VS Code - persistent terminals in VS Code
- JetBrains - persistent terminals in JetBrains IDEs
- Web UI - access sessions from a browser or your phone
Remote Access
Section titled “Remote Access”- Setup & Login - set up remote access to your sessions
- Devices - manage devices connected to your account
- How It Works - signaling, relay, and E2E encryption