VS Code Extension

Run Alveare specialists directly from your editor. Select text, pick a specialist, and see results inline.

Installation

  1. Open VS Code
  2. Go to the Extensions panel (Cmd+Shift+X on macOS, Ctrl+Shift+X on Windows/Linux)
  3. Search for "Alveare"
  4. Click Install

Or install from the command line:

bash
code --install-extension alveare.alveare-vscode

Configuration

Set your API key in VS Code settings. Open settings (Cmd+,) and search for "Alveare", or add directly to settings.json:

json — settings.json
{
  "alveare.apiKey": "alv_live_abc123...",
  "alveare.baseUrl": "https://api.alveare.ai",
  "alveare.defaultTemperature": 0.7,
  "alveare.defaultMaxTokens": 512
}

For team use, set alveare.apiKey in your User settings (not Workspace) so it is not committed to version control. You can also use the ALVEARE_API_KEY environment variable.

Features

Usage: Right-click menu

Screenshot: Context menu
A dark VS Code editor with Python code selected. The right-click context menu is open, showing "Alveare: Run Specialist" near the bottom. A sub-menu shows the specialist options: Classify, Summarise, Extract, Q&A, Chat, Code.

Select any text in your editor, right-click, and choose a specialist. The extension sends the selected text to the API and displays the result.

Usage: Command palette

Screenshot: Command palette
The VS Code command palette is open with "Alveare" typed. The dropdown shows: "Alveare: Summarise Selection", "Alveare: Classify Selection", "Alveare: Extract from Selection", "Alveare: Ask Question", "Alveare: Generate Code", "Alveare: Run Custom Specialist".

Available commands:

Results panel

Screenshot: Results panel
VS Code with a split view. On the left, a document with text. On the right, the "Alveare Results" panel showing a summarisation result. The result text has a header showing "summarise - 142 tokens - 312ms". Below is the formatted summary text. A "Copy" button is in the top-right corner of the panel.

The results panel shows:

Inline diff view

Screenshot: Diff view
VS Code showing a side-by-side diff. The left side shows the original Python function with a bug. The right side shows the Alveare-suggested fix with the corrected line highlighted in green. At the top of the diff, buttons read "Accept Changes" and "Dismiss".

When you run the Code specialist on selected code (refactor, fix bugs, add types), the extension opens a diff view so you can review changes before accepting them. This is similar to VS Code's built-in merge editor.

Keyboard shortcuts

Default keybindings (customisable in Keyboard Shortcuts settings):

The extension requires VS Code 1.80 or later. It works with VS Code, VS Code Insiders, and Cursor.