Integrations
Herdr detects supported agents automatically. Official integrations can add native session identity for restore, lifecycle state reports, or both.
Use integrations when you want native agent session restore, direct lifecycle reports from Pi/OMP/Copilot/OpenCode/Kilo/Hermes-style hooks or plugins, or both. See Agents for the full status authority model.
Install integrations
Section titled “Install integrations”Open settings inside Herdr and use the integrations tab to install recommended integrations for agents found on your PATH, or run commands manually:
herdr integration install piherdr integration install ompherdr integration install claudeherdr integration install codexherdr integration install copilotherdr integration install droidherdr integration install kimiherdr integration install opencodeherdr integration install kiloherdr integration install hermesherdr integration install qodercliherdr integration install cursorUninstall integrations
Section titled “Uninstall integrations”herdr integration uninstall piherdr integration uninstall ompherdr integration uninstall claudeherdr integration uninstall codexherdr integration uninstall copilotherdr integration uninstall droidherdr integration uninstall kimiherdr integration uninstall opencodeherdr integration uninstall kiloherdr integration uninstall hermesherdr integration uninstall qodercliherdr integration uninstall cursorHow Herdr uses integrations
Section titled “How Herdr uses integrations”Herdr uses integrations in two different ways:
| Integration type | Agents | Effect |
|---|---|---|
| Lifecycle authority | Pi, OMP, Kimi Code CLI, OpenCode, Kilo Code CLI, Hermes Agent | When installed and actively reporting for the pane, hook or plugin events author idle, working, and blocked. Herdr does not also use screen manifest fallback for that same lifecycle authority. |
| Session identity | Claude Code, Codex, GitHub Copilot CLI, Droid, Qoder CLI, Cursor Agent CLI | The integration reports native session references for restore. State still comes from Herdr’s screen manifest detection. |
Custom socket integrations can also report state when they define state that is not visible in the native terminal UI.
Some integrations report native agent session references. Herdr uses official session references to resume Claude Code, Codex, Droid, Kimi Code CLI, Qoder CLI, Cursor Agent CLI, GitHub Copilot CLI, Pi, Hermes Agent, OpenCode, and Kilo Code CLI panes after a Herdr server restart unless [session] resume_agents_on_restore = false disables it.
Native session restore requires current Herdr integrations: Pi integration version 2, Claude Code version 5, Codex version 5, GitHub Copilot CLI version 2, Droid version 2, Kimi Code CLI version 3, Qoder CLI version 2, Cursor Agent CLI version 1, OpenCode version 5, Kilo Code CLI version 1, or Hermes Agent version 2. OMP integration version 2 reports agent state only. Check installed versions with herdr integration status.
Install the Pi integration:
herdr integration install piHerdr writes the bundled extension to:
~/.pi/agent/extensions/herdr-agent-state.tsIf PI_CODING_AGENT_DIR is set, Herdr writes to $PI_CODING_AGENT_DIR/extensions/herdr-agent-state.ts instead. The extensions directory must already exist. Uninstall removes only that extension file.
Install the OMP integration:
herdr integration install ompHerdr writes the bundled extension to:
~/.omp/agent/extensions/herdr-omp-agent-state.tsIf PI_CODING_AGENT_DIR is set, Herdr writes to $PI_CODING_AGENT_DIR/extensions/herdr-omp-agent-state.ts instead. The extensions directory must already exist. Uninstall removes only that extension file.
The OMP integration reports omp as the agent label through Herdr’s socket API. It does not require native process detection for the omp executable.
Claude Code
Section titled “Claude Code”Install the Claude Code hook:
herdr integration install claudeThe hook reports Claude Code session identity to the local Herdr socket on session start. Claude Code state comes from Herdr’s screen manifest detection.
Herdr uses ~/.claude by default, or CLAUDE_CONFIG_DIR when set. The Claude config directory must already exist. Install writes hooks/herdr-agent-state.sh and updates settings.json with Herdr hook entries. Uninstall removes the matching hook entries and deletes the hook script.
Install the Codex hook:
herdr integration install codexThe Codex hook reports session identity through the same local socket API used by other integrations. Codex state comes from Herdr’s screen manifest detection.
Herdr uses ~/.codex by default, or CODEX_HOME when set. The Codex config directory must already exist. Install writes herdr-agent-state.sh, updates hooks.json, and ensures [features] hooks = true in config.toml. It also removes the deprecated top-level codex_hooks flag when present. Uninstall removes Herdr entries from hooks.json and deletes the hook script, but leaves config.toml unchanged.
GitHub Copilot CLI
Section titled “GitHub Copilot CLI”Install the GitHub Copilot CLI hook:
herdr integration install copilotThe Copilot hook reports session identity through the same local socket API used by other integrations. Copilot state comes from Herdr’s screen manifest detection.
Herdr uses ~/.copilot by default, or COPILOT_HOME when set. The Copilot config directory must already exist. Install writes hooks/herdr-agent-state.sh and updates settings.json with a SessionStart hook entry. Uninstall removes Herdr entries from settings.json and deletes the hook script.
After Copilot emits a session-bearing event, Herdr can use the reported session id to resume the pane with copilot --resume=<id>.
Kimi Code CLI
Section titled “Kimi Code CLI”Install the Kimi Code CLI hook:
herdr integration install kimiThe hook reports Kimi session identity and lifecycle state to Herdr for native restore and authoritative idle, working, and blocked status. It requires Kimi Code CLI 0.14.0 or newer.
Herdr uses ~/.kimi-code by default, or KIMI_CODE_HOME when set. The Kimi Code config directory must already exist. Install writes hooks/herdr-agent-state.sh and appends Herdr-managed [[hooks]] entries to config.toml. Uninstall removes the Herdr-managed config block and deletes the hook script.
Herdr resumes stored Kimi sessions with kimi --session <id>.
Install the Droid hook:
herdr integration install droidThe Droid hook reports session identity through the same local socket API used by other integrations. Lifecycle state still comes from Herdr’s screen manifest detection because Droid hooks do not cover every lifecycle transition.
Herdr uses ~/.factory for Droid hooks. The Factory config directory must already exist. Install writes hooks/herdr-agent-state.sh, updates settings.json with a Herdr SessionStart hook entry, and removes older Herdr Droid hook entries from hooks.json if present. Uninstall removes Herdr entries from both config files and deletes the hook script.
After Droid emits a session start event, Herdr can use the reported session id to resume the pane with droid --resume <id>.
OpenCode
Section titled “OpenCode”Install the OpenCode plugin:
herdr integration install opencodeHerdr writes the plugin to ~/.config/opencode/plugins/herdr-agent-state.js. The OpenCode config directory must already exist. Uninstall removes only that plugin file.
The plugin reports lifecycle state and session identity while OpenCode runs inside a Herdr pane. After OpenCode emits a session-bearing event, Herdr can use the reported session id to resume the pane with opencode --session <id>. Native screen manifest detection remains available when the plugin is not installed.
Kilo Code CLI
Section titled “Kilo Code CLI”Install the Kilo Code CLI plugin:
herdr integration install kiloHerdr writes the plugin to ~/.config/kilo/plugin/herdr-agent-state.js. The Kilo config directory must already exist. Uninstall removes only that plugin file.
The plugin reports lifecycle state and session identity while Kilo runs inside a Herdr pane. After Kilo emits a session-bearing event, Herdr can use the reported session id to resume the pane with kilo --session <id>. Native screen manifest detection remains available when the plugin is not installed.
Hermes Agent
Section titled “Hermes Agent”Install the Hermes Agent plugin:
herdr integration install hermesHerdr writes ~/.hermes/plugins/herdr-agent-state/ and enables herdr-agent-state in ~/.hermes/config.yaml. The Hermes config directory must already exist. Restart Hermes after installing so the plugin loads. Uninstall removes the plugin directory and removes herdr-agent-state from plugins.enabled.
The plugin reports lifecycle, tool, approval state, and session id while Hermes runs inside a Herdr pane. Herdr can use the reported session id to resume the pane with hermes --resume <id>. Native screen manifest detection remains available when the plugin is not installed.
Qoder CLI
Section titled “Qoder CLI”Install the Qoder CLI hook:
herdr integration install qodercliThe hook reports Qoder CLI session identity to Herdr for native restore. Lifecycle state still comes from Herdr’s screen manifest detection because Qoder hooks do not cover every lifecycle transition.
Herdr uses ~/.qoder by default, or QODER_CONFIG_DIR when set. The Qoder config directory must already exist. Install writes hooks/herdr-agent-state.sh and updates settings.json with Herdr hook entries. Uninstall removes the matching hook entries and deletes the hook script.
Herdr resumes stored Qoder CLI sessions with qodercli --resume <id>.
Native screen manifest detection remains available when the hook is not installed.
Cursor Agent CLI
Section titled “Cursor Agent CLI”Install the Cursor Agent CLI hook:
herdr integration install cursorThe hook reports session identity through Cursor’s sessionStart hook while Cursor Agent CLI runs inside a Herdr pane. Cursor state comes from Herdr’s screen manifest detection.
Herdr uses ~/.cursor by default, or CURSOR_CONFIG_DIR when set. The Cursor config directory must already exist. Install writes herdr-agent-state.sh and adds a Herdr sessionStart entry to hooks.json. Uninstall removes the matching hook entry and deletes the hook script.
After Cursor emits a session start event, Herdr can use the reported session id to resume the pane with cursor-agent --resume <id>. The cursor-agent command must be on PATH when Herdr restores the pane; Herdr does not launch the generic agent command.
Custom status labels
Section titled “Custom status labels”Integrations can report a short visual label without changing the semantic state.
For example, an agent can remain semantically working while showing indexing in the UI.
herdr pane report-agent 1-1 \ --source custom:docs \ --agent docs-bot \ --state working \ --custom-status indexingUser hooks that run next to a Herdr-managed integration should use metadata instead of report-agent. Metadata changes presentation without taking over the integration’s idle, working, blocked, or session restore authority. --agent guards the report so it only applies while that authoritative agent is active. --applies-to-source guards the report so it only applies while that lifecycle authority source is active. --display-agent changes the visible name.
herdr pane report-metadata "$HERDR_PANE_ID" \ --source user:claude-title \ --agent claude \ --title "Refactor auth middleware" \ --display-agent "Claude: auth" \ --custom-status "refactor auth" \ --state-label working="refactoring auth" \ --ttl-ms 3600000Custom status and state labels are visual-only. Waits, notifications, and workspace rollups still use the semantic state.
Debug integration state
Section titled “Debug integration state”List known agents:
herdr agent listRead a pane when you need to verify what Herdr can see:
herdr pane read 1-1 --source recent --lines 50If integration state looks wrong, first confirm the agent is running inside Herdr and that the relevant hook or plugin was installed for the same user account.