f3f6c4c3b0
* refactor(app): move the bridge handlers out of main.ts createBridgeHandlers and the argv builders now live in app/electron/bridge-handlers.ts with no electron import, so a host other than Electron can run the same channel to argv mapping. main.ts keeps its default deps and re-exports, so the desktop app and its tests are unchanged. Two additive hooks for that host: scopeProjectFilter narrows the saved project filter before it becomes argv, and CODEBURN_NODE_BIN runs the bundled CLI with a named Node instead of Electron-as-Node. * feat(app): let the renderer run inside an editor The bridge can now say it is the VS Code host. When it does, the chord shortcuts and their hints step aside for the editor's own, Settings hands theme, language, default period and refresh to the editor's settings, the top bar shows a this workspace / all projects switch, and the editor can send a section, a period or a refresh to an open dashboard. formatResetTime moves to lib/format.ts so the status bar and the summary use the Plans wording. New strings are in all six locales. Nothing changes in the desktop app. * feat(app): build the renderer for VS Code webviews app/vite.vscode.config.ts builds two webview entries into vscode/dist/webview: the whole dashboard and the activity bar summary. renderer/vscode/bridge.ts implements window.codeburn over postMessage, forwarding only the channels in channels.ts; telemetry, update checks and the desktop companions are answered in the webview. localStorage is prefixed per scope so one workspace's cached views never paint in another's, and the theme follows the editor's light, dark and high contrast kinds through its --vscode-* tokens. * feat(vscode): CodeBurn extension for VS Code and its forks A status bar item with today's spend (~ when estimated) and a tooltip with the week, the month, this workspace, the top model and plan quotas; an activity bar summary; the desktop dashboard in an editor tab, scoped to the open workspace; eight commands and eight settings. The bundled CLI runs as the desktop's resident serve child through the shared client. Current VS Code, Cursor and Antigravity ship Node 24, so it runs on the editor's own Node; an older editor gets a system Node 22.13+ or a degraded run that says what it cannot read. A workspace folder maps to a rooted --project the way the CLI keys sessions, worktrees folding into their main repository. npm run package:vscode builds the .vsix. Unit tests cover the bridge host, status bar formatting, workspace mapping, settings and runtime choice; test:smoke drives a real VS Code against a fixture home. * ci, docs: build, test and package the VS Code extension A vscode job typechecks, unit tests, packages the .vsix, runs the smoke test in VS Code under xvfb and uploads the .vsix. docs/vscode.md covers the architecture, the measured editor runtimes and how to test. * fix(vscode): keep the currency setting out of workspace settings Changing codeburn.currency runs the CLI's own currency command, which every CodeBurn app shares, so a repository's .vscode/settings.json must not be able to set it: the setting is application scoped now. The smoke test also checks that the dashboard's renderer booted inside the webview and called the host, not only that its tab opened. * feat(vscode): version the extension 1.0.0, apart from the CLI The extension carried the CLI's 0.9.25. It now has its own version, 1.0.0. The host passes it to the webview, and the dashboard's nav footer, About dialog and Settings show it there instead of the renderer's package version; Settings adds "Bundled CLI 0.9.25" beneath it. The desktop app is unchanged. Nothing in the build or packaging writes the extension's version from the CLI. * fix(vscode): run the smoke test in Cursor, keep the demo shim out Cursor 3 opens its Agents window on a fresh profile, which starts no extension host, so the smoke run against Cursor.app hung; it now passes --classic for Cursor. The webview build no longer copies renderer/public/demo-shim.js, a browser demo harness, into the .vsix. * feat(vscode): a quiet star line in the summary, and a Star on GitHub command From the third day of use, the activity bar summary ends with the desktop's "Enjoying CodeBurn? Star us on GitHub" line, in the same six languages, with a close button. Clicking it or closing it hides it for good (kept in the extension's globalState). It is never a notification. The new "CodeBurn: Star on GitHub" command opens the repository page. No tracking parameters, no telemetry. * docs(vscode): marketplace screenshots in the README Five screenshots of the extension on real data (Overview in dark and light, the why it cost view, the status bar hover and the activity bar summary), 1600 px wide, each with a one-line caption. They live in vscode/media/screenshots, stay out of the .vsix, and the package script points vsce at the raw GitHub URLs on main. * fix(vscode): review fixes for settings trust, serve lifecycle and the tooltip - codeburn.provider and codeburn.quotaProviders are application scoped, like currency, so a repository's settings cannot turn quota requests back on, even in Restricted Mode. - deactivate removes the serve pid file once the child is stopped, and changing codeburn.nodePath restarts the serve child on the new Node. - codeburn.currency is applied at startup when the CLI's currency differs, not only when the setting changes. - The dashboard's Settings no longer shows per-plan quota switches in the editor, where the editor setting rewrites them on every boot; it points to the editor settings instead. - Workspace and model names are escaped in the status bar tooltip. - The README lists the dashboard actions that reach the network. - The staged CLI drops its dependencies' tests and TypeScript sources (466 files, 9.9 MB to 9.2 MB). |
||
|---|---|---|
| .. | ||
| build | ||
| electron | ||
| flathub | ||
| renderer | ||
| scripts | ||
| .gitignore | ||
| demo-bridge.mjs | ||
| DISTRIBUTION.md | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.electron.json | ||
| tsconfig.json | ||
| vite.config.ts | ||
| vite.vscode.config.ts | ||
| vitest.config.ts | ||
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
npm --prefix app install
npm --prefix app run dev
Validation:
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, andsandbox: true.- Renderer code calls
window.codeburnonly throughapp/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.
Refresh tiers
Not every call runs at the same cadence. The headline overview is the only live poll; it asks for neither optimize findings nor a fresh act report. act report refreshes on mount, on a manual refresh, and every 10 minutes; yield every 5. The optimize scan runs at most once a day per query scope, is stored in userData with the time it was computed, is reused only on the same local day, and is forced fresh by the Optimize page or a manual refresh. A figure that is not live is shown with its age. On battery the live interval doubles. While the window is hidden the app stops polling and animating altogether, and catches up immediately when it comes back.
The CLI is spawned once as a resident codeburn serve --stdio child rather than per request. After 15 idle minutes it is retired and the next request starts a new resident; CODEBURN_SERVE_IDLE_MS tunes or disables that.
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-jsonand 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 a macOS .dmg/.zip (arm64 and x64) via electron-builder. Release builds are signed with a Developer ID Application certificate and notarized by Apple (ad-hoc signing is only a fallback when no signing identity is configured). 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 notarization process.
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 a
codeburn desktoplauncher subcommand. - Implement in-app pairing, approve, pull, and visibility mutations currently shown as M2 affordances.
- Build the Models Compare sheet.
- Expand
codeburn optimize --format jsonwith evidence and fix commands so Optimize can show richer actionable fixes.