WorkspaceGPT Extension Docs
Everything you need to install, configure, and get the most out of WorkspaceGPT inside VS Code or Cursor.
Privacy-First
100% local with Ollama — no data leaves your machine. Cloud providers available optionally.
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.
Via Extensions Marketplace
Open VS Code or Cursor 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.
Minimum VS Code version: 1.98.0. WorkspaceGPT activates automatically on startup (onStartupFinished).
AI Providers
Choose between fully local operation with Ollama or cloud-based providers for maximum capability.
| 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 Indexing
WorkspaceGPT indexes your local workspace files so you can chat with your own code.
Open the Codebase panel
In the WorkspaceGPT sidebar, go to Settings → Codebase.
Start Sync
Click Start Sync. The extension will walk the workspace folder tree, generate embeddings using the bundled local model (all-MiniLM-L6-v2), and store them in VS Code's global storage.
Chat with your code
Once indexing is complete, your questions will automatically draw context from your codebase alongside any other connected data sources.
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.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.
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.