WorkspaceGPT Extension Docs
Everything you need to install, configure, and get the most out of WorkspaceGPT inside VS Code, Cursor, or Antigravity.
Privacy-First
Indexing and embeddings run on-device and the vector index stays in local files — in both modes. We retain nothing.
RAG-Powered
Retrieval-Augmented Generation over your codebase, Confluence docs, and ADO tickets.
Zero Setup
Install from the marketplace and start chatting in under 2 minutes.
Installation
Available in the VS Code and Cursor marketplaces, and on Open VSX for Antigravity.
Via Extensions Marketplace
Open VS Code, Cursor, or Antigravity and navigate to the Extensions view:
Ctrl+Shift+X or Cmd+Shift+X on macOS
Search for WorkspaceGPT and click Install.
Via Command Palette
Press Ctrl+P to open Quick Open and run:
ext install Riteshkant.workspacegpt-extension
Via Marketplace Website
Visit the VS Code Marketplace page and click Install.
On Antigravity (or other VS Code forks)
Antigravity, Windsurf, and VSCodium install from Open VSX instead of the Microsoft Marketplace. Search WorkspaceGPT in the Extensions view, or open the Open VSX page and click Download.
Minimum VS Code version: 1.98.0. WorkspaceGPT activates automatically on startup (onStartupFinished).
Modes & Privacy
WorkspaceGPT has exactly one mode switch, under Settings → Mode. It changes where answers are generated — nothing else.
Local
Everything runs on your machine: the chat model, the embeddings, the index, the retrieval.
Use Ollama for a fully offline setup, or supply your own key for OpenAI, Gemini, Groq, OpenRouter, NVIDIA, or any OpenAI-compatible endpoint. No WorkspaceGPT account needed.
Remote
We run the inference infrastructure and pick the model, so there is no provider key to buy and nothing to configure.
Sign in with GitHub once. Your question and the snippets retrieved for it are sent to our endpoint per request; your documents, code and index stay on your machine.
What each mode sends
| Local | Remote | |
|---|---|---|
| Documents, code, work items | Never leave your machine | Never leave your machine |
| Embeddings | Generated on-device | Generated on-device |
| Vector index | Local files | Local files |
| Question + retrieved snippets | To your chosen provider, or nowhere with Ollama | To our endpoint, then the upstream model |
| Account | None | GitHub sign-in, verified per request |
| Model keys you supply | Yours, or none with Ollama | None |
| Stored by WorkspaceGPT | Nothing | Nothing but your account row |
Zero data retention
In Remote mode your request is held in memory only for as long as it takes to stream the answer back, then discarded. We do not write prompts, answers, or retrieved snippets to any database, any file, or any log — our servers log status codes and error types only. The entirety of what we store per account is: your GitHub id and handle, your plan and status, an opaque session token that expires in 30 days, and a count of how many requests you made today.
Generation itself is performed by an upstream model provider (currently OpenRouter) under its own policy. If you need a guarantee that covers the whole path contractually, use Local mode with Ollama — no third party is involved at all. Full detail in the privacy policy.
Settings → Account.AI Providers
These apply to Local mode, where you bring your own model. In Remote mode there is no provider to choose — we run the model for you (see Modes & Privacy).
| Provider | Privacy | Requires API Key | Notes |
|---|---|---|---|
| Ollama | 100% Local | No | Default. Run llama3.2:1b or any local model. |
| OpenAI | Cloud | Yes | GPT-4o, GPT-4-turbo, GPT-3.5 etc. |
| Gemini | Cloud | Yes | Google's Gemini Pro/Flash models. |
| Groq | Cloud | Yes | High-speed inference on Llama / Mixtral. |
| OpenRouter | Cloud | Yes | Access 100+ models via one API key. |
| Requestly | Cloud | Yes | Custom API endpoint proxy integration. |
Configuring Ollama (Recommended)
Install Ollama
Download from ollama.com and follow the installer for your OS.
Pull a model
ollama pull llama3.2:1b
For better responses, try a larger model:
ollama pull llama3.2:4b # or ollama pull gemma3:4b # or ollama pull mistral
Select in WorkspaceGPT
Open the WorkspaceGPT sidebar → Settings → Providers → Ollama. Your locally running models will appear automatically.
Configuring Cloud Providers
Open Settings → Providers, select your provider, and paste your API key. Keys are stored securely in VS Code's secret storage and never logged.
Codebase Exploration
WorkspaceGPT explores the folder currently open in your editor with live search, file reads, and language-server navigation.
Open a workspace folder
Open the repository you want to discuss in VS Code, Cursor, or Antigravity.
Ask about the code
Ask a question in WorkspaceGPT. The agent searches and reads relevant files as it works, and can follow symbols and references through your editor's language service.
Review cited findings
Use the returned file references to inspect the live workspace context behind the answer.
Embeddings & Vector Storage
Connected Confluence and Azure DevOps sources are turned into vector embeddings so WorkspaceGPT can retrieve the right context. Both halves — making the embeddings and storing them — happen entirely on your machine, in either mode.
Embedding model
| Provider | Model | API key | Best for |
|---|---|---|---|
| Text Bundled | Xenova/all-MiniLM-L6-v2 (384-dim) | Not needed | Confluence pages and ADO work items. Runs on-device; first run downloads ~200 MB. |
Nothing to configure — the models ship with the extension and are used automatically.
Vector storage
Local files, on this machine
Vectors are written to binary files in the extension's own storage directory. They are never uploaded, mirrored, or backed up by us.
Clear them any time with Settings → Reset or the Clear Data command.
Confluence Integration
Connect your Atlassian Confluence space with one-click OAuth 2.0 authentication.
Open Confluence settings
In the WorkspaceGPT sidebar, navigate to Settings → Confluence Integration.
Sign in with Atlassian
Click Sign In. A browser window will open to Atlassian's OAuth consent screen. Sign in and grant access — no passwords are stored.
The extension spins up a short-lived local HTTP server to capture the OAuth callback securely.
Select a space
After authentication, your accessible Confluence sites and spaces will load. Select the spaces you want to index.
Start Sync
Click Start Sync. Pages are fetched, converted to Markdown, embedded, and stored locally. Progress is shown in real-time.
Automatic background sync
The ConfluenceSyncScheduler starts automatically on extension activation and keeps your index up-to-date in the background.
Token security
OAuth access + refresh tokens are stored in VS Code's encrypted context.secrets — never in plaintext settings.
Disconnect anytime
Go to Settings → Confluence → Disconnect to revoke access and clear all synced data.
Azure DevOps Integration
Connect Azure DevOps to chat with work items, user stories, and pull requests.
Generate a Personal Access Token (PAT)
In Azure DevOps, go to User Settings → Personal Access Tokens → New Token.
Grant at minimum: Work Items — Read Code — Read
Open ADO settings
In the WorkspaceGPT sidebar, go to Settings → Azure DevOps Integration.
Enter your organization URL and PAT
Provide your Azure DevOps organization URL (e.g. https://dev.azure.com/your-org) and the PAT you generated.
The PAT is stored in VS Code's context.secrets, never in globalState.
Select project and sync
Your ADO projects will load automatically. Select a project and click Start Sync.
Work items are embedded and indexed locally — no data is sent to third-party servers.
Basic base64(:PAT) (colon-prefixed PAT) as required by the Azure DevOps REST API.Deployment Automation
Turn the manual release checklist — syncing feature flags, env vars, and component versions across environments — into a reviewable, one-click pipeline. The model is inspired by AWS CodePipeline: a pluggable Source feeds ordered Stages of Actions. Nothing is hardwired to one team's setup.
Pluggable
Pick a source, then add only the deploy actions your org actually uses. No provider is baked in.
Plan → Approve → Apply
Every change is previewed as a diff you approve before anything is written. Backend changes open a PR — never an auto-merge.
Discover & select
Repos, workflows, projects, and table columns are detected from your connected accounts — choose from dropdowns, don't type IDs.
Full deployment guide
Sources, actions, connections (PAT/SSO + Vercel gotchas), the Releases workflow, environments, security, troubleshooting & FAQ.
MCP Server
WorkspaceGPT ships a built-in MCP (Model Context Protocol) server for GitHub Copilot and Claude Code integration.
Connect the MCP Server
Open the Command Palette (Cmd/Ctrl+Shift+P) and run:
WorkspaceGPT: Connect MCP Server
Use with GitHub Copilot or Claude
The MCP server is registered as a definition provider for Copilot Chat (@mcp). Once connected, Copilot and Claude can query your indexed data directly via the WorkspaceGPT context.
Chrome Extension
A browser side-panel that lets you (or a teammate) chat with your indexed Confluence pages and Azure DevOps work items — without opening VS Code. It runs entirely in the browser, talking directly to your providers; there's no WorkspaceGPT server in between.
New pairings are paused
The companion reads your vector index directly, and that index now lives only on your machine — so there is nothing for a browser on another device to connect to. The Share to Chrome action is hidden in the current extension, and the setup steps below cannot be completed on a fresh install. Existing paired installs keep working against whatever they were configured with. We will bring this back if and when a hosted index ships; the steps are kept here for reference and for anyone already set up.
Side panel
Ask questions and read grounded answers from a panel docked in Chrome.
One share code
Connect by pasting a single code generated in VS Code — no separate setup.
No server
Calls go browser → Gemini / Qdrant / your chat model directly. Nothing is proxied.
Prerequisites
Because the browser needs cloud-reachable services, the share flow required a cloud embedding provider, a Qdrant Cloud vector store, and a chat model with an API key, all configured in VS Code first. Indexing is now on-device only (see Embeddings & Vector Storage), which is exactly why pairing is paused.
Setup (for reference)
Install from the Chrome Web Store
Add WorkspaceGPT for Chrome to your browser.
Create a share code in VS Code
In the WorkspaceGPT sidebar, open Settings → Share to Chrome and click Create share code. It's copied to your clipboard.
This card is not shown in the current extension — see the notice above.
Paste it into the extension
Open the Chrome side panel → Settings → paste the code → Connect. You'll see a confirmation with your Qdrant URL.
Ask away
Close settings and chat. The extension mirrors VS Code's retrieval, so answers stay consistent across Confluence and ADO.
Treat the share code like a password
It contains your real Qdrant, Gemini, and chat-model API keys in plain form. Anyone with it can query your data and incur API costs. Share only with people you trust.
Write creds are never shared
GitHub, Vercel, Confluence, and ADO tokens stay in VS Code secret storage and are excluded from the bundle. The share is read-only knowledge access.
Commands & Keyboard Shortcuts
All commands are accessible from the Command Palette.
| Command | Shortcut | Description |
|---|---|---|
| WorkspaceGPT: Ask | Cmd+Shift+R / Ctrl+Shift+R | Open & focus the WorkspaceGPT chat panel. |
| WorkspaceGPT: New Chat | — | Start a fresh conversation, clearing history. |
| WorkspaceGPT: Settings | — | Open the settings panel inside the sidebar. |
| WorkspaceGPT: Chat History | — | Browse and restore previous chat sessions. |
| WorkspaceGPT: Connect MCP Server | — | Register the MCP server for Copilot / Claude. |
| WorkspaceGPT: Clear All Data and Cache | — | Wipe all embeddings, state, and tokens. |
Activity Bar & Title Bar Icons
New Chat
Click the + icon in the WorkspaceGPT title bar to start a new session.
Settings
The gear icon opens provider and integration configuration.
History
Browse, restore, or delete previous chat sessions.
Reset & Clear Data
WorkspaceGPT stores all data locally in VS Code's global storage. You can wipe everything at any time.
Via Command Palette
Run WorkspaceGPT: Clear All Data and Cache from the Command Palette. A confirmation prompt will appear.
Via Settings panel
Open Settings → Reset VSCode State inside the WorkspaceGPT sidebar.
Troubleshooting
Common issues and how to fix them.