microsoft/hve-core

Public

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

Watch0 Fork0 Star0

Code Commits Issues Pull requests Actions Insights Security

b3fcbb5d710029cb4fe91fca91c5ebf46bfb362e

Find a branch or tag

Branches

b3fcbb5d710029cb4fe91fca91c5ebf46bfb362e

Clone

HTTPS

Download ZIP

hve-core/docs/getting-started/methods

docs/getting-started/methods/peer-clone.md

210lines · modecode

Raw Download

Latest commit unavailable.

unknown

1	`---`
2	`title: Peer Directory Clone Installation`
3	`description: Install HVE-Core as a sibling directory for local VS Code development`
4	`author: Microsoft`
5	`ms.date: 2025-12-03`
6	`ms.topic: how-to`
7	`keywords:`
8	`- peer directory`
9	`- installation`
10	`- github copilot`
11	`- local development`
12	`estimated_reading_time: 5`
13	`---`
14
15	`Peer Directory Clone places HVE-Core as a sibling folder next to your project. This is the simplest method for developers working with local VS Code without devcontainers.`
16
17	`## When to Use This Method`
18
19	`✅ Use this when:`
20
21	`* You're using local VS Code (no devcontainer)`
22	`* You're working solo on a project`
23	`* You want the simplest possible setup`
24	`* You're developing or testing HVE-Core itself`
25
26	`❌ Consider alternatives when:`
27
28	`* You use devcontainers → [Git-Ignored Folder](git-ignored.md) or [Mounted Directory](mounted.md)`
29	`* You use Codespaces → [GitHub Codespaces](codespaces.md)`
30	`* Your team needs version control → [Submodule](submodule.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 sibling directory. Your project's VS Code settings reference it using relative paths.`
36
37	```text
38	`projects/`
39	`├── my-project/ # Your project`
40	`│ └── .vscode/`
41	`│ └── settings.json # Points to ../hve-core`
42	`│`
43	`└── hve-core/ # Sibling directory`
44	`└── .github/`
45	`├── agents/`
46	`├── prompts/`
47	`└── instructions/`
48	```
49
50	`## Quick Start`
51
52	Use the `hve-core-installer` agent:
53
54	1. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
55	2. Select `hve-core-installer` from the agent picker
56	`3. Say: "Install HVE-Core using peer directory clone"`
57	`4. Follow the guided setup`
58
59	`## Manual Setup`
60
61	`### Step 1: Clone HVE-Core`
62
63	`Open a terminal in your project's parent directory:`
64
65	```bash
66	`# Navigate to parent of your project`
67	`cd /path/to/projects`
68
69	`# Clone HVE-Core as a sibling`
70	`git clone https://github.com/microsoft/hve-core.git`
71	```
72
73	`Your directory structure should now look like:`
74
75	```text
76	`projects/`
77	`├── my-project/`
78	`└── hve-core/`
79	```
80
81	`### Step 2: Update VS Code Settings`
82
83	Create or update `.vscode/settings.json` in your project:
84
85	```json
86	`{`
87	`"chat.agentFilesLocations": {`
88	`"../hve-core/.github/agents/ado": true,`
89	`"../hve-core/.github/agents/data-science": true,`
90	`"../hve-core/.github/agents/design-thinking": true,`
91	`"../hve-core/.github/agents/github": true,`
92	`"../hve-core/.github/agents/installer": true,`
93	`"../hve-core/.github/agents/project-planning": true,`
94	`"../hve-core/.github/agents/hve-core": true,`
95	`"../hve-core/.github/agents/hve-core/subagents": true,`
96	`"../hve-core/.github/agents/security-planning": true`
97	`},`
98	`"chat.promptFilesLocations": {`
99	`"../hve-core/.github/prompts/ado": true,`
100	`"../hve-core/.github/prompts/design-thinking": true,`
101	`"../hve-core/.github/prompts/github": true,`
102	`"../hve-core/.github/prompts/hve-core": true,`
103	`"../hve-core/.github/prompts/security-planning": true`
104	`},`
105	`"chat.instructionsFilesLocations": {`
106	`"../hve-core/.github/instructions/ado": true,`
107	`"../hve-core/.github/instructions/coding-standards": true,`
108	`"../hve-core/.github/instructions/design-thinking": true,`
109	`"../hve-core/.github/instructions/github": true,`
110	`"../hve-core/.github/instructions/hve-core": true,`
111	`"../hve-core/.github/instructions/shared": true`
112	`},`
113	`"chat.agentSkillsLocations": {`
114	`"../hve-core/.github/skills": true,`
115	`"../hve-core/.github/skills/shared": true`
116	`}`
117	`}`
118	```
119
120	`### Step 3: Validate Installation`
121
122	`Verify HVE-Core directories are accessible:`
123
124	```bash
125	`ls ../hve-core/.github/agents`
126	```
127
128	You should see `.agent.md` files. Then validate in VS Code:
129
130	1. Reload VS Code window (`Ctrl+Shift+P` → "Developer: Reload Window")
131	2. Open GitHub Copilot Chat (`Ctrl+Alt+I`)
132	`3. Click the agent picker dropdown`
133	`4. Verify HVE-Core agents appear (task-planner, task-researcher, prompt-builder)`
134
135	`## Updating HVE-Core`
136
137	`To get the latest version:`
138
139	```bash
140	`cd ../hve-core`
141	`git pull`
142	```
143
144	`No VS Code restart required. Changes take effect immediately.`
145
146	`## Troubleshooting`
147
148	`### Agents Not Appearing`
149
150	`Check the relative path:`
151
152	```bash
153	`# From your project directory`
154	`ls ../hve-core/.github/agents`
155	```
156
157	`If the path doesn't resolve, verify:`
158
159	`1. HVE-Core is cloned at the correct location`
160	`2. Your terminal is in your project directory`
161	`3. The relative path in settings.json is correct`
162
163	`Check VS Code settings:`
164
165	1. Open Command Palette (`Ctrl+Shift+P`)
166	`2. Type "Preferences: Open User Settings (JSON)"`
167	`3. Verify no conflicting settings override your workspace settings`
168
169	`### Path Breaks After Moving Project`
170
171	`Relative paths break if your project moves. Options:`
172
173	`1. Re-clone HVE-Core next to the new location`
174	`2. Update settings.json with the new relative path`
175	`3. Switch to [Multi-Root Workspace](multi-root.md) for portable paths`
176
177	`### Doesn't Work in Devcontainer`
178
179	`Peer directory clone doesn't work in devcontainers because the container can't access files outside the mounted workspace.`
180
181	`Solutions:`
182
183	`* Use [Git-Ignored Folder](git-ignored.md) for self-contained installation`
184	`* Use [Mounted Directory](mounted.md) to share HVE-Core across projects`
185	`* Use [Multi-Root Workspace](multi-root.md) for the most portable solution`
186
187	`## Limitations`
188
189	`\| Aspect \| Status \|`
190	`\|------------------\|--------------------------------------\|`
191	`\| Devcontainers \| ❌ Not supported \|`
192	`\| Codespaces \| ❌ Not supported \|`
193	`\| Team sharing \| ⚠️ Each developer clones separately \|`
194	`\| Portable paths \| ⚠️ Breaks if project moves \|`
195	`\| Version pinning \| ⚠️ Manual (use git checkout) \|`
196	`\| Setup complexity \| ✅ Very simple \|`
197	`\| Update process \| ✅ Just git pull \|`
198
199	`## Next Steps`
200
201	`* [Your First Workflow](../first-workflow.md) - Try HVE-Core with a real task`
202	`* [Multi-Root Workspace](multi-root.md) - Upgrade to portable paths`
203	`* [Submodule](submodule.md) - Add version control for teams`
204
205	`---`
206
207	`<!-- markdownlint-disable MD036 -->`
208	`*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,`
209	`then carefully refined by our team of discerning human reviewers.*`
210	`<!-- markdownlint-enable MD036 -->`
211

microsoft/hve-core

Branches

Tags

Clone