Quickstart

Install

uv tool install scaffold-guard
scaffold-guard version

Create A Project

scaffold-guard init my_project --agent all
cd my_project
uv sync --all-groups
scaffold-guard check
scaffold-guard validate --quick

Generated projects include CI and local development defaults, but the user-facing CLI remains the installed scaffold-guard command.

Use one adapter when you only need one agent surface:

scaffold-guard init codex_demo --agent codex
scaffold-guard init claude_demo --agent claude
scaffold-guard init cursor_demo --agent cursor

Preview Or Refresh Files

Preview a new project without writing files:

scaffold-guard init demo --dry-run

Refresh managed instruction files from inside a generated project:

scaffold-guard compile-rules --dry-run
scaffold-guard compile-rules --force

compile-rules refuses to overwrite manually edited instruction files unless --force is supplied or the file has the generated marker.