compozy
CompozyOS — the system around your agents, already built
compozy
CompozyOS — the system around your agents, already built
compozy [flags]Examples
# Start the daemon and create a session in the current workspace
compozy daemon start
compozy session new --agent general
# Print machine-readable output for automation
compozy session list -o jsonOptions
-h, --help help for compozy
--json Emit JSON output
-o, --output string Output format: human, json, jsonl, or toon (default "human")Output Formats
This command displays human-readable help and its subcommand list. The inherited -o, --output and --json flags do not serialize help output.
| Format | Output |
|---|---|
human | Help and subcommand list |
json | Not emitted for help |
jsonl | Not emitted for help |
toon | Not emitted for help |
Subcommands
| Command | Description |
|---|---|
| compozy agent | Inspect CompozyOS agent definitions |
| compozy app | Manage the CompozyOS desktop app |
| compozy automation | Manage automation jobs, triggers, suggestions, and runs |
| compozy bridge | Manage bridge instances |
| compozy ch | Use agent-facing coordination channels |
| compozy completion | Generate the autocompletion script for the specified shell |
| compozy config | Inspect and mutate CompozyOS configuration |
| compozy connect | Manage CLI connection profiles |
| compozy daemon | Manage the CompozyOS daemon |
| compozy desktop | Manage virtual desktops in a workspace |
| compozy device | Manage paired gateway devices |
| compozy doctor | Run runtime diagnostics |
| compozy drain | Stop admitting new work while in-flight work completes |
| compozy extension | Manage CompozyOS extensions |
| compozy gateway | Manage remote gateway exposure |
| compozy hooks | Inspect configured and executed hooks |
| compozy install | Bootstrap CompozyOS and create the default general agent |
| compozy layout | Inspect, preview, and change workspace layouts |
| compozy layout-profile | List, read, save, and delete saved layouts |
| compozy logs | Read cross-session runtime logs |
| compozy loop | Manage Loop definitions and runs |
| compozy marketplace | Discover installable CompozyOS capabilities |
| compozy mcp | Manage MCP integrations |
| compozy me | Inspect the current CompozyOS-managed agent session |
| compozy memory | Show, write, search, and operate Memory v2 durable context |
| compozy network | Operate the daemon-owned network runtime |
| compozy notifications | Manage notification presets |
| compozy notify | Send the operator a notification |
| compozy observe | Inspect runtime observability read models |
| compozy onboarding | Inspect and manage first-run onboarding state |
| compozy open | Open the CompozyOS web UI in the default browser |
| compozy pair | Pair remote clients with a gateway |
| compozy provider | Inspect and manage provider authentication |
| compozy resource | Manage desired-state resources |
| compozy roles | Inspect effective background role configuration |
| compozy scheduler | Inspect and control task scheduler dispatch |
| compozy session | Manage CompozyOS sessions |
| compozy skill | Manage local AgentSkills |
| compozy spawn | Spawn a bounded child agent session |
| compozy status | Show consolidated runtime status |
| compozy support | Create daemon-owned support artifacts |
| compozy task | Manage tasks and task runs |
| compozy tool | Inspect and invoke registry tools |
| compozy toolsets | Inspect registry toolsets |
| compozy undrain | Resume admission of new work |
| compozy uninstall | Stop CompozyOS and remove runtime launch artifacts |
| compozy update | Check for and apply CompozyOS runtime and app updates |
| compozy vault | Manage encrypted daemon vault metadata and write-only secrets |
| compozy version | Print the CompozyOS version |
| compozy whoami | Print the current CompozyOS agent identity from environment variables |
| compozy window | Manage windows in virtual desktops |
| compozy workspace | Manage registered workspaces |
| compozy worktree | Manage workspace worktrees |