Basic Commands

A quick reference for the most common carryOn CLI commands.

Session management

Command	Description
`carryon`	Start a new session with an auto-generated name
`carryon --name <name>`	Start a new session with a specific name
`carryon --backend <backend>`	Start a new session using a specific backend
`carryon list`	List all active sessions
`carryon attach <name>`	Attach to an existing session
`carryon kill <name>`	Terminate a session and its processes
`carryon rename <old> <new>`	Rename an existing session

Examples

# Start a named session
carryon --name api-server

# Start a session with the tmux backend
carryon --name build --backend tmux

# List all running sessions
carryon list

# Reattach to a session
carryon attach api-server

# Rename a session
carryon rename api-server backend

# Kill a session you no longer need
carryon kill build

Web UI

carryOn includes a local web interface for managing sessions from your browser. By default it runs at http://127.0.0.1:8384.

Command	Description
`carryon config set local.enabled true`	Start the web UI
`carryon config set local.enabled false`	Stop the web UI

Daemon

The daemon runs in the background and manages all sessions. It starts automatically when you create your first session.

Command	Description
`carryon status`	Show daemon, local, remote, and backend status
`carryon start`	Start the daemon manually
`carryon stop`	Stop the daemon

Configuration

carryOn stores its configuration in a file and exposes it through the config subcommand.

Command	Description
`carryon config get <key>`	Read a config value
`carryon config set <key> <value>`	Write a config value
`carryon config reload`	Reload configuration from disk
`carryon config path`	Print the path to the config file

Common config keys

Key	Default	Description
`default.backend`	`native`	Backend used for new sessions (`native` or `tmux`)
`local.port`	`8384`	Port the web UI listens on
`local.expose`	`false`	Expose the web UI beyond localhost
`logs.level`	`info`	Log verbosity (`debug`, `info`, `warn`, `error`)

Examples

# Switch the default backend to tmux
carryon config set default.backend tmux

# Change the web UI port
carryon config set local.port 9090

# Check the current log level
carryon config get logs.level

Logs

View daemon and session logs for debugging.

Command	Description
`carryon logs`	Print recent log output
`carryon logs -f`	Follow log output in real time
`carryon logs --level <level>`	Filter logs by minimum level (`debug`, `info`, `warn`, `error`)

Updates

Command	Description
`carryon update`	Download and install the latest version
`carryon update --check`	Check for a newer version without installing

Backends

carryOn supports multiple backends for managing the underlying terminal sessions. Backend information is included in carryon status output.

native - the default built-in backend. No external dependencies. Uses lightweight holder processes to keep sessions alive.
tmux - optional backend that delegates session management to tmux. Requires tmux to be installed separately.

To change the default backend, run:

carryon config set default.backend tmux

You can also select a backend per session with the --backend flag:

carryon --name work --backend tmux