Documentation Index
Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt
Use this file to discover all available pages before exploring further.
Cada evento de hook é acionado em um ponto específico do ciclo de vida do agente. Use o campo matcher (uma regex aplicada ao tool_name do evento de hook) para filtrar quais invocações de ferramenta acionam seu hook.
É acionado antes de uma ferramenta ser executada. Use isso para bloquear, modificar ou adicionar contexto às chamadas de ferramentas.
Dados de stdin:
| Campo | Descrição | Exemplo |
|---|
tool_name | Nome da ferramenta sendo chamada | exec, edit, mcp__github__create_issue |
tool_input | Argumentos passados para a ferramenta | { "command": "rm -rf /", "shell_id": "main" } |
{
"PreToolUse": [
{
"matcher": "exec",
"hooks": [
{
"type": "command",
"command": "python3 -c \"import sys, json; data = json.load(sys.stdin); cmd = data.get('tool_input', {}).get('command', ''); sys.exit(2 if 'rm -rf' in cmd else 0)\""
}
]
}
]
}
{
"PreToolUse": [
{
"matcher": "edit",
"hooks": [
{
"type": "command",
"command": "./scripts/check-edit-path.sh",
"timeout": 5
}
]
}
]
}
É acionado após a execução de uma ferramenta. Use isso para logging, validação ou para acionar ações subsequentes.
Dados de stdin:
| Campo | Descrição |
|---|
tool_name | Nome da ferramenta executada |
tool_input | Argumentos que foram passados |
tool_response | Objeto com success (boolean), output (string) e error (string ou null) |
{
"PostToolUse": [
{
"matcher": "exec",
"hooks": [
{
"type": "command",
"command": "sh -c 'cat >> ~/.devin-command-log'"
}
]
}
]
}
É acionado quando o agente precisa de uma decisão sobre permissão. Use isso para implementar uma lógica de aprovação personalizada.
Dados de stdin:
| Campo | Descrição |
|---|
tool_name | Ferramenta que está solicitando permissão |
tool_input | Argumentos da chamada da ferramenta |
{
"PermissionRequest": [
{
"matcher": "exec",
"hooks": [
{
"type": "command",
"command": "python3 -c \"import sys, json; data = json.load(sys.stdin); cmd = data.get('tool_input', {}).get('command', ''); print(json.dumps({'decision': 'approve'})) if cmd.startswith('git ') else sys.exit(0)\""
}
]
}
]
}
É acionado quando o usuário envia uma mensagem. Use isto para adicionar contexto ou acionar workflows.
Dados de stdin:
| Campo | Descrição |
|---|
prompt | O texto da mensagem do usuário |
{
"UserPromptSubmit": [
{
"matcher": "",
"hooks": [
{
"type": "command",
"command": "./scripts/add-deploy-context.sh"
}
]
}
]
}
É acionado quando o agente decide parar (encerrar seu turno). Use isso para adicionar instruções adicionais ou evitar que ele pare cedo demais.
Dados de stdin:
| Campo | Descrição |
|---|
stop_hook_active | Indica se um hook de parada já está ativo |
{
"Stop": [
{
"matcher": "",
"hooks": [
{
"type": "command",
"command": "echo '{\"decision\": \"block\", \"reason\": \"Please run the test suite before stopping.\"}'"
}
]
}
]
}
Tenha cuidado com hooks de parada que bloqueiam — eles podem fazer o agente entrar em loop se a condição não acabar sendo atendida.
É acionado após a compactação de contexto ser concluída com sucesso. Use isso para registrar em log, acionar ações subsequentes ou reinjetar contexto que possa ter sido perdido durante a compactação.
Dados de stdin:
| Campo | Descrição |
|---|
summary | Texto de resumo produzido pelo compactador (pode ser nulo se nenhum resumo tiver sido gerado) |
{
"PostCompaction": [
{
"matcher": "",
"hooks": [
{
"type": "command",
"command": "sh -c 'cat >> ~/.devin-compaction-log'"
}
]
}
]
}
É acionado quando uma nova sessão é iniciada. Use-o para inicialização, registro em log ou configuração do ambiente.
Dados de stdin:
| Campo | Descrição |
|---|
source | Como a sessão foi iniciada |
{
"SessionStart": [
{
"matcher": "",
"hooks": [
{
"type": "command",
"command": "./scripts/dev-setup.sh",
"timeout": 10
}
]
}
]
}
Ocorre quando uma sessão termina. Use este evento para limpeza ou registro final.
Dados de stdin:
| Campo | Descrição |
|---|
reason | Motivo do encerramento da sessão |
Um único arquivo de hooks pode definir hooks para vários eventos:
{
"PreToolUse": [
{
"matcher": "",
"hooks": [
{ "type": "command", "command": "./scripts/audit.sh" }
]
}
],
"PostToolUse": [
{
"matcher": "",
"hooks": [
{ "type": "command", "command": "./scripts/audit.sh" }
]
}
]
}
matcher é uma regex aplicada ao tool_name do evento do hook. Ele está disponível para eventos relacionados a ferramentas: PreToolUse, PostToolUse e PermissionRequest.
Para eventos que não envolvem ferramentas (UserPromptSubmit, Stop, PostCompaction, SessionStart e SessionEnd), não há tool_name; use "" ou omita o matcher para executar o hook em todos os eventos desse tipo.
O matcher não é um glob de permissão. Padrões como mcp__github__* são úteis em permissões, mas matchers de hook são regexes. Use mcp__github__.* em um matcher de hook.
| Matcher | Corresponde a |
|---|
"" (vazio) ou omitido | Todos os nomes de ferramentas em eventos de ferramenta |
"exec" | Nomes de ferramentas que contêm exec |
"^exec$" | Apenas a ferramenta exec |
"^(exec|edit)$" | Apenas exec ou edit |
"^mcp__.*" | Todas as ferramentas MCP |
"^mcp__github__.*" | Todas as ferramentas do servidor MCP github |
"^mcp__github__create_issue$" | A ferramenta create_issue do servidor MCP github |
tool_name. Os nomes exatos de ferramentas disponíveis podem variar conforme o modo da CLI, o modelo e as integrações ativadas.
Os nomes públicos mais comuns das ferramentas principais são:
As ferramentas de servidor MCP aparecem como mcp__<server>__<tool>. Por exemplo, uma ferramenta de servidor MCP github chamada create_issue aparece como mcp__github__create_issue.
Para outras ferramentas, faça correspondência com o tool_name exato mostrado no stdin do hook. Para confirmar o conjunto completo disponível na sua sessão atual, adicione temporariamente um hook PostToolUse com matcher: "" e registre o payload do stdin.