microsoft/hve-core
Publicmirrored from https://github.com/microsoft/hve-coreAvailable
docs/getting-started/methods/extension.md
278lines · modecode
| 1 | --- |
| 2 | title: VS Code Extension Installation |
| 3 | description: Install HVE-Core as a VS Code extension from the marketplace |
| 4 | author: Microsoft |
| 5 | ms.date: 2026-01-07 |
| 6 | ms.topic: how-to |
| 7 | keywords: |
| 8 | - extension |
| 9 | - installation |
| 10 | - marketplace |
| 11 | - github copilot |
| 12 | estimated_reading_time: 4 |
| 13 | --- |
| 14 | |
| 15 | VS Code Extension installation provides HVE-Core directly through the VS Code Marketplace. This is the simplest zero-configuration method that works across all environments. |
| 16 | |
| 17 | ## When to Use This Method |
| 18 | |
| 19 | ✅ **Use this when:** |
| 20 | |
| 21 | * You want the simplest possible setup |
| 22 | * You don't need to customize HVE-Core components |
| 23 | * You work across different machines and environments |
| 24 | * You want automatic updates through VS Code |
| 25 | * You prefer marketplace-managed extensions |
| 26 | * You want a clean, zero-configuration setup |
| 27 | |
| 28 | ❌ **Consider alternatives when:** |
| 29 | |
| 30 | * You need to customize custom agents, prompts, or instructions → [Peer Clone](peer-clone.md) or [Git-Ignored](git-ignored.md) |
| 31 | * Your team needs to version control HVE-Core → [Submodule](submodule.md) |
| 32 | * You're contributing to HVE-Core development → [Peer Clone](peer-clone.md) |
| 33 | * You need to test pre-release versions → [Multi-Root Workspace](multi-root.md) |
| 34 | |
| 35 | ## How It Works |
| 36 | |
| 37 | The extension packages all HVE-Core components (chat agents, prompts, instructions) as a standard VS Code extension. Once installed, all components are immediately available without any additional configuration. |
| 38 | |
| 39 | ```text |
| 40 | VS Code Extension System |
| 41 | ├── Extension installed via marketplace |
| 42 | │ ├── .github/agents/ # All chat agents |
| 43 | │ ├── .github/prompts/ # All prompt templates |
| 44 | │ ├── .github/instructions/ # All coding guidelines |
| 45 | │ └── scripts/dev-tools/ # PR reference generation |
| 46 | └── No workspace configuration needed! |
| 47 | ``` |
| 48 | |
| 49 | ## Quick Start |
| 50 | |
| 51 | ### Option 1: Install from Marketplace (Recommended) |
| 52 | |
| 53 | 1. Open VS Code |
| 54 | 2. Go to Extensions view (`Ctrl+Shift+X`) |
| 55 | 3. Search for "HVE Core" |
| 56 | 4. Click **Install** |
| 57 | |
| 58 | **Or click here:** [Install HVE Core Extension](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-core) |
| 59 | |
| 60 | ### Option 2: Install from Command Line |
| 61 | |
| 62 | ```bash |
| 63 | code --install-extension ise-hve-essentials.hve-core |
| 64 | ``` |
| 65 | |
| 66 | ### Option 3: Install Using VS Code Insiders |
| 67 | |
| 68 | ```bash |
| 69 | code-insiders --install-extension ise-hve-essentials.hve-core |
| 70 | ``` |
| 71 | |
| 72 | ## Verification |
| 73 | |
| 74 | After installation, verify everything works: |
| 75 | |
| 76 | 1. Open GitHub Copilot Chat (`Ctrl+Alt+I`) |
| 77 | 2. Click the agent picker dropdown |
| 78 | 3. Verify HVE-Core agents appear: |
| 79 | * task-planner |
| 80 | * task-researcher |
| 81 | * task-implementor |
| 82 | * pr-review |
| 83 | * adr-creation |
| 84 | |
| 85 | ## Post-Installation: Update Your .gitignore |
| 86 | |
| 87 | HVE-Core agents create ephemeral workflow artifacts in a `.copilot-tracking/` folder within your project. Add this line to your project's `.gitignore`: |
| 88 | |
| 89 | ```text |
| 90 | .copilot-tracking/ |
| 91 | ``` |
| 92 | |
| 93 | > [!NOTE] |
| 94 | > This applies even when using the extension. The folder is created in your project directory when you use agents like `task-researcher` or `pr-review`. See the [installation guide](../install.md#post-installation-update-your-gitignore) for details on what gets stored there. |
| 95 | |
| 96 | ## What's Included |
| 97 | |
| 98 | The extension provides all HVE-Core components: |
| 99 | |
| 100 | | Component | Examples | |
| 101 | |--------------|-----------------------------------------| |
| 102 | | Chat Agents | task-planner, pr-review, adr-creation | |
| 103 | | Prompts | git-commit, pull-request, ado-create-pr | |
| 104 | | Instructions | markdown, python-script, commit-message | |
| 105 | | Dev Tools | Generate-PrReference.ps1, pr-ref-gen.sh | |
| 106 | |
| 107 | ## Updating |
| 108 | |
| 109 | The extension updates automatically through VS Code's extension system: |
| 110 | |
| 111 | * **Auto-updates (default):** Extensions update automatically when new versions are released |
| 112 | * **Manual updates:** Extensions view → Find "HVE Core" → Click **Update** |
| 113 | * **Pre-release versions:** Right-click extension → "Switch to Pre-Release Version" |
| 114 | |
| 115 | ## Comparison with Other Methods |
| 116 | |
| 117 | ### Pros ✅ |
| 118 | |
| 119 | * **Zero configuration** - No workspace settings or file cloning required |
| 120 | * **Works everywhere** - Local, devcontainers, Codespaces, any environment |
| 121 | * **Automatic updates** - VS Code manages updates seamlessly |
| 122 | * **No repository pollution** - Nothing added to your project |
| 123 | * **Instant availability** - Works immediately after installation |
| 124 | * **No manual setup** - No scripts to run or paths to configure |
| 125 | * **Marketplace managed** - Centralized distribution and versioning |
| 126 | |
| 127 | ### Cons ❌ |
| 128 | |
| 129 | * **No customization** - Can't modify custom agents, prompts, or instructions |
| 130 | * **Extension updates only** - Can't easily test development versions |
| 131 | * **No version pinning** - Uses latest version (or opt into pre-release) |
| 132 | * **No team control** - Can't enforce specific versions across team |
| 133 | * **Limited flexibility** - Can't combine with custom local modifications |
| 134 | |
| 135 | ## Common Scenarios |
| 136 | |
| 137 | ### Scenario 1: Quick Personal Use |
| 138 | |
| 139 | **Goal:** Start using HVE-Core immediately without setup |
| 140 | |
| 141 | **Solution:** Install the extension from marketplace |
| 142 | |
| 143 | **Steps:** |
| 144 | |
| 145 | 1. Install extension from marketplace |
| 146 | 2. Start using `@task-planner` and other agents |
| 147 | 3. That's it! |
| 148 | |
| 149 | ### Scenario 2: Multi-Machine Developer |
| 150 | |
| 151 | **Goal:** Use HVE-Core consistently across laptop, desktop, and Codespaces |
| 152 | |
| 153 | **Solution:** Install extension on all machines via Settings Sync |
| 154 | |
| 155 | **Steps:** |
| 156 | |
| 157 | 1. Enable Settings Sync in VS Code |
| 158 | 2. Install extension on one machine |
| 159 | 3. Extensions automatically sync to other devices |
| 160 | |
| 161 | ### Scenario 3: Team Adoption |
| 162 | |
| 163 | **Goal:** Get entire team using HVE-Core quickly |
| 164 | |
| 165 | **Solution:** Share extension link and install instructions |
| 166 | |
| 167 | **Steps:** |
| 168 | |
| 169 | 1. Share marketplace link with team |
| 170 | 2. Team members install extension |
| 171 | 3. Everyone has consistent experience immediately |
| 172 | |
| 173 | ### Scenario 4: Want to Customize Later |
| 174 | |
| 175 | **Goal:** Start with extension, later switch to customization |
| 176 | |
| 177 | **Solution:** Use extension initially, migrate to Peer Clone when needed |
| 178 | |
| 179 | **Steps:** |
| 180 | |
| 181 | 1. Start with extension for quick setup |
| 182 | 2. When customization needed, uninstall extension |
| 183 | 3. Follow [Peer Clone](peer-clone.md) method for local modifications |
| 184 | |
| 185 | ## Troubleshooting |
| 186 | |
| 187 | ### Extension Not Appearing |
| 188 | |
| 189 | **Check extension is installed:** |
| 190 | |
| 191 | 1. Open Extensions view (`Ctrl+Shift+X`) |
| 192 | 2. Search "HVE Core" |
| 193 | 3. Verify "Installed" badge appears |
| 194 | |
| 195 | **Reload VS Code:** |
| 196 | |
| 197 | 1. Command Palette (`Ctrl+Shift+P`) |
| 198 | 2. "Developer: Reload Window" |
| 199 | |
| 200 | ### Agents Not Showing in Copilot Chat |
| 201 | |
| 202 | **Verify GitHub Copilot is active:** |
| 203 | |
| 204 | 1. Check Copilot icon in status bar |
| 205 | 2. Sign in if needed |
| 206 | |
| 207 | **Check extension status:** |
| 208 | |
| 209 | 1. Extensions view → "HVE Core" |
| 210 | 2. Verify no errors shown |
| 211 | 3. Click "Show Extension Output" if issues |
| 212 | |
| 213 | ### Conflicting Installation Methods |
| 214 | |
| 215 | If you have both extension and manual installation (like Peer Clone): |
| 216 | |
| 217 | **Problem:** Duplicate agents appearing |
| 218 | |
| 219 | **Solution:** Choose one method: |
| 220 | |
| 221 | * Keep extension: Remove manual installation (delete cloned folder, remove workspace settings) |
| 222 | * Keep manual: Uninstall extension |
| 223 | |
| 224 | ### Update Not Appearing |
| 225 | |
| 226 | **Force check for updates:** |
| 227 | |
| 228 | 1. Extensions view → ⋯ (More Actions) |
| 229 | 2. "Check for Extension Updates" |
| 230 | |
| 231 | **Manually update:** |
| 232 | |
| 233 | 1. Extensions view → Find "HVE Core" |
| 234 | 2. Click "Update" button |
| 235 | |
| 236 | ## Migration Guide |
| 237 | |
| 238 | ### From Manual Installation to Extension |
| 239 | |
| 240 | If you're currently using manual methods like Peer Clone: |
| 241 | |
| 242 | 1. **Remove workspace settings** - Delete HVE-Core paths from `.vscode/settings.json` |
| 243 | 2. **Optionally remove cloned folder** - Delete hve-core clone if no longer needed |
| 244 | 3. **Install extension** - Follow Quick Start above |
| 245 | 4. **Verify** - Test agents appear in Copilot Chat |
| 246 | |
| 247 | ### From Extension to Manual Installation |
| 248 | |
| 249 | If you need customization: |
| 250 | |
| 251 | 1. **Uninstall extension** - Extensions view → Uninstall "HVE Core" |
| 252 | 2. **Follow manual method** - See [Peer Clone](peer-clone.md) for local customization |
| 253 | 3. **Customize** - Edit custom agents, prompts, or instructions as needed |
| 254 | |
| 255 | ## Limitations |
| 256 | |
| 257 | | Aspect | Status | |
| 258 | |------------------|--------------------------------------------------| |
| 259 | | Customization | ❌ Cannot modify components | |
| 260 | | Version control | ⚠️ Extension updates only, no git control | |
| 261 | | Team enforcement | ⚠️ Each member installs independently | |
| 262 | | Dev/testing | ⚠️ Pre-release channel only, not custom branches | |
| 263 | | Portable paths | ✅ Works everywhere | |
| 264 | | Setup complexity | ✅ Simplest possible | |
| 265 | | Disk usage | ✅ Single installation across all projects | |
| 266 | |
| 267 | ## Next Steps |
| 268 | |
| 269 | * [Your First Workflow](../first-workflow.md) - Try HVE-Core with a real task |
| 270 | * [Multi-Root Workspace](multi-root.md) - Combine extension with custom components |
| 271 | * [Peer Clone](peer-clone.md) - Switch to customizable installation |
| 272 | |
| 273 | --- |
| 274 | |
| 275 | <!-- markdownlint-disable MD036 --> |
| 276 | *🤖 Crafted with precision by ✨GitHub Copilot following brilliant human instruction, |
| 277 | then carefully refined by our team of discerning human reviewers.* |
| 278 | <!-- markdownlint-enable MD036 --> |
| 279 | |