Install the environment and complete a first example. This section is for readers learning or using RULER.
Use Python 3.12 or newer, Git, and uv. From the repository root:
uv sync --extra dev
uv run ruler validate deps
uv run ruler --helpSWI-Prolog is a separate system executable required by workflows that declare Prolog acceptance checks. The complete gate also requires browser and report preparation; follow getting started before running it. For agent skill discovery, see the plugin guide.
- Installation and first use — Install, prepare checks, choose an interface, and inspect outputs.
- Plugin setup — Canonical skills in supported agent clients.
- Cross-platform operation — Portable execution and system dependencies.
Return to the documentation index or consult the documentation map for the complete retained collections.