Setup Guide¶

Quick Install (hooks only)¶

./install.sh /path/to/your/project

This sets core.hooksPath to point at void-filter's hooks/ directory. No files are copied into your project.

Full Install (tools + hooks)¶

sudo ./setup.sh /path/to/your/project

Installs all tooling (clang-format, ruff, goimports, golangci-lint, prettier, eslint, shellcheck, shfmt, yamllint, buf, oelint-adv) and configures hooks.

Requirements¶

Git 2.9+ (for core.hooksPath)
Python 3.8+ (for hook config parsing)
bash 4+ (for hook scripts)
sudo access (for setup.sh package installation)

What Gets Configured¶

Component	Location
Git hooks	`core.hooksPath` → `void-filter/hooks/`
Hook config	`void-filter/config/hooks.json`
License templates	`void-filter/config/license-templates.json`
Lint config	`void-filter/Tools/Git/Lint/settings.json`

Uninstall¶

git config --unset core.hooksPath

Verify Installation¶

git config core.hooksPath  # Should show path to void-filter/hooks