Skip to content

v0.1.0

Choose a tag to compare

View all tags
@DrewTittle DrewTittle released this 22 Jun 21:12
v0.1.0
920bd1e

First public release of toaster-ready — a deterministic Go CLI (binary: toaster) that scores how ready a repository is for someone — a new hire or an AI agent — to ramp up on, and emits a cited, provenance-bearing scorecard out of 100.

Highlights

  • Weighted /100 rubric — 11 categories, each cited to evidence.
  • Three-state signals — ok / no-data / not-applicable; no-data is never scored 0, and not-applicable categories drop out with their weight redistributed.
  • Agent-readiness as a first-class concern — agent instructions are scored for existence, whether they explain the mechanics, and whether they fit a context budget.
  • CI gate — `toaster gate` fails below a configurable threshold; deterministic and secret-free, so it runs anywhere.
  • Output — JSON / Markdown / HTML, with actionable recommendations for low-scoring areas.
  • Configurable — `.toaster-ready.yml` overrides weights, thresholds, and signals.

Install

```sh
go install github.com/tittle-xyz/toaster-ready/cmd/toaster@v0.1.0
```

Built AI-assisted and human-reviewed; the design rationale lives in `docs/adr/`. Apache-2.0.

Assets 2
Loading