MCPcopy Create free account
hub / github.com/atomicdotdev/atomic / AgentHook

Interface AgentHook

atomic-agent/src/hooks/mod.rs:152–285  ·  view source on GitHub ↗

Trait for agent hook adapters. Each AI coding agent (Claude Code, Gemini CLI, Codex, OpenCode) implements this trait to: 1. **Parse** agent-specific JSON from stdin into a common [`TurnEvent`] 2. **Install** hooks into the agent's configuration file 3. **Uninstall** hooks from the agent's configuration file 4. **Detect** whether hooks are currently installed Implementations must be `Send + Sync

Source from the content-addressed store, hash-verified

150/// can return `Ok(0)` / `Ok(())` for agents that don't support hook
151/// installation (e.g., agents detected via file watching instead).
152pub trait AgentHook: Send + Sync + fmt::Debug {
153 /// Returns the registry key for this agent.
154 ///
155 /// This is the string used in CLI commands:
156 /// `atomic agent enable --agent <name>`
157 /// `atomic agent hooks <name> <verb>`
158 ///
159 /// Convention: lowercase with hyphens (e.g., "claude-code", "gemini-cli").
160 fn name(&self) -> &str;
161
162 /// Returns a human-readable display name.
163 ///
164 /// Used in UI output and log messages (e.g., "Claude Code", "Gemini CLI").
165 fn display_name(&self) -> &str;
166
167 /// Parse hook input from an agent callback into a normalized [`TurnEvent`].
168 ///
169 /// The `input` parameter is the raw bytes read from stdin when the agent
170 /// invokes the hook. Each agent sends a different JSON format.
171 /// Preserve supplied source time using the adapter's explicit wire encoding;
172 /// use receipt time only when the timestamp is missing/null. Do not derive
173 /// event time from tool arguments, transcripts, or timestamp magnitude.
174 ///
175 /// # Arguments
176 ///
177 /// * `hook_type` - The type of lifecycle event (from the CLI verb)
178 /// * `input` - Raw bytes from stdin (typically JSON)
179 ///
180 /// # Errors
181 ///
182 /// Returns [`AgentError::HookParseFailed`] if the input cannot be parsed,
183 /// or [`AgentError::HookInputEmpty`] if `input` is empty.
184 fn parse_event(&self, hook_type: HookType, input: &[u8]) -> AgentResult<TurnEvent>;
185
186 /// Install hooks into the agent's configuration file.
187 ///
188 /// This writes entries into the agent's settings file (e.g.,
189 /// `.claude/settings.json`) that call back to `atomic agent hooks`.
190 ///
191 /// # Arguments
192 ///
193 /// * `repo_root` - The repository root directory (where `.atomic/` lives)
194 ///
195 /// # Returns
196 ///
197 /// The number of hooks that were installed. Returns 0 if all hooks
198 /// were already present.
199 ///
200 /// # Errors
201 ///
202 /// Returns [`AgentError::ConfigError`] if the config file cannot be
203 /// read or written.
204 fn install(&self, repo_root: &Path) -> AgentResult<usize>;
205
206 /// Remove hooks from the agent's configuration file.
207 ///
208 /// Removes only hooks with the `atomic agent hooks` prefix — other
209 /// hooks in the agent's config are preserved.

Callers

nothing calls this directly

Implementers 15

gemini_cli.rsatomic-agent/src/hooks/gemini_cli.rs
mod.rsatomic-agent/src/hooks/mod.rs
copilot.rsatomic-agent/src/hooks/copilot.rs
cline.rsatomic-agent/src/hooks/cline.rs
hermes.rsatomic-agent/src/hooks/hermes.rs
codex.rsatomic-agent/src/hooks/codex.rs
pi.rsatomic-agent/src/hooks/pi.rs
agy.rsatomic-agent/src/hooks/agy.rs
kiro.rsatomic-agent/src/hooks/kiro.rs
kilo.rsatomic-agent/src/hooks/kilo.rs
opencode.rsatomic-agent/src/hooks/opencode.rs
grok.rsatomic-agent/src/hooks/grok.rs

Calls

no outgoing calls

Tested by

no test coverage detected