pixelheros/.claude/docs/setup-requirements.md

Setup Requirements

This template requires a few tools to be installed for full functionality. All hooks fail gracefully if tools are missing — nothing will break, but you'll lose validation features.

Required

Tool	Purpose	Install
Git	Version control, branch management	git-scm.com
Claude Code	AI agent CLI	npm install -g @anthropic-ai/claude-code

Recommended

Tool	Used By	Purpose	Install
jq	Hooks (7 of 12)	JSON parsing in commit/push/asset/agent hooks	See below
Python 3	Hooks (2 of 12)	JSON validation for data files	python.org
Bash	All hooks	Shell script execution	Included with Git for Windows

Installing jq

Windows (any of these):

winget install jqlang.jq
choco install jq
scoop install jq

macOS:

brew install jq

Linux:

sudo apt install jq     # Debian/Ubuntu
sudo dnf install jq     # Fedora
sudo pacman -S jq       # Arch

Platform Notes

Windows

• Git for Windows includes Git Bash, which provides the bash command used by all hooks in settings.json
• Ensure Git Bash is on your PATH (default if installed via the Git installer)
• Hooks use bash .claude/hooks/[name].sh — this works on Windows because Claude Code invokes commands through a shell that can find bash.exe

macOS / Linux

• Bash is available natively
• Install jq via your package manager for full hook support

Verifying Your Setup

Run these commands to check prerequisites:

git --version          # Should show git version
bash --version         # Should show bash version
jq --version           # Should show jq version (optional)
python3 --version      # Should show python version (optional)

What Happens Without Optional Tools

Missing Tool	Effect
jq	Commit validation, push protection, asset validation, and agent audit hooks silently skip their checks. Commits and pushes still work.
Python 3	JSON data file validation in commit and asset hooks is skipped. Invalid JSON can be committed without warning.
Both	All hooks still execute without error (exit 0) but provide no validation. You're flying without safety nets.

Recommended IDE

Claude Code works with any editor, but the template is optimized for:

• VS Code with the Claude Code extension
• Cursor (Claude Code compatible)
• Terminal-based Claude Code CLI