codeburn/vscode/README.md
Resham Joshi f3f6c4c3b0
feat: CodeBurn for VS Code (#1670)
* 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).
2026-10-07 16:46:23 +02:00

5.5 KiB

CodeBurn for VS Code

See where your AI coding spend goes without leaving the editor: by project, model, session, pull request and day, for Claude Code, Codex, Cursor, Copilot, Gemini, OpenCode and every other tool the CodeBurn CLI reads.

CodeBurn reads the session logs these tools already write on your machine. Nothing is uploaded, and the extension sends no telemetry.

The CodeBurn dashboard Overview in a dark VS Code window

The Overview for this workspace: spend, activity, efficiency and the month so far.

The why it cost view for one session

Why a session cost what it did, with the prompts worth a look ranked by cost.

The status bar item with its hover open

Today's spend in the status bar. Hover for the week, the month and this workspace.

The CodeBurn summary in the activity bar

The activity bar summary: this workspace, all projects, top projects and models, and Optimize.

The CodeBurn dashboard Overview in a light VS Code window

It follows your editor's theme: light, dark or high contrast.

What you get

  • Status bar. Today's spend, with ~ when part of it is estimated. Hover for this week, this month, this workspace, the top model and every plan quota with its reset time. Click to open the dashboard.
  • Activity bar summary. This workspace's spend, all projects for today, 7 days and this month, the top projects and models, quota bars and the Optimize findings, with quick actions.
  • Dashboard. The full CodeBurn desktop dashboard in an editor tab: Overview, Sessions with the per-session "why it cost" view, Pull requests, Spend, Models, Optimize, Compare, Compare periods, Plans and Settings.
  • Workspace aware. The dashboard opens on the current workspace's projects. Switch to all projects from the scope menu or the editor title bar. A workspace counts the sessions started in its folders or below; a linked git worktree counts toward its main repository, the same way the CLI files it.
  • Native look. Follows your light, dark or high contrast theme in VS Code and its forks, in English, French, Japanese, Korean and Chinese (Simplified and Traditional), following the editor's display language.

Commands

All under CodeBurn in the Command Palette:

Command What it does
Open Dashboard Opens the dashboard in an editor tab
Refresh Re-reads usage for the status bar, the summary and the dashboard
Show Today Opens the Overview on today
Show This Workspace Scopes the dashboard to this workspace's projects
Show All Projects Scopes the dashboard to every project
Open Optimize Opens the Optimize findings
Copy Summary Copies a plain-text summary for a chat or a standup note
Open Settings Opens CodeBurn's settings
Star on GitHub Opens CodeBurn's GitHub page

Settings

Setting Default
codeburn.workspaceOnly true Open the dashboard on this workspace's projects
codeburn.defaultPeriod today The period the dashboard opens on
codeburn.refreshInterval 1m manual, 30s, 1m, 3m, 5m or 10m. Only a focused window or a visible summary refreshes
codeburn.statusBar.format cost cost, costAndQuota, workspace or hidden
codeburn.currency empty A three-letter code. Changes the CodeBurn CLI's currency, shared with every CodeBurn app
codeburn.provider all Count one provider in the status bar and summary
codeburn.quotaProviders all Plans whose quota CodeBurn checks
codeburn.nodePath empty A Node.js 22.13+ to run the CLI with, if the editor's own is too old

Requirements

Nothing to install. The CodeBurn CLI ships inside the extension and runs on the editor's built-in Node.js. Current VS Code, Cursor and Antigravity ship Node 24, which is all the CLI needs.

On an older editor whose Node is below 22.13, CodeBurn looks for a Node.js 22.13 or later on your machine and uses that. If there is none, it runs on the editor's Node and says which tools it cannot read: Cursor, OpenCode and Copilot usage needs node:sqlite. Install Node 22 or set codeburn.nodePath.

Privacy

  • Session logs are read locally by the bundled CLI. Your prompts, code, file names and project names never leave your machine.
  • The extension has no telemetry.
  • The bundled CLI makes the same few requests it makes anywhere: model prices from LiteLLM and exchange rates (for a non-USD currency), each at most once a day, and, if you use Cursor, your own usage export from cursor.com with the Cursor app's login. "cursorSync": false in ~/.config/codeburn/config.json turns that off.
  • Some dashboard actions reach the network only when you run them: scanning your local network for other devices, sharing a report, pushing usage to your own OTLP endpoint (sync, off until you set it up) and adding a plugin.
  • Plan quotas are read from each provider's own API with the login already on your machine, the same requests the CodeBurn desktop app makes. Remove a provider from codeburn.quotaProviders to stop them.

Works in

VS Code 1.82 or later, and the editors built on it: Cursor, Windsurf, Antigravity and VSCodium. Uses no proposed APIs.

More

CodeBurn is open source under the MIT license: github.com/getagentseal/codeburn. The same data is in the CLI (npx codeburn), the desktop app and the menu bar apps.