Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.88 KB

File metadata and controls

42 lines (31 loc) · 1.88 KB

OpenUsage Documentation

What the app does and how it behaves. These pages describe behavior, not visuals, and they are updated together with any change to that behavior — if the app and a page here disagree, that's a bug.

The app

  • Dashboard — the popover: rows, toggles, reordering, keyboard shortcuts
  • Menu bar — pinning metrics into the menu bar
  • Settings — every option, what it changes
  • Refreshing & caching — when data updates and what happens when a fetch fails
  • Model pricing — how spend tiles price tokens, and where the rates come from
  • Updates — automatic updates, manual checks, and the beta channel
  • Privacy & usage data — what anonymous data is shared, and how to turn it off

Integrations

  • Local HTTP API — read your usage from other apps on 127.0.0.1:6736
  • Proxy — route provider requests through SOCKS5 or HTTP(S)

Providers

What each provider tracks, where its credentials come from, and what to do when it shows an error.

For developers

How the app is built and how to extend it.

  • Architecture — composition root, stores, the provider pipeline, the AppKit bridge
  • Adding a provider — the metric contract and the register/test/document steps
  • Debugging & capturing logs — running a local build and streaming logs
  • Logging — the file log, log levels, subsystem tags, and what is never logged