Structs§
- Tool
Hook Config - A tool hook configuration for a specific AI coding tool.
Enums§
- Hook
Platform - Which AI tool platform is invoking the hook. Each platform has a different JSON output format.
- Hook
Scope - Install
Scope - Where hooks should be written.
- Tool
Filter - Which tools
sqz initshould configure.
Constants§
- SUPPORTED_
TOOL_ NAMES - Every canonical tool name sqz knows about, in the same order
generate_hook_configsemits them. Used by the CLI to list valid options in--only/--skiperror messages, and by tests that need to enumerate the supported set.
Functions§
- canonicalize_
tool_ name - Normalise a tool name or alias to its canonical form.
- claude_
user_ settings_ path - Resolve
~/.claude/settings.jsonfor the current user. - generate_
hook_ configs - Generate hook configuration files for all supported AI tools.
- install_
tool_ hooks - Install hook configs for detected AI tools in the given project directory.
- install_
tool_ hooks_ scoped - Like
install_tool_hooksbut lets the caller choose between project-local and user-global scope. This is the functionsqz initandsqz init --globalboth call. - install_
tool_ hooks_ scoped_ filtered - Like
install_tool_hooks_scopedbut honours aToolFilterso callers can restrictsqz initto a subset of the supported tools. - parse_
tool_ list - Parse a user-supplied tool list (comma-separated, whitespace-tolerant) into a vector of canonical names.
- process_
hook - Process a PreToolUse hook invocation from an AI tool.
- process_
hook_ cursor - Process a hook invocation for Cursor (different output format).
- process_
hook_ gemini - Process a hook invocation for Gemini CLI.
- process_
hook_ kiro - Process a hook invocation for Kiro (IDE and CLI).
- process_
hook_ windsurf - Process a hook invocation for Windsurf.
- remove_
claude_ global_ hook - Remove sqz’s hook entries from
~/.claude/settings.jsonwithout touching any other keys. Symmetric with [install_claude_global].