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.

  • AI Insights: the optional insight card's boundary decision, allowlisted snapshot, language selection, request and credential contracts, scheduling, and tests.

  • 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.

  • 0.60.4 release review: releases 0.59.0 through 0.60.4, source-observed credit-availability and detail-row fields, unchanged JSON schemas, and scoped official CLI probes. Cursor cost, provider descriptors, and generic config actions remain unavailable on Linux.

  • 0.60.5 release review: the new cost incompleteRequestCount contract verified in official Linux output, its unknown-not-zero day shape, and scoped official CLI probes. Provider descriptors, generic config actions, and Cursor cost remain unavailable.

  • 0.61.0 release review: the registry growth to 74 providers, the source-observed Grok reset-credit detail row, the live-only grokResetCredits property, and scoped official CLI probes. Provider descriptors, generic config actions, and Cursor cost remain unavailable.

  • 0.62.0 release review: the verified Muse token-history cost contract, the Codex-only --remote and --summary-only cost modes, the usage_updated hook event, invalid-total suppression in cost aggregation, and scoped official CLI probes. Provider descriptors, generic config actions, and Cursor cost remain unavailable.

  • 0.63.0 release review: the Pi registry growth with local token history and estimated costs, the still-rejected Cursor cost and descriptors probes, and scoped official CLI probes. Provider descriptors, generic config actions, and Cursor cost remain unavailable.

  • 0.64.1 release review: the Helmcode, v0, and TypeSafe registry additions, the Crof retirement, the measured split between v0's supported API-key setup and the two cookie-only providers, and scoped official CLI probes. Provider descriptors and generic config actions remain unavailable.

  • 0.65.0 release review: the Bifrost, Charm Hyper, and GitKraken AI registry additions and their Linux reachability, detail-row progress/usageValue and unknown named windows verified through a loopback Bifrost fixture, and checksum-verified official CLI probes. Provider descriptors, generic config actions, token-account writes, and Cursor cost remain unavailable.

  • 0.66.0 release review: the DevPass, Atlas Cloud, Vercel AI Gateway, and llmman registry additions and their API-key setup, llmman output verified through a loopback daemon fixture, the #3944 plugin-entry preservation in the tested config disable command, and checksum-verified official CLI probes. Provider descriptors, generic config actions, and Cursor cost remain unavailable.

  • 0.67.0 release review: the Aixy, Raycast, and xKiro registry additions and their Linux reachability, Aixy output verified through a loopback fixture, the cost --period flag and its reportingPeriod/historyLabel fields, and checksum-verified official CLI probes. Provider descriptors, generic config actions, Cursor cost, and display currency remain unavailable.

  • Settings decisions: Panel disclosure and text grouping, Plasma settings, privacy, refresh behavior, the macOS 0.56.8 comparison, and the shared settings visual conventions.

Earlier CLI evidence

The 0.49.1 through 0.55.0 reports were superseded by the 0.56.2 audit, which re-verified their contracts, and were removed. They remain recoverable from Git history at commit ba0a0d8.

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.

Store artwork

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.