Skip to main content

corgi agent event

corgi agent event

Report one event from an agent that is not Claude Code, so it sits on the board

Synopsis

The board tracks Claude Code through its hooks. Another agent CLI joins the same board by calling this on its own events — from whatever hook, notify or plugin mechanism it has:

corgi agent event start --agent codex --session $ID corgi agent event prompt --agent codex --session $ID corgi agent event tool --agent codex --session $ID --tool shell --input '{"command":"go test ./..."}' corgi agent event permission --agent codex --session $ID --tool shell --input '{"command":"rm -rf build"}' corgi agent event stop --agent codex --session $ID corgi agent event end --agent codex --session $ID

Codex: in ~/.codex/config.toml set notify = ["corgi", "agent", "event", "stop", "--agent", "codex", "--notify"] and every finished turn lands on the board (Codex appends its JSON as the last argument; --notify reads the thread id, cwd and last message from it). Without --session the id is the calling process — fine for an agent that runs one conversation per process. With - the event is read from stdin as JSON ({session_id, cwd, tool_name, tool_input}), the shape Claude Code's hooks use. The session shows on every surface with the agent's name; a permission with a risk word colours Allow like any other. Never prints, never fails: the agent is unaffected whatever corgi's state is.

corgi agent event <start|prompt|tool|done|fail|permission|stop|end> [flags]

Options

--agent string The agent's name — codex, gemini, opencode — shown on the board
--cwd string The directory the session works in; default: the current one
-h, --help help for event
--input string The tool's input as JSON ({"command":…}, {"file_path":…}), or a bare command line
--message string A line to carry, for fail
--notify The last argument is Codex's notify JSON (thread-id, cwd, last-assistant-message)
--session string The agent's own session id; default: one per calling process
--stdin Read {session_id, cwd, tool_name, tool_input} from stdin, the shape Claude Code's hooks use
--tool string The tool, for tool, done, fail and permission

Options inherited from parent commands

--describe Describe contents of corgi-compose file
--dockerContext string Specify docker context to use, can be default,orbctl,colima (default "default")
-l, --exampleList List examples to choose from. Click on any example to download it
-f, --filename string Custom filepath for for corgi-compose
--fromScratch Clean the .corgi/corgi_services folder before running
-t, --fromTemplate string Create corgi service from template url
--fromTemplateName string Create corgi service from template name and url
-g, --global Use global path to one of the services
--interactive Force interactive prompts even when no TTY/agent detected
--isolate string Run this workspace under a named lease: own port block, own database names, own containers
--json Emit machine-readable JSON output
--privateToken string Private token for private repositories to download files
-o, --runOnce Run corgi once and exit
--silent Hide all welcome messages

SEE ALSO

  • corgi agent - Keep Claude Code Remote Control running for your corgi workspaces
Auto generated by spf13/cobra on 20-Sep-2026