ao

ao

ao organizes terminals into workspaces, tabs, and panes, recognizes coding agents running inside panes, and exposes the current session through the ao CLI.

Before issuing any control command, verify that this agent is running inside a Factory-managed pane:

test "${HERDR_ENV:-}" = 1

If the check fails, say that you are not running inside the Allternit Factory and stop. Do not inspect or control the focused allternit-factory pane session from outside the Factory.

When the check passes, the ao binary in PATH talks to the current session. Use it to inspect neighboring work, create terminal layout, start agents and commands, read output, and wait for state changes.

Learn the current CLI

The installed binary is the authority for command syntax. Start with:

allternit-factory pane --help

Then print the relevant command group by running the group without a subcommand:

allternit-factory pane agent
allternit-factory pane pane
allternit-factory pane workspace
allternit-factory pane tab
allternit-factory pane worktree
allternit-factory pane terminal
allternit-factory pane notification
allternit-factory pane integration
allternit-factory pane session
allternit-factory pane machine

Do not run bare ao for discovery; it launches or attaches the TUI. Do not probe a mutating nested command by omitting arguments. Commands such as allternit-factory pane workspace create are valid with defaults and will execute.

Most control commands return JSON. Read identifiers and state from those responses instead of predicting them.

Understand layout, panes, and agents

Choose the primitive that matches the job:

• Workspace, tab, and pane topology organize terminal locations.
• Pane commands control raw terminals, shells, tests, servers, input, and output.
• Agent commands control the recognized coding agent currently occupying a pane.

A pane exists whether or not it contains an agent. agent start requires an existing available shell pane and never creates, splits, or moves layout. Use pane commands for ordinary processes. Use agent commands when ao must validate agent identity or interpret idle, working, blocked, done, and unknown lifecycle states.

Agent commands accept either a unique live agent name or the pane ID currently hosting that agent. They do not accept terminal IDs or bare agent-kind labels. Names must match [a-z][a-z0-9_-]{0,31} and be unique among live agents. A name follows the current pane occupant and is cleared when that agent exits, is released, or is replaced.

idle and done both mean the agent is ready for input. The CLI/API uses the server's seen state to distinguish them; explicit focus commands mark the target seen, while reads do not. Each TUI client tracks viewed completions independently, so its Done badge can differ from the CLI or another client's badge. blocked means ao recognized an approval or question UI. unknown means an agent is present but ao cannot classify it confidently; it does not prove completion.

Use IDs and caller context

Public IDs are opaque stable handles:

• workspace: w1
• tab: w1:t1
• pane: w1:p1

Closed tab and pane IDs are not reused. A pane moved into another workspace receives a new workspace-qualified pane ID. After pane move, continue with .result.move_result.pane.pane_id or the live agent name. The old value is reported as .result.move_result.previous_pane_id; only the moved process's inherited caller context keeps resolving that old ID, so do not use it as a general agent target.

ao injects the caller's context into each managed pane:

printf '%s\n' "$HERDR_WORKSPACE_ID" "$HERDR_TAB_ID" "$HERDR_PANE_ID"

Prefer --current when a pane command should target the calling pane. Omitting a target may use the UI-focused pane, which can belong to the user or another client.

Discover live state with:

allternit-factory pane workspace list
allternit-factory pane tab list --workspace "$HERDR_WORKSPACE_ID"
allternit-factory pane pane current --current
allternit-factory pane pane list --workspace "$HERDR_WORKSPACE_ID"
allternit-factory pane agent list

Creation responses expose the IDs to use next. workspace create returns .result.workspace, .result.tab, and .result.root_pane. tab create returns .result.tab and .result.root_pane. pane split returns the new pane as .result.pane.

IDs and live agent names are scoped to one server. Two saved SSH machines can both have w1:p1 or an agent named reviewer. Selecting a machine in the TUI does not retarget commands running in your pane: they still use the inherited session and socket context. Run remote control commands on the intended host with its explicit session, and rediscover IDs there.

allternit-factory pane machine list lists saved connection profiles, not a cross-machine pane inventory; add --json for scripts. Only add, remove, enable, or disable profiles when the user asks. Removing a profile disconnects the client but does not stop remote sessions. Adding a machine uses the remote default session unless --remote-session is explicitly supplied. Setup asks before stopping an incompatible server and defaults to No; do not approve replacement without the user's consent. Experimental handoff is not part of machine add.

Start and coordinate an agent

Default to a sibling pane in the current tab and the current working directory. Do not create a workspace, tab, worktree, or different cwd unless the user explicitly requests that topology or location.

Honor a direction requested by the user. Otherwise inspect the caller pane:

allternit-factory pane pane layout --pane "$HERDR_PANE_ID"

Split a wide pane to the right and a narrow or tall pane down. Avoid repeated same-direction splits that create unusably narrow columns or short rows. Keep the user's focus in the calling pane and explicitly preserve the caller's working directory:

allternit-factory pane pane split --current --direction right --cwd "$PWD" --no-focus

Replace right with down when appropriate. Read the new pane ID from .result.pane.pane_id.

An available shell pane must be at its interactive prompt, with the shell itself in the foreground and no foreground command, editor, or agent running. Start a supported agent in that pane with a useful unique name:

