Getting Started
This guide covers the one-time setup required to build and run Chipmunk locally.
Prerequisites
Installing Rust
Install Rust using the official instructions for your operating system:
Installing just
Chipmunk uses just to run common development tasks from the repository root. Install it using one of the methods listed in the project README:
Verify Your Setup
From the repository root, list the available development recipes:
just --list
If the command prints the available recipes, your basic setup is ready.
Repository Context
.ai/ holds the shared context of this repository, written for developers and agents alike: orientation on the modules in knowledge/, the code rules every change and review follows in rules/, and recurring maintenance processes in workflows/.
Start at .ai/INDEX.md, which links to the rest. Agents reach the same content through AGENTS.md in the repository root.
Next Steps
Continue with Repository Structure to understand the main project areas, then read the Development Guide for the common workflow.