diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:06:43 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:08:00 +0300 |
| commit | ee6a8f9411a3d8f0105ed5d793bc44dafcd9ce2b (patch) | |
| tree | a1c5fb333e701261160fd37f144e3b8a0c3fefa1 /docs/next/INTEGRATIONS.md | |
| parent | c5e1a20ad30f400a951abe154385d8f5931bebf3 (diff) | |
docs: move public references to website docs
Diffstat (limited to 'docs/next/INTEGRATIONS.md')
| -rw-r--r-- | docs/next/INTEGRATIONS.md | 284 |
1 files changed, 0 insertions, 284 deletions
diff --git a/docs/next/INTEGRATIONS.md b/docs/next/INTEGRATIONS.md deleted file mode 100644 index fc47bbc0..00000000 --- a/docs/next/INTEGRATIONS.md +++ /dev/null @@ -1,284 +0,0 @@ -# integrations - -herdr works without any hook or plugin setup. - -out of the box, it detects supported agents automatically by combining foreground process detection with screen heuristics. that is enough to give you workspace awareness with zero configuration. - -when an agent exposes hooks or plugins, the more robust path is to forward semantic state to herdr over the local socket api. the built-in integrations in this document do exactly that. - -if you want to inspect the exact files herdr installs, they are versioned in this repo: - -- [pi extension](./src/integration/assets/pi/herdr-agent-state.ts) -- [claude code hook](./src/integration/assets/claude/herdr-agent-state.sh) -- [codex hook](./src/integration/assets/codex/herdr-agent-state.sh) -- [opencode plugin](./src/integration/assets/opencode/herdr-agent-state.js) -- [hermes plugin](./src/integration/assets/hermes/__init__.py) - -## how herdr uses integrations - -herdr uses a hybrid model: - -- **process detection** owns pane identity, liveness, and "the process is gone" -- **agent integrations** report semantic state like `working`, `blocked`, and `idle` over the local socket api when the tool exposes those events -- **screen heuristics** remain the fallback for gaps, unsupported tools, or incomplete hook surfaces - -that means hooks/plugins do **not** become the source of truth for pane ownership. they enrich state reporting; they do not replace process detection. - -## install commands - -```bash -herdr integration install pi -herdr integration install claude -herdr integration install codex -herdr integration install opencode -herdr integration install hermes -``` - -## uninstall commands - -```bash -herdr integration uninstall pi -herdr integration uninstall claude -herdr integration uninstall codex -herdr integration uninstall opencode -herdr integration uninstall hermes -``` - -## pi - -install: - -```bash -herdr integration install pi -``` - -this writes the bundled pi extension to: - -```text -~/.pi/agent/extensions/herdr-agent-state.ts -``` - -if `PI_CODING_AGENT_DIR` is set, herdr uses that agent directory instead and writes to: - -```text -$PI_CODING_AGENT_DIR/extensions/herdr-agent-state.ts -``` - -`~` is expanded in `PI_CODING_AGENT_DIR`. - -pi is the cleanest integration. it already has an authoritative hook model, so herdr can get direct state reports over the socket api without guessing as much from the terminal. - -bundled source: [`src/integration/assets/pi/herdr-agent-state.ts`](./src/integration/assets/pi/herdr-agent-state.ts) - -uninstall: - -```bash -herdr integration uninstall pi -``` - -this removes the same extension path herdr would install, using `PI_CODING_AGENT_DIR` when it is set. - -## claude code - -install: - -```bash -herdr integration install claude -``` - -this: - -- writes the hook script to `~/.claude/hooks/herdr-agent-state.sh` -- updates `~/.claude/settings.json` - -if `CLAUDE_CONFIG_DIR` is set, herdr uses that directory instead, for example `$CLAUDE_CONFIG_DIR/hooks/herdr-agent-state.sh` and `$CLAUDE_CONFIG_DIR/settings.json`. `~` is expanded in `CLAUDE_CONFIG_DIR`. - -bundled source: [`src/integration/assets/claude/herdr-agent-state.sh`](./src/integration/assets/claude/herdr-agent-state.sh) - -current hook mapping: - -- `UserPromptSubmit` → `working` -- `PreToolUse` → `working` -- `PermissionRequest` → `blocked` -- `PostToolUse` → `working` -- `PostToolUseFailure` → `working` -- `SubagentStop` → `working` -- `Stop` → `idle` -- `SessionEnd` → `release` - -notes: - -- claude code hooks also run inside subagents. herdr treats subagent `working` and `blocked` reports as real pane state. -- subagent stop/release events are converted to `working` by the bundled hook script so a completed subagent does not make the parent claude pane look idle. -- `PostToolUse` and `PostToolUseFailure` move the pane back to `working` after a permissioned tool call resolves. -- some non-claude tools, including grok cli, may load claude settings or plugins. herdr ignores conflicting known-agent hook labels once native foreground-process detection identifies a different known agent. - -uninstall: - -```bash -herdr integration uninstall claude -``` - -this removes the same hook path and settings entries herdr would install, using `CLAUDE_CONFIG_DIR` when it is set. - -## codex - -install: - -```bash -herdr integration install codex -``` - -this: - -- writes the hook script to `~/.codex/herdr-agent-state.sh` -- updates `~/.codex/hooks.json` -- ensures `hooks = true` under `[features]` in `~/.codex/config.toml` -- migrates the deprecated top-level `[features] codex_hooks = true` setting to `hooks = true` - -if `CODEX_HOME` is set, herdr uses that directory instead, for example `$CODEX_HOME/herdr-agent-state.sh`, `$CODEX_HOME/hooks.json`, and `$CODEX_HOME/config.toml`. `~` is expanded in `CODEX_HOME`. - -bundled source: [`src/integration/assets/codex/herdr-agent-state.sh`](./src/integration/assets/codex/herdr-agent-state.sh) - -current hook mapping: - -- `SessionStart` → `idle` -- `UserPromptSubmit` → `working` -- `PreToolUse` → `working` -- `Stop` → `idle` - -notes: - -- codex does **not** currently expose a permission-specific hook like claude or opencode, so `blocked` still depends on herdr's normal heuristics. -- codex currently renders hook lifecycle messages in its own tui, for example `Running SessionStart hook` and `SessionStart hook (completed)`. -- that noise is an upstream codex limitation, not a herdr-specific issue. -- codex has a `suppressOutput` field in its hook output schema, but it is currently not effective for suppressing those tui lifecycle lines. - -uninstall: - -```bash -herdr integration uninstall codex -``` - -this: - -- removes the same hook path herdr would install, using `CODEX_HOME` when it is set -- removes herdr-owned hook entries from the matching `hooks.json` -- intentionally leaves the matching `config.toml` alone - -that last point is deliberate: herdr does **not** try to guess whether `hooks = true` is still needed for some other codex hook setup. - -## opencode - -install: - -```bash -herdr integration install opencode -``` - -this writes the bundled plugin to: - -```text -~/.config/opencode/plugins/herdr-agent-state.js -``` - -bundled source: [`src/integration/assets/opencode/herdr-agent-state.js`](./src/integration/assets/opencode/herdr-agent-state.js) - -current plugin mapping: - -- `permission.asked` → `blocked` -- `permission.replied: once|always` → `working` -- `permission.replied: reject` → `idle` -- `question.asked` → `blocked` -- `question.replied` → `working` -- `question.rejected` → `idle` -- `session.status: busy|retry` → `working` -- `session.status: idle` → `idle` -- `session.idle` → `idle` - -notes: - -- opencode has the richest event surface of the currently supported integrations. -- herdr intentionally does **not** guess that `session.deleted` means process exit. process detection still owns liveness and pane identity. - -uninstall: - -```bash -herdr integration uninstall opencode -``` - -this removes: - -```text -~/.config/opencode/plugins/herdr-agent-state.js -``` - -## hermes agent - -install: - -```bash -herdr integration install hermes -``` - -this: - -- writes the bundled plugin to `~/.hermes/plugins/herdr-agent-state/` -- updates `~/.hermes/config.yaml` so `plugins.enabled` contains `herdr-agent-state` - -bundled source: [`src/integration/assets/hermes/__init__.py`](./src/integration/assets/hermes/__init__.py) - -current plugin mapping: - -- `on_session_start` → `idle` -- `pre_llm_call` → `working` -- `pre_api_request` → `working` -- `pre_tool_call` → `working` -- `post_tool_call` → `working` -- `pre_approval_request` → `blocked` -- `post_approval_response` → `working` -- `post_llm_call` → `idle` -- `on_session_end` → `idle` -- `on_session_finalize` → `release` - -notes: - -- hermes plugins are opt-in, so install also enables the plugin in `config.yaml`. -- herdr still keeps native process detection and screen heuristics for hermes. the plugin improves state accuracy when the hook surface fires. - -uninstall: - -```bash -herdr integration uninstall hermes -``` - -this removes `~/.hermes/plugins/herdr-agent-state/` and removes the matching `plugins.enabled` entry from `~/.hermes/config.yaml`. - -## grok cli - -herdr does not currently install a grok hook or plugin. - -grok is heuristic-only in herdr. herdr detects `grok` and `grok-build` from the foreground process and uses screen heuristics for `working`, `blocked`, and `idle` states. - -grok cli may load claude settings or plugins as a compatibility feature, including hooks from `~/.claude/settings.json`. if that causes the claude herdr hook to run in a grok pane, herdr ignores the conflicting `claude` hook label once native foreground-process detection identifies the pane as `grok`. - -## amp - -herdr does not currently install an Amp plugin. - -Amp's public plugin API exposes lifecycle and tool-call hooks, but not passive permission/request-blocked events. A Herdr Amp plugin that only reports `idle` and `working` would take hook authority for the pane and mask Herdr's existing screen heuristics for Amp `blocked` states. Until Amp exposes permission state as an observable plugin event, Amp remains heuristic-only in Herdr. - -## known limitations - -- these integrations only activate inside herdr-managed panes. -- if an agent has an incomplete hook surface, herdr falls back to process detection and screen heuristics rather than inventing lease or ttl behavior. -- codex currently shows hook lifecycle chatter in its own tui until upstream adds a real silent mode. - -## troubleshooting - -if an install command succeeds but you do not see improved state reporting: - -1. make sure you launched the agent inside a herdr pane -2. restart the agent session so it picks up the new hook/plugin config -3. verify the expected config file was written to the path above -4. remember that unsupported transitions still fall back to herdr's built-in heuristics |
