microsoft/hve-core

Public

mirrored from https://github.com/microsoft/hve-coreAvailable

Watch0 Fork0 Star0

Code Commits Issues Pull requests Actions Insights Security

cbaa4a97f566ee024b8ba6aabd798ddb329a8e0f

Find a branch or tag

Branches

cbaa4a97f566ee024b8ba6aabd798ddb329a8e0f

Clone

HTTPS

Download ZIP

hve-core/docs/getting-started/methods

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

244lines · modecode

Raw Download

Latest commit unavailable.

unknown

1	`---`
2	`title: Git-Ignored Folder Installation`
3	`description: Install HVE-Core in a git-ignored folder for devcontainer environments`
4	`author: Microsoft`
5	`ms.date: 2025-12-03`
6	`ms.topic: how-to`
7	`keywords:`
8	`- git-ignored`
9	`- installation`
10	`- github copilot`
11	`- devcontainer`
12	`estimated_reading_time: 6`
13	`---`
14
15	Git-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
35	HVE-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
38	`my-project/`
39	`├── .devcontainer/`
40	`│ └── devcontainer.json # postCreateCommand clones HVE-Core`
41	`├── .hve-core/ # Git-ignored, contains HVE-Core`
42	`│ └── .github/`
43	`│ ├── chatmodes/`
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
54	Use the `hve-core-installer` agent:
55
56	1. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
57	2. Select `hve-core-installer` from the agent picker
58	`3. Say: "Install HVE-Core using git-ignored folder"`
59	`4. Follow the guided setup`
60
61	`## Manual Setup`
62
63	`### Step 1: Update .gitignore`
64
65	Add 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"`
79	`if (-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
88	`HVE_CORE_FOLDER=".hve-core"`
89
90	`if [ ! -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"`
93	`fi`
94	```
95
96	`### Step 3: Update VS Code Settings`
97
98	Create or update `.vscode/settings.json`:
99
100	```json
101	`{`
102	`"chat.modeFilesLocations": { ".hve-core/.github/chatmodes": true },`
103	`"chat.promptFilesLocations": { ".hve-core/.github/prompts": true },`
104	`"chat.instructionsFilesLocations": { ".hve-core/.github/instructions": true }`
105	`}`
106	```
107
108	`### Step 4: Automate with Devcontainer`
109
110	Add to `.devcontainer/devcontainer.json` so HVE-Core is cloned on container creation:
111
112	```jsonc
113	`{`
114	`// ... existing configuration ...`
115
116	`"postCreateCommand": "[ -d .hve-core ] \|\| git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"`
117	`}`
118	```
119
120	`### Step 5: Validate Installation`
121
122	1. Rebuild your devcontainer (`Ctrl+Shift+P` → "Dev Containers: Rebuild Container")
123	2. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
124	`3. Click the agent picker dropdown`
125	`4. Verify HVE-Core agents appear (task-planner, task-researcher, prompt-builder)`
126
127	`## Complete Devcontainer Example`
128
129	```jsonc
130	`{`
131	`"name": "My Project with HVE-Core",`
132	`"image": "mcr.microsoft.com/devcontainers/base:ubuntu",`
133
134	`"postCreateCommand": "[ -d .hve-core ] \|\| git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core",`
135
136	`"customizations": {`
137	`"vscode": {`
138	`"settings": {`
139	`"chat.modeFilesLocations": { ".hve-core/.github/chatmodes": true },`
140	`"chat.promptFilesLocations": { ".hve-core/.github/prompts": true },`
141	`"chat.instructionsFilesLocations": { ".hve-core/.github/instructions": true }`
142	`}`
143	`}`
144	`}`
145	`}`
146	```
147
148	`## Updating HVE-Core`
149
150	`Manual update:`
151
152	```bash
153	`cd .hve-core`
154	`git pull`
155	```
156
157	`Auto-update on container rebuild:`
158
159	The `postCreateCommand` re-clones on each container creation. To update, rebuild the container.
160
161	`Auto-update with version check:`
162
163	```jsonc
164	`{`
165	`"postCreateCommand": {`
166	`"clone-or-update": "[ -d .hve-core ] && (cd .hve-core && git pull) \|\| git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"`
167	`}`
168	`}`
169	```
170
171	`## Troubleshooting`
172
173	`### Agents Not Appearing`
174
175	`Check the folder exists:`
176
177	```bash
178	`ls .hve-core/.github/chatmodes`
179	```
180
181	`Check settings are applied:`
182
183	1. Open Command Palette (`Ctrl+Shift+P`)
184	`2. Type "Preferences: Open Workspace Settings (JSON)"`
185	`3. Verify the paths are correct`
186
187	`### Folder Not Ignored by Git`
188
189	Check your `.gitignore` includes `.hve-core/`:
190
191	```bash
192	`cat .gitignore \| grep hve-core`
193	```
194
195	`If missing, add it:`
196
197	```bash
198	`echo ".hve-core/" >> .gitignore`
199	```
200
201	`### Clone Fails in Devcontainer`
202
203	If `postCreateCommand` fails, check:
204
205	`1. Network connectivity in the container`
206	2. Git is available (`git --version`)
207	3. GitHub is accessible (`curl -I https://github.com`)
208
209	`### Container Rebuild Doesn't Update`
210
211	`The clone only happens if the folder doesn't exist. To force update:`
212
213	```jsonc
214	`{`
215	`"postCreateCommand": "rm -rf .hve-core && git clone --depth 1 https://github.com/microsoft/hve-core.git .hve-core"`
216	`}`
217	```
218
219	`Warning: This deletes any local changes to HVE-Core on every rebuild.`
220
221	`## Limitations`
222
223	`\| Aspect \| Status \|`
224	`\|------------------\|--------------------------------------------------------------------\|`
225	`\| Devcontainers \| ✅ Designed for this \|`
226	`\| Codespaces \| ⚠️ Works but not optimal (use [Codespaces method](codespaces.md)) \|`
227	`\| Team sharing \| ⚠️ Each developer clones separately \|`
228	`\| Portable paths \| ✅ Relative paths work \|`
229	`\| Version pinning \| ⚠️ Manual (modify clone command) \|`
230	`\| Disk usage \| ⚠️ Per-project copy \|`
231	`\| Setup complexity \| ✅ Simple \|`
232
233	`## Next Steps`
234
235	`* [Your First Workflow](../first-workflow.md) - Try HVE-Core with a real task`
236	`* [Multi-Root Workspace](multi-root.md) - Share across local + Codespaces`
237	`* [Submodule](submodule.md) - Add version control for teams`
238
239	`---`
240
241	`<!-- markdownlint-disable MD036 -->`
242	`*🤖 Crafted with precision by ✨GitHub Copilot following brilliant human instruction,`
243	`then carefully refined by our team of discerning human reviewers.*`
244	`<!-- markdownlint-enable MD036 -->`
245

microsoft/hve-core

Branches

Tags

Clone