Connect coding assistants

Install native agent hooks, understand adapter coverage, and verify a real captured event.

On this page

Beam's adapters translate each assistant's hook payload into a common event shape. Hook installation merges Beam's entry into the assistant's own configuration. Existing hooks are preserved, and repeating installation does not intentionally add a duplicate entry.

Choose an adapter

Agent IDHook configurationCoverage
claude-code~/.claude/settings.json, PreToolUseVerified payload adapter; policy deny output wired
codex~/.codex/hooks.json, PreToolUseVerified payload adapter; policy deny output wired
cursor~/.cursor/hooks.json, preToolUseVerified payload adapter; blocking response not wired
copilot-cli~/.copilot/hooks/beam.json, preToolUseCamelCase payload translated; blocking response not wired
gemini~/.gemini/settings.json, BeforeToolBest-effort payload adapter; not verified
opencodeConfig/artifact discoveryHook installation not implemented

Check beam agent list for the installed release's supported IDs. Adapter status is not proof that a particular assistant version is invoking the hook correctly on your machine.

Install the hooks

Code
beam agent install claude-code
beam agent install codex

To discover and wire all supported installed assistants:

Code
beam agent install-all

Detection uses the assistant's existing files, not files Beam creates itself. Review errors per agent; malformed existing configuration should be repaired deliberately instead of overwritten.

Verify capture

Start the collector and reopen or refresh the assistant according to its configuration-loading behavior. Run a harmless tool action and inspect it in Studio. Confirm the source agent, tool name, and phase rather than relying only on an “installed” message.

Beam must be on the assistant process's PATH. A desktop-launched application may inherit a different PATH from your terminal. Use a reviewed absolute executable path in the hook configuration when necessary.

Understand event phase and enforcement

A PreToolUse hook records a proposed action. Historical extraction records observed transcript entries. Neither a finding nor a captured proposal establishes an effect on the filesystem or network.

In observe mode, capture failures are reported without intentionally blocking the calling assistant. With an active workspace policy, Claude Code and Codex can receive a deny response before local capture. Other agents receive a stderr note for a deny decision. See policies for fail-open and compatibility limits.

Explore the docs