mirror of
https://github.com/AgentSeal/codeburn.git
synced 2026-05-02 00:40:14 +00:00
feat(mac): native Swift menubar app + one-command install
Introduces mac/ with a native SwiftUI menubar app that replaces the previous SwiftBar plugin entirely. Install via `npx codeburn menubar`, which downloads the .app from GitHub Releases, strips Gatekeeper quarantine, and drops it into ~/Applications. Highlights - mac/ SwiftUI app: agent tabs, Today/7/30/Month/All period switcher, Trend/Forecast/Pulse/Stats/Plan insights, activity + model breakdowns, optimize findings, CSV/JSON export, Star-on-GitHub banner, live 60s refresh, instant currency switching with offline FX cache. - Security: CodeburnCLI argv-based spawn (no shell interpretation), SafeFile symlink guards + O_NOFOLLOW writes, FX rate clamping to [0.0001, 1_000_000], keychain filtered to account == "default", removed byte-window credential log, in-flight refresh guard, POSIX flock on config.json writes, TerminalLauncher validates argv before AppleScript interpolation. - Performance: shared static NumberFormatter (thousands of allocations per popover redraw eliminated), concurrent pipe drain with 20 MB cap + 60s timeout in DataClient, Observation-tracked reactive UI, 5-min payload cache keyed on (period, provider). - CLI: new `codeburn menubar` subcommand that downloads + installs + launches the .app (no clone, no build). New `status --format menubar-json` payload builder. `export` rewritten to produce a folder of one-table-per-file CSVs with a `.codeburn-export` marker so arbitrary -o paths cannot be silently deleted. - Removed: src/menubar.ts (SwiftBar plugin generator), install-menubar / uninstall-menubar subcommands, `status --format menubar` directive output, tests/menubar.test.ts, tests/security/menubar-injection.test.ts. - Release: .github/workflows/release-menubar.yml builds universal binary, assembles .app, ad-hoc signs, zips, uploads on mac-v* tag push. Runs on the free macos-latest runner. Tests - 230 TypeScript tests pass - 10 Swift CapacityEstimator tests pass - TypeScript typecheck clean - Swift release build clean
This commit is contained in:
parent
69268a9e91
commit
495a254338
46 changed files with 6433 additions and 575 deletions
88
mac/README.md
Normal file
88
mac/README.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
# CodeBurn Menubar (macOS)
|
||||
|
||||
Native Swift + SwiftUI menubar app. The codeburn menubar surface.
|
||||
|
||||
## Requirements
|
||||
|
||||
- macOS 14+ (Sonoma)
|
||||
- Swift 6.0+ toolchain (bundled with Xcode 16 or standalone)
|
||||
- `codeburn` CLI installed globally (`npm install -g codeburn`) or available at a path you pass via `CODEBURN_BIN`
|
||||
|
||||
## Install (end users)
|
||||
|
||||
One command:
|
||||
|
||||
```bash
|
||||
npx codeburn menubar
|
||||
```
|
||||
|
||||
That's it. The command downloads the latest signed `.app` from GitHub Releases, drops it into `~/Applications`, clears Gatekeeper quarantine, and launches it. Re-running it upgrades in place with `--force`, or just launches the existing copy otherwise.
|
||||
|
||||
If you already have the CLI installed globally (`npm install -g codeburn`), `codeburn menubar` works the same way.
|
||||
|
||||
### Build from source
|
||||
|
||||
For contributors running a local build instead of the packaged release:
|
||||
|
||||
```bash
|
||||
npm install -g codeburn # CLI the app shells out to for data
|
||||
git clone https://github.com/AgentSeal/codeburn.git
|
||||
cd codeburn/mac
|
||||
swift build -c release
|
||||
.build/release/CodeBurnMenubar # launch
|
||||
```
|
||||
|
||||
## Build & run (dev against a local CLI checkout)
|
||||
|
||||
```bash
|
||||
cd mac
|
||||
swift build
|
||||
# Point the app at your dev CLI build instead of the globally installed `codeburn`:
|
||||
npm --prefix .. run build
|
||||
CODEBURN_BIN="node $(pwd)/../dist/cli.js" swift run
|
||||
```
|
||||
|
||||
The app registers itself as a menubar accessory (`LSUIElement = true` at runtime). No Dock icon.
|
||||
|
||||
## Data source
|
||||
|
||||
On launch and every 60 seconds thereafter, the app spawns `codeburn status --format menubar-json --no-optimize` directly (argv, no shell) via `CodeburnCLI.makeProcess` and decodes the JSON into `MenubarPayload`. The manual refresh button in the footer invokes the same command without `--no-optimize`, which includes optimize findings but takes longer.
|
||||
|
||||
Override the binary via the `CODEBURN_BIN` environment variable (default: `codeburn` on PATH). The value is validated against a strict allowlist (alphanumerics plus `._/-` space) before use, so a malicious env var can't inject shell commands.
|
||||
|
||||
## Project layout
|
||||
|
||||
```
|
||||
mac/
|
||||
├── Package.swift SwiftPM manifest
|
||||
├── Sources/CodeBurnMenubar/
|
||||
│ ├── CodeBurnApp.swift @main + MenuBarExtra scene
|
||||
│ ├── AppStore.swift @Observable store + enums
|
||||
│ ├── Data/MenubarPayload.swift Codable payload types + placeholder
|
||||
│ ├── Theme/Theme.swift Design tokens (warm terracotta palette)
|
||||
│ └── Views/MenuBarContent.swift Popover layout + footer action bar
|
||||
└── README.md This file
|
||||
```
|
||||
|
||||
## Status
|
||||
|
||||
Live data wired. Next iterations:
|
||||
|
||||
1. FSEvents watch for `~/.claude/projects/` changes (debounced refresh on real edits)
|
||||
2. Persistent disk cache for optimize findings so the default refresh can include them without the 30-second penalty
|
||||
3. Currency metadata in the JSON payload + Swift-side formatting
|
||||
4. Sparkle auto-update
|
||||
5. DMG packaging + Homebrew Cask tap
|
||||
|
||||
## Design tokens
|
||||
|
||||
Sourced from `~/codeburn-menubar-mac-swiftui.html`. Warm terracotta-ember palette:
|
||||
|
||||
- Accent (light): `#C9521D`
|
||||
- Accent (dark): `#E8774A`
|
||||
- Ember deep: `#8B3E13`
|
||||
- Ember glow: `#F0A070`
|
||||
- Surface (light): `#FAF7F3`
|
||||
- Surface (dark): `#1C1816`
|
||||
|
||||
SF Mono for currency values; SF Pro Rounded for hero.
|
||||
Loading…
Add table
Add a link
Reference in a new issue