microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
docs/getting-started/methods/peer-clone.md
183lines · modecode
| 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": { "../hve-core/.github/agents": true }, |
| 88 | "chat.promptFilesLocations": { "../hve-core/.github/prompts": true }, |
| 89 | "chat.instructionsFilesLocations": { "../hve-core/.github/instructions": true } |
| 90 | } |
| 91 | ``` |
| 92 | |
| 93 | ### Step 3: Validate Installation |
| 94 | |
| 95 | Verify HVE-Core directories are accessible: |
| 96 | |
| 97 | ```bash |
| 98 | ls ../hve-core/.github/agents |
| 99 | ``` |
| 100 | |
| 101 | You should see `.agent.md` files. Then validate in VS Code: |
| 102 | |
| 103 | 1. Reload VS Code window (`Ctrl+Shift+P` → "Developer: Reload Window") |
| 104 | 2. Open GitHub Copilot Chat (`Ctrl+Alt+I`) |
| 105 | 3. Click the agent picker dropdown |
| 106 | 4. Verify HVE-Core agents appear (task-planner, task-researcher, prompt-builder) |
| 107 | |
| 108 | ## Updating HVE-Core |
| 109 | |
| 110 | To get the latest version: |
| 111 | |
| 112 | ```bash |
| 113 | cd ../hve-core |
| 114 | git pull |
| 115 | ``` |
| 116 | |
| 117 | No VS Code restart required. Changes take effect immediately. |
| 118 | |
| 119 | ## Troubleshooting |
| 120 | |
| 121 | ### Agents Not Appearing |
| 122 | |
| 123 | **Check the relative path:** |
| 124 | |
| 125 | ```bash |
| 126 | # From your project directory |
| 127 | ls ../hve-core/.github/agents |
| 128 | ``` |
| 129 | |
| 130 | If the path doesn't resolve, verify: |
| 131 | |
| 132 | 1. HVE-Core is cloned at the correct location |
| 133 | 2. Your terminal is in your project directory |
| 134 | 3. The relative path in settings.json is correct |
| 135 | |
| 136 | **Check VS Code settings:** |
| 137 | |
| 138 | 1. Open Command Palette (`Ctrl+Shift+P`) |
| 139 | 2. Type "Preferences: Open User Settings (JSON)" |
| 140 | 3. Verify no conflicting settings override your workspace settings |
| 141 | |
| 142 | ### Path Breaks After Moving Project |
| 143 | |
| 144 | Relative paths break if your project moves. Options: |
| 145 | |
| 146 | 1. Re-clone HVE-Core next to the new location |
| 147 | 2. Update settings.json with the new relative path |
| 148 | 3. Switch to [Multi-Root Workspace](multi-root.md) for portable paths |
| 149 | |
| 150 | ### Doesn't Work in Devcontainer |
| 151 | |
| 152 | Peer directory clone doesn't work in devcontainers because the container can't access files outside the mounted workspace. |
| 153 | |
| 154 | **Solutions:** |
| 155 | |
| 156 | * Use [Git-Ignored Folder](git-ignored.md) for self-contained installation |
| 157 | * Use [Mounted Directory](mounted.md) to share HVE-Core across projects |
| 158 | * Use [Multi-Root Workspace](multi-root.md) for the most portable solution |
| 159 | |
| 160 | ## Limitations |
| 161 | |
| 162 | | Aspect | Status | |
| 163 | |------------------|--------------------------------------| |
| 164 | | Devcontainers | ❌ Not supported | |
| 165 | | Codespaces | ❌ Not supported | |
| 166 | | Team sharing | ⚠️ Each developer clones separately | |
| 167 | | Portable paths | ⚠️ Breaks if project moves | |
| 168 | | Version pinning | ⚠️ Manual (use git checkout) | |
| 169 | | Setup complexity | ✅ Very simple | |
| 170 | | Update process | ✅ Just git pull | |
| 171 | |
| 172 | ## Next Steps |
| 173 | |
| 174 | * [Your First Workflow](../first-workflow.md) - Try HVE-Core with a real task |
| 175 | * [Multi-Root Workspace](multi-root.md) - Upgrade to portable paths |
| 176 | * [Submodule](submodule.md) - Add version control for teams |
| 177 | |
| 178 | --- |
| 179 | |
| 180 | <!-- markdownlint-disable MD036 --> |
| 181 | *🤖 Crafted with precision by ✨Copilot following brilliant human instruction, |
| 182 | then carefully refined by our team of discerning human reviewers.* |
| 183 | <!-- markdownlint-enable MD036 --> |
| 184 | |