Novum Startup Tracker (VS Code / Cursor)
Sends heartbeats from your editor to your Novum Startup
server so your team can see IDE activity on Dashboard → IDE integration, map
workspaces to projects, and optionally convert ranges into time entries.
Install
- VS Code — search "Novum Startup Tracker" in the Extensions view, or
install from the Visual Studio Marketplace.
- Cursor / VSCodium / Windsurf — search the Extensions view (these editors use
the Open VSX Registry).
Setup
The easiest path: open Novum Startup → Settings → API keys in the web app and
click Connect to VS Code / Cursor. That generates a key and hands it to the
extension automatically.
To configure manually, open Settings → Extensions → Novum Startup (or edit
settings.json under the novum.* keys):
| Key |
Purpose |
novum.apiKey |
API key from the web app (shown once when generated). |
novum.apiUrl |
Server origin, e.g. https://novumstartup.com (no trailing slash). |
novum.enabled |
Master toggle. |
novum.idleThresholdMinutes |
Pause interval heartbeats after this many minutes without typing (default 5). |
novum.excludePatterns |
Glob patterns; matching paths skip file/language in heartbeats. |
The status bar shows Novum: Xh Ym and an active/idle indicator.
What gets sent
Each heartbeat is a small JSON payload to POST <apiUrl>/api/ide/heartbeat,
authenticated with your API key. It includes: editor name, active file path
(relative to the workspace, unless excluded), language id, git branch, latest
commit hash + author email, workspace folder name, a duration in seconds, and a
timestamp. Heartbeats only fire while you're active; files matching
novum.excludePatterns are omitted.
Development
npm install
npm run compile
Press F5 in VS Code to launch an Extension Development Host and test against
your Novum Startup server.