Skip to content

docs: point the quickstart and the announcement at the PyPI release #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
open-coder-ai-org merged 1 commit into from
Sep 7, 2026
Merged

docs: point the quickstart and the announcement at the PyPI release #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ whole (the consumer sets its own thresholds).
## 30-second quickstart

```bash
pip install context-report # once published; today: pip install -e ".[dev]" from a checkout
pip install context-report # 0.1.0 on PyPI; pip install -e ".[dev]" from a checkout to hack on it
context-report produce --subject ./my-plugin --kind plugin --target claude_code --n 20 \
--out report.json # one statement: reachability, cost and fault rows for one target
context-report run run.json # a whole manifest: subjects x models x tasks in one shot
Expand Down
9 changes: 7 additions & 2 deletions docs/announcement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,14 @@ proof an artifact works everywhere. The fault rows for what a real client does o
timeout are `NotAvailable` in v0.1 — it does not yet drive a live client, and says so rather than
guessing from documentation.

**Try it in five minutes**: `pip install -e ".[dev]"` from a checkout, then
**Try it in five minutes**: `pip install context-report` (0.1.0 is on PyPI), then
`context-report produce --subject ./your-artifact --kind plugin --target claude_code --n 20
--out report.json` produces a statement against your own plugin, hook, or instruction file; `context-report
verify report.json --subject ./your-artifact` checks it against the schema.
verify report.json --subject ./your-artifact` checks it against the schema. The same functions are
a Python library (`from context_report import produce_statement, verify`) for a catalog or CI job.
A run manifest lines up any model you can reach: Anthropic, the `claude` CLI, or any
OpenAI-compatible endpoint, hosted or local, with a `baseUrl`; every run is kept and the history
renders side by side so you can see what a change to the artifact did.

**How to help**: measure your own artifact and open the resulting statement as a PR to
`spec/attestation/v0.1/examples/`; add a target agent's payload shape to
Expand Down Expand Up @@ -77,4 +81,5 @@ Every row is `re-derivable` (a catalog can recompute it) or `claimed` (labeled,
no thresholds, no certification, just facts.
Measured 88 bundles, 18 public plugins, and 7 instruction files so far — three plugins turned out
unreachable (exit 126, no execute bit) and every hook allowed malformed input.
`pip install context-report` to try it on your own artifact.
Repo: https://github.com/open-coder-ai/context-report — spec feedback and your own reports welcome.