Commands

Complete reference for every carryOn CLI command, flag, and option.

carryon

Create a new session and attach to it.

carryon [flags]

Flag	Default	Description
`--name`, `-n`	auto-generated	Name for the new session
`--backend`, `-b`	value of `default.backend`	Backend to use (`native` or `tmux`)

When you run carryon without arguments, a session is created with an auto-generated name using the default backend. The daemon starts automatically if it is not already running.

Examples

# Create a session with an auto-generated name
carryon

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

# Create a session with a specific backend
carryon --name build --backend tmux

carryon list

List all active sessions. ls is an alias.

carryon list
carryon ls

Displays each session’s name, backend, status, and connected clients.

carryon attach

Attach to an existing session. To detach, press Ctrl+C Ctrl+C (double tap).

carryon attach <session>

Argument	Description
`session`	Name of the session to attach to

Multiple clients can attach to the same session simultaneously. Each client receives the same output and can send input independently.

Examples

# Attach to a session named "dev"
carryon attach dev

carryon kill

Terminate a session and all processes running inside it.

carryon kill <session>

Argument	Description
`session`	Name of the session to kill

Examples

carryon kill api-server

carryon rename

Rename an existing session.

carryon rename <session> <new-name>

Argument	Description
`session`	Current name of the session
`new-name`	New name for the session

Examples

carryon rename api-server backend

carryon start

Start the daemon. The daemon starts automatically when you create your first session, so manual management is rarely needed.

carryon start [flags]

Flag	Default	Description
`--foreground`	`false`	Run in foreground instead of daemonizing

carryon stop

Stop the background daemon.

carryon stop

carryon status

Show unified status for the daemon, local server, remote access, and backends.

carryon status

Output includes:

Daemon - PID, uptime, session count
Local server - enabled, expose setting, URL
Remote access - enabled, connected, device name, relay
Backends - available backends and their status

carryon config

Read and write configuration values. carryOn stores its config in a TOML file.

carryon config <command> [args]

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

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

# Find the config file on disk
carryon config path

# Reload after editing the file manually
carryon config reload

carryon logs

View daemon and session logs. Useful for debugging issues.

carryon logs [flags]

Flag	Default	Description
`-f`, `--follow`	`false`	Follow log output in real time
`--level`	all levels	Filter logs by minimum level (`debug`, `info`, `warn`, `error`)

Examples

# View recent logs
carryon logs

# Follow logs in real time
carryon logs -f

# Show only warnings and errors
carryon logs --level warn

carryon project

Manage project configuration. Projects are defined by a .carryon.json file in your repository root. See the .carryon.json reference for the full schema.

carryon project <command>

Command	Description
`init`	Create a `.carryon.json` file in the current directory
`terminals`	Start the terminals defined in the project config
`associate`	Associate the current directory with a set of sessions
`disassociate`	Remove the project association for the current directory

Examples

# Create a new project config
carryon project init

# Start all terminals defined in .carryon.json
carryon project terminals

# Associate the current directory with running sessions
carryon project associate

# Remove the project association
carryon project disassociate

carryon update

Update carryOn to the latest version, or check for available updates.

carryon update [flags]

Flag	Description
`--check`	Check for a newer version without installing it

Examples

# Update to the latest version
carryon update

# Check for updates without installing
carryon update --check