allternit-factory pane agent start reviewer --kind codex --pane <returned-pane-id>

Use the kind requested by the user. Run allternit-factory pane agent to inspect the installed kind list and options. Pass native agent arguments only after --:

allternit-factory pane agent start reviewer --kind codex --pane <returned-pane-id> -- <agent-args...>

A successful agent start returns only after ao detects the expected agent in the same pane and considers it ready for interactive input. If the agent is blocked during startup, the command returns agent_not_ready immediately but keeps the name available for agent read and agent send-keys. Wait until the agent becomes idle before prompting it. Startup defaults to a 30-second timeout.

Submit work through the agent surface:

allternit-factory pane agent prompt reviewer "Review the current diff and report only actionable findings." --wait --timeout 120000

agent prompt honors the pane's live bracketed-paste mode and sends text followed by encoded Enter as one ordered submission. It reports successful submission only after both have been written; that alone does not prove the agent started a turn. The submit delay grows with prompt size for Codex on Windows. It rejects an agent already waiting at an approval or question dialog with agent_blocked before sending any input. Inspect the blocked UI and ask the user before answering it. For normal agent work, --wait is enough: it waits for the first settled idle, done, or blocked state. Do not repeat those defaults with --until.

With --wait, a prompt sent from a non-working state must produce observed working or blocked activity. After submission, ao waits up to five seconds for that activity; unrelated idle, done, or session changes do not satisfy this gate. It returns agent_prompt_stalled if no activity is observed, or timeout if the caller's timeout expires first. The caller timeout includes submission time. Without a timeout, the settled-state wait is indefinite after activity is observed. This wait tracks lifecycle state, not an individual turn; if the agent is already working, completion of the active turn may satisfy it.

Use --until only for a state-specific workflow, such as waiting for an already-running agent to request input:

allternit-factory pane agent wait reviewer --until blocked --timeout 120000

Without --until, standalone agent wait uses the same settled-state defaults as agent prompt --wait.

Use logical keys for interactive agent UI controls:

allternit-factory pane agent send-keys reviewer esc
allternit-factory pane agent send-keys reviewer ctrl+c

ao validates all keys before writing any bytes. Read the result through the resolved agent:

allternit-factory pane agent get reviewer
allternit-factory pane agent read reviewer --source recent-unwrapped --lines 120

If a wait fails or returns blocked, inspect agent get and agent read before deciding what input to send. A timeout or stalled response does not prove the prompt was never delivered; do not blindly submit it again. Use the pane surface only when raw terminal control is intentional.

Run an ordinary command in another pane

Create a sibling pane with the same geometry rule, preserve the caller's working directory, and keep user focus unchanged:

allternit-factory pane pane split --current --direction right --cwd "$PWD" --no-focus

Read the new pane ID from .result.pane.pane_id, then run and inspect the command:

allternit-factory pane pane run <returned-pane-id> "just test"
allternit-factory pane pane wait-output <returned-pane-id> --match "test result" --timeout 120000
allternit-factory pane pane read <returned-pane-id> --source recent-unwrapped --lines 120

pane run atomically sends command text and Enter. pane wait-output searches the selected snapshot immediately, so output that already exists can match. Use --match <text> for a literal substring or --regex <pattern> for a Rust regular expression. Omitting --timeout allows an indefinite wait.

Use the read source that matches the task:

• visible: the currently rendered viewport.
• recent: recent rendered output, including soft wraps.
• recent-unwrapped: recent output with soft wraps joined; prefer it for logs and transcripts.
• detection: the plain-text bottom-buffer snapshot used for agent detection.

Use --format ansi when colors and terminal styling are evidence. Otherwise use text.

--lines asks ao for more rows from the pane's available screen and host scrollback. If increasing it does not reveal more of a completed response, the pane is probably running the agent on the terminal's alternate screen. Rows that leave the alternate screen do not enter ao's host scrollback, so a larger line count cannot recover them.

After that failed read, ask the agent to write its complete response as Markdown in a temporary directory and reply only with the file path, then read the file directly. Use this only as a fallback; do not request file output in the initial prompt.

Safety and coordination rules

• Use --no-focus for background work unless the user asked to switch context.
• Use --current, an explicit pane ID, or a unique agent name. Do not rely on another client's focused pane.
• Parse IDs from JSON responses. Do not derive them from sidebar order or examples.
• Do not close workspaces, tabs, panes, or sessions you did not create unless the user explicitly asked. workspace close --group closes the primary workspace and its linked worktree workspaces; never add it merely to bypass workspace_group_close_required.
• Use --trust-repository only after the user has verified the repository. It grants per-request Git trust; it is not a routine retry for a failed worktree command.
• Client and server versions can differ after an update. Check allternit-factory pane status before relying on new server features. A missing method is not permission to stop or upgrade a server.
• Never run allternit-factory pane server stop from an active session unless the user explicitly intends to stop the server and its pane processes.
• Never kill the main ao process. Use named test sessions for experiments that need an isolated server.
• CLI server errors are JSON on stderr with exit status 1. CLI syntax errors exit with status 2.