docs(cli): add hooks guide for event interception#11168
docs(cli): add hooks guide for event interception#11168siewcapital wants to merge 6 commits intocontinuedev:mainfrom
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
There was a problem hiding this comment.
2 issues found across 4 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/cli/hooks.mdx">
<violation number="1" location="docs/cli/hooks.mdx:152">
P2: Docs overstate sync hook awaiting semantics; `SessionStart` is mode-dependent (non-blocking in interactive startup, awaited in headless mode).</violation>
</file>
<file name="docs/cli/tool-permissions.mdx">
<violation number="1" location="docs/cli/tool-permissions.mdx:31">
P2: Docs introduce ambiguous headless behavior for `AskQuestion`: it is documented as default `allow` and user-interactive, but headless docs only exclude `ask` tools and do not define what happens for this prompting tool.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
RomneyDa
left a comment
There was a problem hiding this comment.
@siewcapital thanks for the contribution. Looks like the AskQuestion docs from another PR leaked into this one, could you remove?
See comments.
docs/cli/hooks.mdx
Outdated
|
|
||
| Continue currently supports the following event names: | ||
|
|
||
| - `PreToolUse` |
There was a problem hiding this comment.
would include brief description with each hook
There was a problem hiding this comment.
Updated the PR to keep it focused on hooks docs. I removed the unrelated AskQuestion docs changes from the branch and added brief descriptions for each hook event in docs/cli/hooks.mdx, along with a clarification on SessionStart sync behavior.
Summary
docs/cli/hooks.mdxguide for the CLI hooks system.continueand.claudesettingsWhy
The hooks feature introduced in #11029 is tier-1 functionality, but there was no end-to-end user documentation for setup and behavior.
Validation
npm --prefix docs run buildcurrently fails in this environment becausemintlifyis not installed (sh: mintlify: command not found)Closes #11152
Summary by cubic
Adds a dedicated CLI Hooks guide and updates TUI and permissions docs to cover hook behavior and the
AskQuestiontool. This completes end-to-end hooks documentation and meets #11152.docs/cli/hooks.mdx: config precedence across.claude/.continue, supported events, regex matchers, command/HTTP handlers, exit/blocking semantics, sync vs async, env vars, disable-all, examples.docs/cli/tool-permissions.mdx: expanded read-only defaults (AskQuestion,Checklist,Status,CheckBackgroundJob,ReportFailure,UploadArtifact) and clarifiedAskQuestionas a read-only clarification tool.docs/cli/tui-mode.mdx: more slash commands, how interactiveAskQuestionprompts work, and read-only tools list now includesDiffandAskQuestion.Written for commit 982a928. Summary will update on new commits.