Generated from the core and product CLI catalogs and explicit command contributions. This reference describes the full product; standalone core installations expose the locally composed subset through the same synergy command. Concept and lifecycle guidance lives in CLI guide; use synergy --help or synergy <command> --help for the exact options of the installed version.
| Command | Description |
|---|---|
acp |
start ACP (Agent Client Protocol) server |
agent |
manage agents |
auth |
manage credentials |
browser |
diagnose and install Chromium for Browser tools |
channel |
manage messaging channels |
config |
manage synergy configuration |
data |
manage synergy data location and storage |
debug |
debugging and troubleshooting tools |
diagnostics |
create a local diagnostics package |
doctor |
diagnose synergy sandbox and environment |
embed |
manage the local embedding model |
export |
export a session transcript or self-contained rollout ZIP |
generate |
generate the OpenAPI contract |
holos |
manage Holos identity and runtime |
import |
import a session transcript or rollout ZIP |
library |
manage library memory and learning |
logs |
show synergy background service logs |
mcp |
manage MCP (Model Context Protocol) servers |
migrate |
move synergy data to a new location (alias for 'data move') |
migration |
manage schema and data migrations |
models |
list all available models |
plugin |
install, remove, update, and inspect plugins |
send |
send a message to synergy |
server |
start synergy server |
session |
manage sessions |
start |
start synergy background service |
stats |
show token usage and cost statistics |
status |
show synergy background service status |
stop |
stop synergy background service |
uninstall |
uninstall synergy and remove all related files |
upgrade |
upgrade synergy to the latest or a specific version |
web |
URL of a running synergy server |
start ACP (Agent Client Protocol) server
| Option | Description |
|---|---|
--cwd (string) |
working directory |
add an MCP server
add a channel configuration (writes to global config)
| Option | Description |
|---|---|
--print (boolean) |
print config instead of writing to file |
install and activate a plugin
manage agents
show agent configuration details
review and approve the current plugin artifact
manage credentials
authenticate with an OAuth-enabled MCP server
diagnose and install Chromium for Browser tools
manage messaging channels
verify stored objects and historical snapshot roots
reclaim unowned legacy snapshot directories (dry-run unless --apply)
pack shared snapshots (dry-run unless --apply)
manage synergy configuration
create a new agent
| Option | Description |
|---|---|
--path (string) |
directory path to generate the agent file |
--description (string) |
what the agent should do |
--mode (string) |
agent mode |
--tools (string) |
|
--model (string) |
model to use in the format of provider/model |
show local Holos credential status
| Option | Description |
|---|---|
--json (boolean) |
output as JSON |
manage synergy data location and storage
debugging and troubleshooting tools
debug OAuth connection for an MCP server
delete a session using recovery-safe filesystem/index cleanup
| Option | Description |
|---|---|
--scope (string) |
scope id when the session index is missing |
--yes (boolean) |
confirm deletion |
--json (boolean) |
create a local diagnostics package
| Option | Description |
|---|---|
--session (string) |
include indexed observability events for a specific session |
--since (string) |
include indexed observability events since a duration like 30m, 2h, or 7d |
--output (string) |
path for the generated .tar.gz package |
get diagnostics for a file
show diff for a snapshot hash
| Option | Description |
|---|---|
--session (string) |
diagnose plugin config, lockfile, and cache drift
| Option | Description |
|---|---|
--fix (boolean) |
repair duplicate config specs, stale lock entries, and orphan archive caches |
--json (boolean) |
output machine-readable JSON |
get symbols from a document
download the local embedding model (used when no remote embedding API is configured)
manage the local embedding model
configure embedding provider (writes to global config)
| Option | Description |
|---|---|
--print (boolean) |
print config instead of writing to file |
export config as JSONC (secrets redacted by default)
| Option | Description |
|---|---|
--include-secrets (boolean) |
Include plaintext api keys and secrets in the export |
--only (array) |
Export only this domain; can be repeated |
--scope (string) |
Export global or current project config |
--output (string) |
Write to this file instead of stdout |
export a session transcript or self-contained rollout ZIP
| Option | Description |
|---|---|
--format |
export format |
--run (string) |
root run ID to include in the rollout |
--output (string) |
destination file (required for rollout ZIP) |
file system debugging utilities
list files using ripgrep
| Option | Description |
|---|---|
--query (string) |
|
--glob (string) |
|
--limit (number) |
manage Holos identity and runtime
import a session transcript or rollout ZIP
import config from URL or file
| Option | Description |
|---|---|
--only (array) |
Import only this domain; can be repeated |
--mode (string) |
Import merge mode |
--scope (string) |
Import into global or current project config |
--dry-run (boolean) |
Show import plan without writing files |
--force (boolean) |
Apply even if config changed after planning |
--yes (boolean) |
Apply without confirmation |
show detailed plugin status and metadata
show snapshot ownership and logical/allocated storage usage
inspect a session without hydrating its messages
| Option | Description |
|---|---|
--scope (string) |
scope id when the session index is missing |
--json (boolean) |
install verified managed Chromium for Browser tools
| Option | Description |
|---|---|
--force (boolean) |
reinstall Chromium even when the managed version is current |
--json (boolean) |
print the installation result as JSON |
--deps (boolean) |
install required Linux system packages (use --no-deps to skip) |
install Linux system packages required by Chromium
configure experience learning parameters (writes to global config)
| Option | Description |
|---|---|
--print (boolean) |
print config instead of writing to file |
manage library memory and learning
list sessions
| Option | Description |
|---|---|
--max-count (number) |
limit to N most recent sessions |
--format (string) |
output format |
--with-health (boolean) |
include recovery-safe health data |
list files in a directory
bind to Holos platform
| Option | Description |
|---|---|
--agent-id (string) |
optional expected Holos agent ID when importing a secret |
--agent-secret (string) |
log in with an existing Holos agent secret |
log in to a provider
clear Holos credentials and stop the runtime
remove OAuth credentials for an MCP server
show synergy background service logs
| Option | Description |
|---|---|
--tail (number) |
number of trailing lines to show |
--follow (boolean) |
follow the log output |
--level (string) |
filter by log level (DEBUG, INFO, WARN, ERROR) |
--service (string) |
filter by service name |
--grep (string) |
filter lines matching pattern |
--archive (number) |
read a specific archive by index (0 = most recent) |
--dev (boolean) |
read the local development log instead of daemon logs |
--trace-id (string) |
filter observability events by trace id |
--session (string) |
filter observability events by session id |
--tool-call (string) |
filter observability events by tool call id |
--since (string) |
filter observability events since a duration like 30m, 2h, or 7d |
--json (boolean) |
print observability events as JSON |
show plugin runtime logs
LSP debugging utilities
manage MCP (Model Context Protocol) servers
configure memory parameters (writes to global config)
| Option | Description |
|---|---|
--print (boolean) |
print config instead of writing to file |
merge data from another synergy directory or zip archive
move synergy data to a new location (alias for 'data move')
| Option | Description |
|---|---|
--target (string) |
target directory path |
--remove-original (boolean) |
remove original data after successful move |
--dry-run (boolean) |
show plan without executing |
manage schema and data migrations
| Option | Description |
|---|---|
--dry-run (boolean) |
show what would run without executing |
list all available models
| Option | Description |
|---|---|
--verbose (boolean) |
use more verbose model output (includes metadata like costs) |
--refresh (boolean) |
refresh the models cache from models.dev |
move synergy data to a new location
| Option | Description |
|---|---|
--remove-original (boolean) |
remove original data after successful move |
--dry-run (boolean) |
show plan without executing |
pack synergy data into a zip archive
show patch for a snapshot hash
| Option | Description |
|---|---|
--session (string) |
show config file paths
show global paths (data, config, cache, state)
show declared plugin capabilities in user-language format
install, remove, update, and inspect plugins
read file contents as JSON
reload the Holos runtime connection
detect experience candidates with low-quality intent or script
| Option | Description |
|---|---|
--db (string) |
path to library.db (defaults to global data dir) |
--limit (number) |
max candidates to show |
--intent (boolean) |
show intent candidates |
--script (boolean) |
show script candidates |
uninstall and deactivate a plugin
| Option | Description |
|---|---|
--force (boolean) |
skip confirmation prompt |
repair broken session indexes without deleting readable message data
| Option | Description |
|---|---|
--dry-run (boolean) |
show planned repairs without applying them |
--apply (boolean) |
apply repairs |
--json (boolean) |
configure rerank provider (writes to global config)
| Option | Description |
|---|---|
--print (boolean) |
print config instead of writing to file |
restart plugin runtime
retry a failed or pending lifecycle.install for a plugin
ripgrep debugging utilities
manage plugin runtime lifecycle
list all known projects
search file contents using ripgrep
| Option | Description |
|---|---|
--glob (array) |
|
--limit (number) |
search the npm registry for Synergy plugins
send a message to synergy
| Option | Description |
|---|---|
--command (string) |
the command to run, use message for args |
--continue (boolean) |
continue the last session |
--session (string) |
session id to continue |
--scope (string) |
registered scope id (defaults to the current directory, registering it when needed) |
--model (string) |
model to use in the format of provider/model |
--agent (string) |
agent to use |
--experiment (string) |
Versioned experiment configuration file |
--non-interactive (boolean) |
Fail explicitly if the task requires user input or permission |
--timeout (number) |
Task timeout in seconds, including descendants and cleanup |
--format (string) |
format: default (formatted) or json (raw JSON events) |
--file (string) |
file(s) to attach to message |
--title (string) |
title for the session (uses truncated prompt if no value provided) |
--attach (string) |
attach to a running synergy server (start one with: synergy start) |
--port (number) |
accepted for compatibility; local execution does not open an HTTP listener |
--variant (string) |
model variant (provider-specific reasoning effort, e.g., high, max, minimal) |
--workflow (string) |
run the message as a Light Loop workflow task: the session enables loop_stop and a reviewer loop, and send exits when the workflow reaches a terminal state |
manage sessions
set SYNERGY_HOME to change data location (does not move data)
| Option | Description |
|---|---|
--unset (boolean) |
remove SYNERGY_HOME, revert to default ~/.synergy |
show current library configuration
list all available skills
snapshot debugging utilities
inspect and maintain file snapshot storage
start synergy background service
| Option | Description |
|---|---|
--non-interactive (boolean) |
skip Holos login prompts before starting the background service |
start or reconnect channels
show token usage and cost statistics
| Option | Description |
|---|---|
--run (string) |
Show one run and its descendant accounting |
--compare (string) |
Compare two runs without inferring task quality |
--days (number) |
show stats for the last N days (default: all time) |
--tools (number) |
number of tools to show (default: all) |
--models |
show model statistics (default: hidden). Pass a number to show top N, otherwise shows all |
--project (string) |
filter by project (default: all projects, empty string: current project) |
--recompute (boolean) |
force full recompute from scratch |
--json (boolean) |
output raw JSON instead of formatted display |
show synergy background service status
| Option | Description |
|---|---|
--verbose (boolean) |
show lock, health, observability, and local process details |
show plugin runtime status
stop synergy background service
stop channels
stop plugin runtime
search workspace symbols
track current snapshot state
| Option | Description |
|---|---|
--session (string) |
show file tree using ripgrep
| Option | Description |
|---|---|
--limit (number) |
show directory tree
update plugins to their latest version
| Option | Description |
|---|---|
--auto-approve (boolean) |
auto-approve permission changes without prompting (low-security convenience) |
show provider account usage and quota windows
verify stored Holos credentials
URL of a running synergy server
| Option | Description |
|---|---|
--attach (string) |
URL of a running synergy server |
interactive config wizard — auto-detect and set up providers