GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

microsoft/hve-core

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
83a260607c12fda28c813d44de416bad498156ff

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

hve-core/docs/getting-started/methods

docs/getting-started/methods/git-ignored.md

294lines · modecode

RawDownload
Latest commit unavailable.
1---
2title: Git-Ignored Folder Installation
3description: Install HVE Core in a git-ignored folder for devcontainer environments
4sidebar_position: 3
5author: Microsoft
6ms.date: 2026-06-11
7ms.topic: how-to
8keywords:
9 - git-ignored
10 - installation
11 - github copilot
12 - devcontainer
13estimated_reading_time: 6
14---
15
16Git-Ignored Folder installation places HVE Core inside your project in a `.hve-core/` folder that's excluded from version control. This is ideal for solo developers using devcontainers who want a self-contained setup.
17
18## When to Use This Method
19
20✅ **Use this when:**
21
22* You use local devcontainers (Docker Desktop)
23* You're working solo
24* You want HVE Core auto-updated with container rebuilds
25* You want a self-contained project (no external dependencies)
26
27❌ **Consider alternatives when:**
28
29* Your team needs version control → [Submodule](submodule.md)
30* You use Codespaces → [GitHub Codespaces](codespaces.md)
31* You want to share HVE Core across projects → [Mounted Directory](mounted.md)
32* You need paths that work everywhere → [Multi-Root Workspace](multi-root.md)
33
34## How It Works
35
36HVE Core is cloned into a `.hve-core/` folder inside your project. The folder is added to `.gitignore` so it doesn't pollute your repository.
37
38```text
39my-project/
40├── .devcontainer/
41│ └── devcontainer.json # postCreateCommand clones HVE Core
42├── .hve-core/ # Git-ignored, contains HVE Core
43│ └── .github/
44│ ├── agents/
45│ ├── prompts/
46│ └── instructions/
47├── .gitignore # Includes .hve-core/
48├── .vscode/
49│ └── settings.json # Points to .hve-core paths
50└── src/
51```
52
53## Quick Start
54
55Install the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-core) for the fastest setup. For guided setup with installation method selection and MCP configuration, 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". Use the manual steps below for direct configuration.
56
57## Manual Setup
58
59### Step 1: Update .gitignore
60
61Add the HVE Core folder to your `.gitignore`:
62
63```text
64# HVE Core installation (local only)
65.hve-core/
66```
67
68### Step 2: Clone HVE Core
69
70#### PowerShell
71
72```powershell
73# Create folder and clone
74$hveCoreFolder = ".hve-core"
75if (-not (Test-Path $hveCoreFolder)) {
76 git clone https://github.com/microsoft/hve-core.git $hveCoreFolder
77 Write-Host "✅ Cloned HVE Core to $hveCoreFolder"
78}
79```
80
81#### Bash
82
83```bash
84HVE_CORE_FOLDER=".hve-core"
85
86if [ ! -d "$HVE_CORE_FOLDER" ]; then
87 git clone https://github.com/microsoft/hve-core.git "$HVE_CORE_FOLDER"
88 echo "✅ Cloned HVE Core to $HVE_CORE_FOLDER"
89fi
90```
91
92### Step 3: Update VS Code Settings
93
94Create or update `.vscode/settings.json`:
95
96```json
97{
98 "chat.agentFilesLocations": {
99 ".hve-core/.github/agents/ado": true,
100 ".hve-core/.github/agents/data-science": true,
101 ".hve-core/.github/agents/design-thinking": true,
102 ".hve-core/.github/agents/github": true,
103 ".hve-core/.github/agents/project-planning": true,
104 ".hve-core/.github/agents/hve-core": true,
105 ".hve-core/.github/agents/hve-core/subagents": true,
106 ".hve-core/.github/agents/security": true
107 },
108 "chat.promptFilesLocations": {
109 ".hve-core/.github/prompts/ado": true,
110 ".hve-core/.github/prompts/design-thinking": true,
111 ".hve-core/.github/prompts/github": true,
112 ".hve-core/.github/prompts/hve-core": true,
113 ".hve-core/.github/prompts/security": true
114 },
115 "chat.instructionsFilesLocations": {
116 ".hve-core/.github/instructions/ado": true,
117 ".hve-core/.github/instructions/coding-standards": true,
118 ".hve-core/.github/instructions/github": true,
119 ".hve-core/.github/instructions/hve-core": true,
120 ".hve-core/.github/instructions/shared": true
121 },
122 "chat.agentSkillsLocations": {
123 ".hve-core/.github/skills": true,
124 ".hve-core/.github/skills/shared": true,
125 ".hve-core/.github/skills/coding-standards": true,
126 ".hve-core/.github/skills/design-thinking": true
127 }
128}
129```
130
131### Step 4: Automate with Devcontainer
132
133Add to `.devcontainer/devcontainer.json` so HVE Core is cloned on container creation:
134
135```jsonc
136{
137 // ... existing configuration ...
138
139 "postCreateCommand": "[ -d .hve-core ] || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
140}
141```
142
143### Step 5: Validate Installation
144
1451. Rebuild your devcontainer (`Ctrl+Shift+P` → "Dev Containers: Rebuild Container")
1462. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
1473. Click the agent picker dropdown
1484. Verify HVE Core agents appear (task-planner, task-researcher, prompt-builder)
149
150## Complete Devcontainer Example
151
152```jsonc
153{
154 "name": "My Project with HVE Core",
155 "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
156
157 "postCreateCommand": "[ -d .hve-core ] || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core",
158
159 "customizations": {
160 "vscode": {
161 "settings": {
162 "chat.agentFilesLocations": {
163 ".hve-core/.github/agents/ado": true,
164 ".hve-core/.github/agents/data-science": true,
165 ".hve-core/.github/agents/design-thinking": true,
166 ".hve-core/.github/agents/github": true,
167 ".hve-core/.github/agents/project-planning": true,
168 ".hve-core/.github/agents/hve-core": true,
169 ".hve-core/.github/agents/hve-core/subagents": true,
170 ".hve-core/.github/agents/security": true
171 },
172 "chat.promptFilesLocations": {
173 ".hve-core/.github/prompts/ado": true,
174 ".hve-core/.github/prompts/design-thinking": true,
175 ".hve-core/.github/prompts/github": true,
176 ".hve-core/.github/prompts/hve-core": true,
177 ".hve-core/.github/prompts/security": true
178 },
179 "chat.instructionsFilesLocations": {
180 ".hve-core/.github/instructions/ado": true,
181 ".hve-core/.github/instructions/coding-standards": true,
182 ".hve-core/.github/instructions/github": true,
183 ".hve-core/.github/instructions/hve-core": true,
184 ".hve-core/.github/instructions/shared": true
185 },
186 "chat.agentSkillsLocations": {
187 ".hve-core/.github/skills": true,
188 ".hve-core/.github/skills/shared": true,
189 ".hve-core/.github/skills/coding-standards": true,
190 ".hve-core/.github/skills/design-thinking": true
191 }
192 }
193 }
194 }
195}
196```
197
198## Updating HVE Core
199
200### Manual update
201
202```bash
203cd .hve-core
204git pull
205```
206
207### Auto-update on container rebuild
208
209The `postCreateCommand` re-clones on each container creation. To update, rebuild the container.
210
211### Auto-update with version check
212
213```jsonc
214{
215 "postCreateCommand": {
216 "clone-or-update": "[ -d .hve-core ] && (cd .hve-core && git pull) || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
217 }
218}
219```
220
221## Troubleshooting
222
223### Agents Not Appearing
224
225#### Check the folder exists
226
227```bash
228ls .hve-core/.github/agents
229```
230
231#### Check settings are applied
232
2331. Open Command Palette (`Ctrl+Shift+P`)
2342. Type "Preferences: Open Workspace Settings (JSON)"
2353. Verify the paths are correct
236
237### Folder Not Ignored by Git
238
239Check your `.gitignore` includes `.hve-core/`:
240
241```bash
242cat .gitignore | grep hve-core
243```
244
245If missing, add it:
246
247```bash
248echo ".hve-core/" >> .gitignore
249```
250
251### Clone Fails in Devcontainer
252
253If `postCreateCommand` fails, check:
254
2551. Network connectivity in the container
2562. Git is available (`git --version`)
2573. GitHub is accessible (`curl -I https://github.com`)
258
259### Container Rebuild Doesn't Update
260
261The clone only happens if the folder doesn't exist. To force update:
262
263```jsonc
264{
265 "postCreateCommand": "rm -rf .hve-core && git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
266}
267```
268
269**Warning:** This deletes any local changes to HVE Core on every rebuild.
270
271## Limitations
272
273| Aspect | Status |
274|------------------|--------------------------------------------------------------------|
275| Devcontainers | ✅ Designed for this |
276| Codespaces | ⚠️ Works but not optimal (use [Codespaces method](codespaces.md)) |
277| Team sharing | ⚠️ Each developer clones separately |
278| Portable paths | ✅ Relative paths work |
279| Version pinning | ⚠️ Manual (modify clone command) |
280| Disk usage | ⚠️ Per-project copy |
281| Setup complexity | ✅ Simple |
282
283## Next Steps
284
285* [Your First Workflow](../first-workflow.md) - Try HVE Core with a real task
286* [Multi-Root Workspace](multi-root.md) - Share across local + Codespaces
287* [Submodule](submodule.md) - Add version control for teams
288
289---
290
291<!-- markdownlint-disable MD036 -->
292*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,
293then carefully refined by our team of discerning human reviewers.*
294<!-- markdownlint-enable MD036 -->