CLI Reference
This document contains the help content for the aoe command-line program.
Command Overview:
aoe↴aoe add↴aoe init↴aoe list↴aoe remove↴aoe send↴aoe status↴aoe session↴aoe session start↴aoe session stop↴aoe session restart↴aoe session attach↴aoe session show↴aoe session rename↴aoe session capture↴aoe session current↴aoe group↴aoe group list↴aoe group create↴aoe group delete↴aoe group move↴aoe profile↴aoe profile list↴aoe profile create↴aoe profile delete↴aoe profile rename↴aoe profile default↴aoe worktree↴aoe worktree list↴aoe worktree info↴aoe worktree cleanup↴aoe tmux↴aoe tmux status↴aoe sounds↴aoe sounds install↴aoe sounds list↴aoe sounds test↴aoe theme↴aoe theme list↴aoe theme export↴aoe theme dir↴aoe serve↴aoe uninstall↴aoe completion↴
aoe
Agent of Empires (aoe) is a terminal session manager that uses tmux to help you manage and monitor AI coding agents like Claude Code and OpenCode.
Run without arguments to launch the TUI dashboard.
Usage: aoe [OPTIONS] [COMMAND]
Subcommands:
add— Add a new sessioninit— Initialize .agent-of-empires/config.toml in a repositorylist— List all sessionsremove— Remove a sessionsend— Send a message to a running agent sessionstatus— Show session status summarysession— Manage session lifecycle (start, stop, attach, etc.)group— Manage groups for organizing sessionsprofile— Manage profiles (separate workspaces)worktree— Manage git worktrees for parallel developmenttmux— tmux integration utilitiessounds— Manage sound effects for agent state transitionstheme— Manage color themes (list, export, customize)serve— Start a web dashboard for remote session accessuninstall— Uninstall Agent of Empirescompletion— Generate shell completions
Options:
-p,--profile <PROFILE>— Profile to use (separate workspace with its own sessions)
aoe add
Add a new session
Usage: aoe add [OPTIONS] [PATH]
Arguments:
-
<PATH>— Project directory (defaults to current directory)Default value:
.
Options:
-t,--title <TITLE>— Session title (defaults to folder name)-g,--group <GROUP>— Group path (defaults to parent folder)-c,--cmd <COMMAND>— Command to run (e.g., ‘claude’ or any other supported agent)-P,--parent <PARENT>— Parent session (creates sub-session, inherits group)-l,--launch— Launch the session immediately after creating-w,--worktree <WORKTREE_BRANCH>— Create session in a git worktree for the specified branch-b,--new-branch— Create a new branch (use with —worktree)-r,--repo <EXTRA_REPOS>— Additional repositories for multi-repo workspace (use with —worktree)-s,--sandbox— Run session in Docker sandbox--sandbox-image <SANDBOX_IMAGE>— Custom Docker image for sandbox (implies —sandbox)-y,--yolo— Enable YOLO mode (skip permission prompts)--trust-hooks— Automatically trust repository hooks without prompting--extra-args <EXTRA_ARGS>— Extra arguments to append after the agent binary--cmd-override <CMD_OVERRIDE>— Override the agent binary command
aoe init
Initialize .agent-of-empires/config.toml in a repository
Usage: aoe init [PATH]
Arguments:
-
<PATH>— Directory to initialize (defaults to current directory)Default value:
.
aoe list
List all sessions
Usage: aoe list [OPTIONS]
Options:
--json— Output as JSON--all— List sessions from all profiles
aoe remove
Remove a session
Usage: aoe remove [OPTIONS] <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title to remove
Options:
--delete-worktree— Delete worktree directory (default: keep worktree)--delete-branch— Delete git branch after worktree removal (default: per config)--force— Force worktree removal even with untracked/modified files--keep-container— Keep container instead of deleting it (default: delete per config)
aoe send
Send a message to a running agent session
Usage: aoe send <IDENTIFIER> <MESSAGE>
Arguments:
<IDENTIFIER>— Session ID or title<MESSAGE>— Message to send to the agent
aoe status
Show session status summary
Usage: aoe status [OPTIONS]
Options:
-v,--verbose— Show detailed session list-q,--quiet— Only output waiting count (for scripts)--json— Output as JSON
aoe session
Manage session lifecycle (start, stop, attach, etc.)
Usage: aoe session <COMMAND>
Subcommands:
start— Start a session’s tmux processstop— Stop session processrestart— Restart sessionattach— Attach to session interactivelyshow— Show session detailsrename— Rename a sessioncapture— Capture tmux pane outputcurrent— Auto-detect current session
aoe session start
Start a session’s tmux process
Usage: aoe session start <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title
aoe session stop
Stop session process
Usage: aoe session stop <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title
aoe session restart
Restart session
Usage: aoe session restart <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title
aoe session attach
Attach to session interactively
Usage: aoe session attach <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title
aoe session show
Show session details
Usage: aoe session show [OPTIONS] [IDENTIFIER]
Arguments:
<IDENTIFIER>— Session ID or title (optional, auto-detects in tmux)
Options:
--json— Output as JSON
aoe session rename
Rename a session
Usage: aoe session rename [OPTIONS] [IDENTIFIER]
Arguments:
<IDENTIFIER>— Session ID or title (optional, auto-detects in tmux)
Options:
-t,--title <TITLE>— New title for the session-g,--group <GROUP>— New group for the session (empty string to ungroup)
aoe session capture
Capture tmux pane output
Usage: aoe session capture [OPTIONS] [IDENTIFIER]
Arguments:
<IDENTIFIER>— Session ID or title (auto-detects in tmux if omitted)
Options:
-
-n,--lines <LINES>— Number of lines to captureDefault value:
50 -
--strip-ansi— Strip ANSI escape codes -
--json— Output as JSON
aoe session current
Auto-detect current session
Usage: aoe session current [OPTIONS]
Options:
-q,--quiet— Just session name (for scripting)--json— Output as JSON
aoe group
Manage groups for organizing sessions
Usage: aoe group <COMMAND>
Subcommands:
list— List all groupscreate— Create a new groupdelete— Delete a groupmove— Move session to group
aoe group list
List all groups
Usage: aoe group list [OPTIONS]
Options:
--json— Output as JSON
aoe group create
Create a new group
Usage: aoe group create [OPTIONS] <NAME>
Arguments:
<NAME>— Group name
Options:
--parent <PARENT>— Parent group for creating subgroups
aoe group delete
Delete a group
Usage: aoe group delete [OPTIONS] <NAME>
Arguments:
<NAME>— Group name
Options:
--force— Force delete by moving sessions to default group
aoe group move
Move session to group
Usage: aoe group move <IDENTIFIER> <GROUP>
Arguments:
<IDENTIFIER>— Session ID or title<GROUP>— Target group
aoe profile
Manage profiles (separate workspaces)
Usage: aoe profile [COMMAND]
Subcommands:
list— List all profilescreate— Create a new profiledelete— Delete a profilerename— Rename a profiledefault— Show or set default profile
aoe profile list
List all profiles
Usage: aoe profile list
aoe profile create
Create a new profile
Usage: aoe profile create <NAME>
Arguments:
<NAME>— Profile name
aoe profile delete
Delete a profile
Usage: aoe profile delete <NAME>
Arguments:
<NAME>— Profile name
aoe profile rename
Rename a profile
Usage: aoe profile rename <OLD_NAME> <NEW_NAME>
Arguments:
<OLD_NAME>— Current profile name<NEW_NAME>— New profile name
aoe profile default
Show or set default profile
Usage: aoe profile default [NAME]
Arguments:
<NAME>— Profile name (optional, shows current if not provided)
aoe worktree
Manage git worktrees for parallel development
Usage: aoe worktree <COMMAND>
Subcommands:
list— List all worktrees in current repositoryinfo— Show worktree information for a sessioncleanup— Cleanup orphaned worktrees
aoe worktree list
List all worktrees in current repository
Usage: aoe worktree list
aoe worktree info
Show worktree information for a session
Usage: aoe worktree info <IDENTIFIER>
Arguments:
<IDENTIFIER>— Session ID or title
aoe worktree cleanup
Cleanup orphaned worktrees
Usage: aoe worktree cleanup [OPTIONS]
Options:
-f,--force— Actually remove worktrees (default is dry-run)
aoe tmux
tmux integration utilities
Usage: aoe tmux <COMMAND>
Subcommands:
status— Output session info for use in custom tmux status bar
aoe tmux status
Output session info for use in custom tmux status bar
Add this to your ~/.tmux.conf: set -g status-right ”#(aoe tmux status)”
Usage: aoe tmux status [OPTIONS]
Options:
-
-f,--format <FORMAT>— Output format (text or json)Default value:
text
aoe sounds
Manage sound effects for agent state transitions
Usage: aoe sounds <COMMAND>
Subcommands:
install— Install bundled sound effectslist— List currently installed soundstest— Test a sound by playing it
aoe sounds install
Install bundled sound effects
Usage: aoe sounds install
aoe sounds list
List currently installed sounds
Usage: aoe sounds list
aoe sounds test
Test a sound by playing it
Usage: aoe sounds test <NAME>
Arguments:
<NAME>— Sound file name (without extension)
aoe theme
Manage color themes (list, export, customize)
Usage: aoe theme <COMMAND>
Subcommands:
list— List all available themes (built-in and custom)export— Export a built-in theme as a TOML file for customizationdir— Show the custom themes directory path
aoe theme list
List all available themes (built-in and custom)
Usage: aoe theme list
aoe theme export
Export a built-in theme as a TOML file for customization
Usage: aoe theme export [OPTIONS] <NAME>
Arguments:
<NAME>— Theme name to export
Options:
-o,--output <OUTPUT>— Output file path (defaults to.toml in the themes directory)
aoe theme dir
Show the custom themes directory path
Usage: aoe theme dir
aoe serve
Start a web dashboard for remote session access
Usage: aoe serve [OPTIONS]
Options:
-
--port <PORT>— Port to listen onDefault value:
8080 -
--host <HOST>— Host/IP to bind to (use 0.0.0.0 for LAN/VPN access)Default value:
127.0.0.1 -
--no-auth— Disable authentication (only allowed with localhost binding) -
--read-only— Read-only mode: view terminals but cannot send keystrokes -
--remote— Expose the dashboard over a public HTTPS tunnel. Prefers Tailscale Funnel whentailscaleis installed and logged in (stable.ts.netURL, installable PWAs survive restarts). Falls back to a Cloudflare quick tunnel otherwise (fresh URL on every restart) -
--tunnel-name <TUNNEL_NAME>— Use a named Cloudflare Tunnel (requires priorcloudflared tunnel create). Takes precedence over Tailscale auto-detection -
--no-tailscale— Skip Tailscale Funnel auto-detection and go straight to Cloudflare. Useful if you have Tailscale installed for unrelated reasons -
--tunnel-url <TUNNEL_URL>— Hostname for a named tunnel (e.g., aoe.example.com) -
--daemon— Run as a background daemon (detach from terminal) -
--stop— Stop a running daemon -
--passphrase <PASSPHRASE>— Require a passphrase for login (second-factor auth). Can also be set via AOE_SERVE_PASSPHRASE environment variable
aoe uninstall
Uninstall Agent of Empires
Usage: aoe uninstall [OPTIONS]
Options:
--keep-data— Keep data directory (sessions, config, logs)--keep-tmux-config— Keep tmux configuration--dry-run— Show what would be removed without removing-y— Skip confirmation prompts
aoe completion
Generate shell completions
Usage: aoe completion <SHELL>
Arguments:
-
<SHELL>— Shell to generate completions forPossible values:
bash,elvish,fish,powershell,zsh
This document was generated automatically by
clap-markdown.