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
b3fcbb5d710029cb4fe91fca91c5ebf46bfb362e

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

298lines · modecode

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