microsoft/hve-core

Public

mirrored fromhttps://github.com/microsoft/hve-coreAvailable

Watch0 Fork0 Star0

Code Commits Issues Pull requests Actions Insights Security

hve-core-v3.3.10

Find a branch or tag

Branches

hve-core-v3.3.10

Clone

HTTPS

Download ZIP

hve-core/docs/getting-started/methods

docs/getting-started/methods/extension.md

305lines · modecode

Raw Download

docs(onboarding): overhaul marketplace onboarding and documentation site (#982)4309e10

3 months ago

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

microsoft/hve-core

Branches

Tags

Clone