aws / aws/amazon-q-developer-cli

bug: Documentation mismatch

Abierto
#3,201 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation q chat
Lenguaje dominante
Rust
Estrellas
2k
Forks
439
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

### Checks

- [x] I have searched [github.com/aws/amazon-q-developer-cli/issues](https://github.com/aws/amazon-q-developer-cli/issues?q=) and there are no duplicates of my issue
- [x] I have run `q doctor` in the affected terminal session
- [x] I have run `q restart` and replicated the issue again

### Operating system

Windows

### Expected behaviour

The documentation for [hooks-field](https://github.com/aws/amazon-q-developer-cli/blob/main/docs/agent-format.md#hooks-field) to match the documentation for [pretooluse](https://github.com/aws/amazon-q-developer-cli/blob/main/docs/hooks.md#pretooluse)

### Actual behaviour

[hooks-field](https://github.com/aws/amazon-q-developer-cli/blob/main/docs/agent-format.md#hooks-field) states the `preToolUse` should look like

```json
"preToolUse": [
{
"matcher": "execute_bash",
"command": "{ echo \"$(date) - Bash command:\"; cat; echo; } >> /tmp/bash_audit_log"
},
{
"matcher": "use_aws",
"command": "{ echo \"$(date) - AWS CLI call:\"; cat; echo; } >> /tmp/aws_audit_log"
}
],
```

but the [pretooluse](https://github.com/aws/amazon-q-developer-cli/blob/main/docs/hooks.md#pretooluse) shows

```json
{
"hook_event_name": "preToolUse",
"cwd": "/current/working/directory",
"tool_name": "fs_read",
"tool_input": {
"operations": [
{
"mode": "Line",
"path": "/current/working/directory/docs/hooks.md"
}
]
}
}
```

It's a bit confusing. Where is the "command" and the "matcher"?

### Steps to reproduce

_No response_

### Environment

```yaml

```

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Lee docs/agent-format.md en la sección hooks-field y docs/hooks.md en la sección preToolUse; después, compara cómo describe cada una la entrada y la configuración del hook. Alinea ambas secciones para que command, matcher y event payload se describan de forma coherente y la documentación deje de presentar ejemplos contradictorios.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
cli, documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.