Skip to content

From source

Clone the repo and install in editable mode. Use this if you're contributing, debugging the framework, or you want the bleeding edge.

Clone and install

git clone https://github.com/garciaalan186/squeaky-clean.git
cd squeaky-clean
pip install -e ".[dev]"

The [dev] extra pulls in pytest, mypy, ruff, and the per-language linters used by the meta-eval harness.

Verify

pytest -q                              # framework's own test suite
mypy --strict squeaky_clean/            # strict type-check
ruff check .                            # lint

All three should pass. If any fail on a clean checkout, that's a bug — please file an issue.

Run against an example

export ANTHROPIC_API_KEY="sk-ant-..."
squeaky generate --problem-file examples/todo_api/todo_problem.json --infra=auto

What to do next

  • Get started — the same flow, but framed as the user-facing happy path.
  • Architecture deep-dive — what you're looking at when you cd squeaky_clean/.
  • Roadmap — open milestones and where contributions land.