README.md
Documentation
The repository keeps maintained documentation and current product screenshots.
The documentation policy is in AGENTS.md.
Every file under docs/ is listed below so new material has an explicit purpose.
TODO.md tracks remaining Linux/Plasma parity with the official
macOS app; the guides describe supported behavior. Agents maintain both through the
documentation workflow.
Maintained references
Linux parity TODO: open Plasma work, official CLI blockers, and the last reviewed upstream release. Agents update it with each release.
Contributing: entry point for outside contributors, covering where to report what, checkout setup, and pull request requirements.
Security policy: supported versions and private vulnerability reporting for the widget.
Changelog: notable widget changes by version and unreleased changes. Future GitHub release notes come from this file.
Usage and settings: panel and popup options, provider setup, data freshness and quota cache limits, cost history, notifications, and widget defaults.
Development: QML ownership, regression checks, runtime verification, PR delivery and CI follow-up, repository maintenance, and agent instructions. Read before code or tooling changes.
Provider settings descriptor: proposed upstream CLI contract for generic settings. It is not a shipped contract.
Cost history: daily model data, selection behavior, and the pinned Linux CLI evidence behind the popup.
Translations: adding and checking a language catalog.
CLI 0.56.2 parity baseline: verified official Linux contracts at that comparison date. The usage guide describes current Plasma behavior; later scoped checks in the cost and settings documents do not replace this full audit.
0.57.0 release review: Linux-relevant changes since 0.56.2, current Plasma gaps, and scoped official CLI probes.
0.58.0 release review: release delta with no Linux CLI contract changes, feature classification against existing Plasma behavior, and scoped official CLI probes.
Settings decisions: Panel disclosure and text grouping, Plasma settings, privacy, refresh behavior, and the macOS 0.56.8 comparison.
Earlier CLI evidence
These small reports preserve version-specific evidence used by later audits. They are historical comparisons, not current feature plans. Preserve their original findings; a new audit names the report it supersedes and its exact versions. Current guides describe implemented recommendations; TODO lists remaining Linux work.
Product screenshots
These synthetic captures appear in the project README or usage guide. The README captures are also included in the widget package. Replace the relevant image when the product changes instead of adding dated before/after copies.
- Overview
- Provider details
- Usage and spend
- Sessions
- Standard panel: colored provider icons and dual quota capsules.
- Minimal panel: monochrome provider icons and dual quota capsules.
- Panel with usage text: selected-provider text grouped with its quota capsules.
Historical work artifacts
Past captures, completed plans, and review logs are available in
Git history before the cleanup.
New temporary artifacts go in ignored dist/review/ or the OS temp directory.
PRs record verification results; this index records documents worth maintaining.