mirror of
https://github.com/AgentSeal/codeburn.git
synced 2026-07-31 11:55:33 +00:00
4a100d9d06
The packaged app resolved whatever codeburn was on PATH — for real users the published npm release, which predates every JSON surface the app calls. The app now ships its own CLI copy under resources/cli (staged production node_modules tree; tsup output is not self-contained) and spawns it with Electron's own binary via ELECTRON_RUN_AS_NODE. No install prerequisite remains. - resolution order: CODEBURN_BIN, dev repo CLI, bundled, persisted path, PATH search - launch.js shim strips the extra argv element commander mis-slices under packaged Electron-as-node (process.versions.electron is set), which reproduced the 'too many arguments' class of error - afterPack hook copies the staged tree (extraResources runs node_modules through the production-dep filter and ships it empty); lands before signing, signature verified intact - packaging always restages from src via root build:cli (tsup only, no network); ~12MB compressed per artifact Verified on the built app: Electron-as-node CLI emits current JSON (providerDetails, currency), and a minimal-PATH GUI launch spawns the bundled CLI with zero external dependencies. 290/290.
69 lines
3.7 KiB
Markdown
69 lines
3.7 KiB
Markdown
# CodeBurn Desktop
|
|
|
|
Electron desktop shell for CodeBurn's local-first usage views. M1 runs as a developer app and reads data by spawning the installed `codeburn` CLI; it does not run a daemon or HTTP server.
|
|
|
|
## Development
|
|
|
|
```sh
|
|
npm --prefix app install
|
|
npm --prefix app run dev
|
|
```
|
|
|
|
Validation:
|
|
|
|
```sh
|
|
npm --prefix app run test
|
|
npm --prefix app run typecheck
|
|
```
|
|
|
|
## CLI Dependency
|
|
|
|
Packaged builds ship their own version-matched copy of the `codeburn` CLI and require nothing installed — the app spawns the bundled CLI with Electron's own binary as Node (`ELECTRON_RUN_AS_NODE`). In development (Vite dev server) the app uses the repo's freshly-built CLI, and either can be overridden with `CODEBURN_BIN` or a persisted path file. See `DISTRIBUTION.md` for the bundling and resolution details. Electron resolves and spawns the CLI from the main process, then sends decoded JSON through the secure preload bridge into the renderer.
|
|
|
|
This follows the menubar pattern:
|
|
|
|
- `contextIsolation: true`, `nodeIntegration: false`, and `sandbox: true`.
|
|
- Renderer code calls `window.codeburn` only through `app/renderer/lib/ipc.ts`.
|
|
- Main process handlers return JSON envelopes so structured CLI errors survive IPC.
|
|
- Missing CLI, bad JSON, timeout, and nonzero exits are surfaced as honest UI states.
|
|
- The renderer never imports CodeBurn engine code from `src/`; the data contract is spawn CLI, decode JSON, poll.
|
|
|
|
## Data Contract
|
|
|
|
Current bridge calls:
|
|
|
|
- Overview: `codeburn status --format menubar-json --period <period> [--provider <provider>]`
|
|
- Plans: `codeburn status --format json --period <period>`
|
|
- Models: `codeburn models --format json --period <period> [--provider <provider>] [--by-task]`
|
|
- Optimize: `codeburn yield --format json --period <period>`
|
|
- Spend flow: `codeburn spend --format flow-json --period <period> [--provider <provider>]`
|
|
- Devices: `codeburn devices --format json --period <period>`
|
|
- Device scan: `codeburn devices scan --format json`
|
|
- Share status: `codeburn share status --format json`
|
|
- Identity: `codeburn identity --format json`
|
|
|
|
Supported M1 periods are `today`, `week`, `30days`, `month`, and `all`. Provider filtering is passed through where the CLI command supports it.
|
|
|
|
## Sections
|
|
|
|
- Overview: daily spend, spend stats, waste summary, and expensive sessions from `menubar-json`.
|
|
- Spend: project/activity/tool/MCP/subagent lenses plus model-to-project flow.
|
|
- Optimize: waste findings from `menubar-json` and reverted/abandoned yield data.
|
|
- Models: model and task tables from `models --format json`.
|
|
- Plans: plan pacing from `status --format json`.
|
|
- Settings: device identity, nearby scan results, paired-device usage, and M2 visual affordances.
|
|
|
|
## Packaging
|
|
|
|
`npm run package` produces an ad-hoc-signed macOS `.dmg`/`.zip` (arm64 and x64) via `electron-builder`, no paid Apple Developer account required. Packaging rebuilds the root CLI and bundles it into the app (`Resources/cli`), so installs need nothing on the target machine. See `DISTRIBUTION.md` for build instructions, the bundled-CLI mechanism, artifact locations, and the Gatekeeper first-open story.
|
|
|
|
## M2 Backlog
|
|
|
|
- Add Electron `autoUpdater` (the app already bundles its own version-matched CLI, so end-user installs need nothing on the machine; auto-update is the remaining piece).
|
|
- Keep npm as a separate CLI-user channel at the same version as the desktop app.
|
|
- Add macOS code signing with a paid Developer ID and notarization (ad-hoc packaging exists today; see `DISTRIBUTION.md`).
|
|
- Add a `codeburn desktop` launcher subcommand.
|
|
- Implement in-app pairing, approve, pull, and visibility mutations currently shown as M2 affordances.
|
|
- Build the Models Compare sheet.
|
|
- Add light theme support.
|
|
- Expand `codeburn optimize --format json` with evidence and fix commands so Optimize can show richer actionable fixes.
|