Skip to content

settings.md

Latest commit

 

History

History
105 lines (75 loc) · 5.56 KB

settings.md

File metadata and controls

105 lines (75 loc) · 5.56 KB
Raw

Settings

Open Settings from the panel's ⋯ menu or press ⌘,. General, Display, Alerts, and Advanced sit under the title, and the chevron at the top left goes back. Every setting applies at once and survives relaunch.

General

Setting Control What it changes
Launch at Login switch Registers OpenUsage as a login item, so it starts when you sign in to your Mac.
Default Tab Priority, All Usage The tab the panel opens to, no matter which tab it was closed on.
Global Shortcut recorder A keyboard shortcut that opens and closes the panel from any app. Click the field and press the keys.

Appearance

Setting Control What it changes
Theme System, Light, Dark The panel's appearance. System follows macOS.
Time Format Auto, 12-hour, 24-hour How exact times read. Auto follows your macOS locale.

Usage display

Setting Control What it changes
Show Usage As Used, Left Whether every bounded reading says 48% used or 52% left, on the dashboard and in the menu bar. A click on any limit's amount in the dashboard flips it too.
Reset Times Countdown, Exact Time Whether resets read Resets 3h 25m or Resets Wed 4 PM. A click on any reset in the dashboard flips it too.

Priority Icons

Setting Control What it changes
Preview Shows sample icons at the number you pick, smaller so any number fits.
Show In Menu Bar App Icon Only, Up to 1, Up to 2, Up to 3, Up to 4, Up to 5 How many limits the menu bar strip shows, closest to running out first. Any others show as a count, like +7. Starts at Up to 3. See Menu bar.

Notifications

Three independent triggers, all off by default. Turning the first one on asks macOS for notification permission. While macOS has notifications off for OpenUsage, a footer under the switches says so and links to System Settings.

Setting What it sends
Almost Out When a limit drops under 10%, as it turns red.
Cutting It Close When a limit drops under 30%, as it turns orange.
Will Run Out When a limit may run out before its reset.

Each notification names the trigger, the provider, and the metric, and fires once per metric per reset window. Click it to open All Usage. The next time you open the panel yourself it uses your Default Tab.

Privacy

Setting Control What it changes
Hide From Screen Share switch While your screen is shared or recorded, the menu bar shows the app icon instead of your usage. Off by default. See Privacy.
Help Make OpenUsage Better switch Whether the app sends the optional daily provider-refresh summaries described in Privacy. The anonymous daily active ping and crash reports do not depend on this switch.

Command Line

Setting Control What it changes
Terminal Helper Install…, Uninstall Links /usr/local/bin/openusage to the openusage command inside the app, after the macOS administrator prompt, or removes that link. A link left by another copy of OpenUsage (an earlier version, or a build in another folder) is replaced on Install. Reads Unavailable when something OpenUsage did not install already sits at that path. See Command line.

Debug

Setting Control What it changes
Log Level Error, Warning, Info, Debug How much detail OpenUsage writes to the macOS log. Starts at Info. Choose Debug while you reproduce a problem. See Debugging.

Updates

This section appears in the released build only; the dev build has no update feed.

Setting Control What it changes
Check Automatically switch Checks for a new version about once an hour and shows the Update Available banner on the dashboard when one is found.
Beta Updates switch Adds pre-release builds to the checks. Turn it off to stay on your current version until the next stable release.
Check for Updates… button Checks now and opens the update window.

See Updates.

Upgrading from 0.7.x

0.7.x found your accounts on its own, so you add them again on the Accounts screen. The exception is an OpenRouter or Z.ai key you typed into 0.7.x, which it saved in ~/.config/openusage/openrouter.json or ~/.config/openusage/zai.json. On the first launch after the update, OpenUsage adds each saved key as an account when that provider has no account yet and a usage read accepts the key. It does this once, so an account you remove later doesn't come back. If the provider rejects the key, it doesn't try again. If the usage read fails for any other reason, such as a Z.ai key with no active plan, or the Keychain doesn't save the key, it tries again on the next launch.

When you add the only account of a provider that was on in 0.7.x, it takes that provider's 0.7.x hidden metrics and order:

  • Hidden metrics. A metric 0.7.x showed neither on the dashboard nor in the menu bar starts hidden. Metrics that 0.7.x did not have start shown.

  • Metric order. The metrics keep 0.7.x's order. Metrics that 0.7.x did not have go last.

  • Provider order. Each provider takes the place of its first enabled account in the saved 0.7.x order.

When 0.7.x had several accounts of a provider on, the one it showed first gives the hidden metrics and order. Stars don't carry over: the menu bar picks its own limits.

OpenUsage reads 0.7.x's layout and never changes it, and it deletes nothing that 0.7.x saved. If you go back to 0.7.x, it finds its stars and order as you left them.