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
3a3a0fdf923d96a9e8a9ac734c73f24433b525e8

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

292lines · 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-03-10
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/design-thinking": true,
119 ".hve-core/.github/instructions/github": true,
120 ".hve-core/.github/instructions/hve-core": true,
121 ".hve-core/.github/instructions/shared": true
122 },
123 "chat.agentSkillsLocations": {
124 ".hve-core/.github/skills": true,
125 ".hve-core/.github/skills/shared": true
126 }
127}
128```
129
130### Step 4: Automate with Devcontainer
131
132Add to `.devcontainer/devcontainer.json` so HVE-Core is cloned on container creation:
133
134```jsonc
135{
136 // ... existing configuration ...
137
138 "postCreateCommand": "[ -d .hve-core ] || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
139}
140```
141
142### Step 5: Validate Installation
143
1441. Rebuild your devcontainer (`Ctrl+Shift+P` → "Dev Containers: Rebuild Container")
1452. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
1463. Click the agent picker dropdown
1474. Verify HVE-Core agents appear (task-planner, task-researcher, prompt-builder)
148
149## Complete Devcontainer Example
150
151```jsonc
152{
153 "name": "My Project with HVE-Core",
154 "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
155
156 "postCreateCommand": "[ -d .hve-core ] || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core",
157
158 "customizations": {
159 "vscode": {
160 "settings": {
161 "chat.agentFilesLocations": {
162 ".hve-core/.github/agents/ado": true,
163 ".hve-core/.github/agents/data-science": true,
164 ".hve-core/.github/agents/design-thinking": true,
165 ".hve-core/.github/agents/github": true,
166 ".hve-core/.github/agents/project-planning": true,
167 ".hve-core/.github/agents/hve-core": true,
168 ".hve-core/.github/agents/hve-core/subagents": true,
169 ".hve-core/.github/agents/security": true
170 },
171 "chat.promptFilesLocations": {
172 ".hve-core/.github/prompts/ado": true,
173 ".hve-core/.github/prompts/design-thinking": true,
174 ".hve-core/.github/prompts/github": true,
175 ".hve-core/.github/prompts/hve-core": true,
176 ".hve-core/.github/prompts/security": true
177 },
178 "chat.instructionsFilesLocations": {
179 ".hve-core/.github/instructions/ado": true,
180 ".hve-core/.github/instructions/coding-standards": true,
181 ".hve-core/.github/instructions/design-thinking": 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 }
190 }
191 }
192 }
193}
194```
195
196## Updating HVE-Core
197
198### Manual update
199
200```bash
201cd .hve-core
202git pull
203```
204
205### Auto-update on container rebuild
206
207The `postCreateCommand` re-clones on each container creation. To update, rebuild the container.
208
209### Auto-update with version check
210
211```jsonc
212{
213 "postCreateCommand": {
214 "clone-or-update": "[ -d .hve-core ] && (cd .hve-core && git pull) || git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
215 }
216}
217```
218
219## Troubleshooting
220
221### Agents Not Appearing
222
223#### Check the folder exists
224
225```bash
226ls .hve-core/.github/agents
227```
228
229#### Check settings are applied
230
2311. Open Command Palette (`Ctrl+Shift+P`)
2322. Type "Preferences: Open Workspace Settings (JSON)"
2333. Verify the paths are correct
234
235### Folder Not Ignored by Git
236
237Check your `.gitignore` includes `.hve-core/`:
238
239```bash
240cat .gitignore | grep hve-core
241```
242
243If missing, add it:
244
245```bash
246echo ".hve-core/" >> .gitignore
247```
248
249### Clone Fails in Devcontainer
250
251If `postCreateCommand` fails, check:
252
2531. Network connectivity in the container
2542. Git is available (`git --version`)
2553. GitHub is accessible (`curl -I https://github.com`)
256
257### Container Rebuild Doesn't Update
258
259The clone only happens if the folder doesn't exist. To force update:
260
261```jsonc
262{
263 "postCreateCommand": "rm -rf .hve-core && git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"
264}
265```
266
267**Warning:** This deletes any local changes to HVE-Core on every rebuild.
268
269## Limitations
270
271| Aspect | Status |
272|------------------|--------------------------------------------------------------------|
273| Devcontainers | ✅ Designed for this |
274| Codespaces | ⚠️ Works but not optimal (use [Codespaces method](codespaces.md)) |
275| Team sharing | ⚠️ Each developer clones separately |
276| Portable paths | ✅ Relative paths work |
277| Version pinning | ⚠️ Manual (modify clone command) |
278| Disk usage | ⚠️ Per-project copy |
279| Setup complexity | ✅ Simple |
280
281## Next Steps
282
283* [Your First Workflow](../first-workflow.md) - Try HVE-Core with a real task
284* [Multi-Root Workspace](multi-root.md) - Share across local + Codespaces
285* [Submodule](submodule.md) - Add version control for teams
286
287---
288
289<!-- markdownlint-disable MD036 -->
290*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,
291then carefully refined by our team of discerning human reviewers.*
292<!-- markdownlint-enable MD036 -->
293