Polaris Extension

VS Code extension for Polaris — your team's north star for coordination.

Setup

1. Install dependencies:

npm install

2. Compile TypeScript:

npm run compile

Run

1. Open the extension folder in VS Code
2. Press F5 to launch Extension Development Host
3. Configure settings in the Extension Development Host:
   • Open Settings (Cmd+,)
   • Search for "Polaris"
   • Polaris: Workspace Id is optional (the extension now derives it from the git repo/origin unless you need a multi-repo namespace)
   • Set Polaris: Api Base Url (default: https://api.polaris-dev.co)
4. Connect with API key directly from the Polaris sidebar:
   • Open the Polaris icon in the VS Code activity bar
   • Use the Connect view and paste your pk_... key
   • Click Save API Key (no Command Palette required)
   • Open Dashboard opens https://polaris-dev.co/dashboard by default (override with polaris.dashboardUrl if needed)

Features

• Automatic heartbeat every 2.5 seconds (configurable)
• Immediate heartbeat on file save
• Detects repo_id from the git remote origin URL when available (falls back to folder name/hash)
• Detects current git branch
• Tracks active file
• Device ID persisted in global state
• Command: "Polaris: Dump Status" to view current configuration

Settings

• polaris.apiBaseUrl - Backend API URL (default: https://api.polaris-dev.co)
• polaris.dashboardUrl - Dashboard URL (default: https://polaris-dev.co/dashboard)
• polaris.workspaceId - Workspace identifier (optional; derived from repo_id when left empty)
• polaris.repoIdMode - Repo ID mode: "folderName" or "hash" (default: folderName) (used when no git origin is available)
• polaris.intervalMs - Heartbeat interval in milliseconds (default: 2500)

Commands

• Polaris: Dump Status - Display current device_id, workspace_id, repo_id, branch, and settings

Development

Watch mode for automatic compilation:

npm run watch