playbook/brooks-lint/docs/windsurf-setup.md

Windsurf Setup

Windsurf (Cascade) natively loads Agent Skills and reads AGENTS.md, so all six brooks-lint modes run with no conversion.

Install

# simplest — one command (global)
curl -fsSL https://raw.githubusercontent.com/hyhmrright/brooks-lint/main/scripts/install.sh | bash -s -- windsurf

# from a clone
./scripts/install.sh windsurf            # global:  ~/.codeium/windsurf/skills
./scripts/install.sh windsurf --project  # this repo: ./.windsurf/skills

Manual equivalent:

git clone https://github.com/hyhmrright/brooks-lint.git /tmp/brooks-lint
mkdir -p ~/.codeium/windsurf/skills
cp -r /tmp/brooks-lint/skills/* ~/.codeium/windsurf/skills/   # flat — brooks-* and _shared/ as siblings

Invoke

Ask naturally ("review this PR", "audit the architecture") — Cascade selects the matching skill from its description. The repo's AGENTS.md is read by Windsurf's rules engine and carries the Iron Law and Health Score rules. (@skill-name also references a discovered skill.)

Notes

• Flat layout is mandatory (the installer guarantees it): ../_shared/ only resolves when _shared/ is a sibling of the brooks-* folders.
• 🧪 Documented per the official Cascade skills docs; community end-to-end verification welcome — open an issue.