microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
docs/getting-started/install.md
169lines · modecode
| 1 | --- |
| 2 | title: Installing HVE Core |
| 3 | description: Three ways to install HVE Core with marketplace extension, selective collections, or developer clone |
| 4 | sidebar_position: 2 |
| 5 | author: Microsoft |
| 6 | ms.date: 2026-03-11 |
| 7 | ms.topic: how-to |
| 8 | keywords: |
| 9 | - installation |
| 10 | - setup |
| 11 | - github copilot |
| 12 | - marketplace |
| 13 | - collections |
| 14 | estimated_reading_time: 4 |
| 15 | --- |
| 16 | |
| 17 | HVE Core delivers GitHub Copilot customizations (agents, instructions, prompts, and skills) that accelerate your development workflow. Pick the installation path that fits your needs. |
| 18 | |
| 19 | ## Marketplace Install (Recommended) |
| 20 | |
| 21 | Install the **HVE Core** extension for a zero-configuration experience that works across local VS Code, devcontainers, and GitHub Codespaces. |
| 22 | |
| 23 | 1. Open VS Code and go to the Extensions view (`Ctrl+Shift+X`). |
| 24 | 2. Search for **HVE Core**. |
| 25 | 3. Click **Install** on the extension published by `ise-hve-essentials`. |
| 26 | 4. Reload VS Code when prompted. |
| 27 | |
| 28 | **Or visit:** [HVE Core on VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-core) |
| 29 | |
| 30 | The extension installs the `hve-core` (Flagship) collection containing 40 artifacts for the RPI workflow. Updates arrive automatically through VS Code. |
| 31 | |
| 32 | See [Extension Installation Guide](methods/extension.md) for complete documentation. |
| 33 | |
| 34 | > [!TIP] |
| 35 | > The marketplace extension is the fastest way to start. You can switch to a clone-based method later without losing any configuration. |
| 36 | |
| 37 | ## Selective Install |
| 38 | |
| 39 | Teams that only need specific domains can use the **HVE Installer** extension to deploy individual [collections](collections.md) into a workspace. |
| 40 | |
| 41 | 1. Install the [HVE Installer extension](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-installer) from the VS Code Marketplace. |
| 42 | 2. Open Copilot Chat and ask any agent: *"help me customize hve-core installation"*. |
| 43 | 3. Choose the collections that match your team's workflow. |
| 44 | |
| 45 | 4. Update preference? |
| 46 | * Auto: Always get latest HVE Core |
| 47 | * Controlled: Pin to specific version, update explicitly |
| 48 | |
| 49 | ### Decision Matrix |
| 50 | |
| 51 | | Environment | Team | Updates | Recommended Method | |
| 52 | |---------------------------|------|------------|-----------------------------------------------| |
| 53 | | **Any** (simplest) | Any | Auto | [VS Code Extension](methods/extension.md) ⭐ | |
| 54 | | Local (no container) | Solo | Manual | [Peer Directory Clone](methods/peer-clone.md) | |
| 55 | | Local (no container) | Team | Controlled | [Submodule](methods/submodule.md) | |
| 56 | | Local devcontainer | Solo | Auto | [Git-Ignored Folder](methods/git-ignored.md) | |
| 57 | | Local devcontainer | Team | Controlled | [Submodule](methods/submodule.md) | |
| 58 | | Codespaces only | Solo | Auto | [GitHub Codespaces](methods/codespaces.md) | |
| 59 | | Codespaces only | Team | Controlled | [Submodule](methods/submodule.md) | |
| 60 | | Both local + Codespaces | Any | Any | [Multi-Root Workspace](methods/multi-root.md) | |
| 61 | | Advanced (shared install) | Solo | Auto | [Mounted Directory](methods/mounted.md) | |
| 62 | | Any (CLI preferred) | Any | Manual | [CLI Plugins](methods/cli-plugins.md) | |
| 63 | |
| 64 | ⭐ **VS Code Extension** is the recommended method for most users who don't need customization. |
| 65 | |
| 66 | ## Collection Packages |
| 67 | |
| 68 | HVE Core organizes artifacts into role-based collections. The VS Code extension installs the **HVE Core Workflow** collection (flagship RPI workflow and core artifacts). For the complete set across all collections, use the `hve-core-all` CLI plugin or installer skill. Clone-based methods also support filtering which agents to copy by collection bundle. |
| 69 | |
| 70 | | Collection | Collection ID | Maturity | Description | |
| 71 | |-------------------|--------------------|--------------|-------------------------------------------------------------------| |
| 72 | | **Full** ⭐ | `hve-core-all` | Stable | All stable artifacts (recommended for most) | |
| 73 | | HVE Core Workflow | `hve-core` | Stable | RPI workflow with Git commit, merge, and pull request prompts | |
| 74 | | Azure DevOps | `ado` | Stable | Work item management, build monitoring, and PR creation | |
| 75 | | Coding Standards | `coding-standards` | Stable | Language-specific instructions for bash, Bicep, C#, Python, etc. | |
| 76 | | Data Science | `data-science` | Stable | Data specs, Jupyter notebooks, and Streamlit dashboards | |
| 77 | | Design Thinking | `design-thinking` | Preview | AI-enhanced Design Thinking coaching across nine methods | |
| 78 | | GitHub Backlog | `github` | Stable | Issue discovery, triage, sprint planning, and backlog execution | |
| 79 | | Installer | `installer` | Stable | Interactive installer skill for workspace configuration | |
| 80 | | Project Planning | `project-planning` | Stable | PRDs, BRDs, ADRs, and architecture diagrams | |
| 81 | | Security | `security` | Experimental | Security review, planning, incident response, and risk assessment | |
| 82 | | Experimental | `experimental` | Experimental | Artifacts not yet promoted to stable collections | |
| 83 | |
| 84 | ### Extension Installation (Flagship Collection) |
| 85 | |
| 86 | The VS Code Marketplace extension installs the **HVE Core Workflow** collection: the flagship set of RPI agents, prompts, and instructions. This is the recommended starting point for most users. For every stable artifact across all collections, use the `hve-core-all` Extension or plugin. |
| 87 | |
| 88 | ### Clone Methods (Agent Bundle Selection) |
| 89 | |
| 90 | Clone-based installation methods support agent bundle selection through the HVE Core installer skill: |
| 91 | |
| 92 | 1. Install the [HVE Core Installer](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-installer) extension to get the installer skill |
| 93 | 2. Ask any agent: "help me customize hve-core installation" |
| 94 | 3. Choose an agent bundle by collection or copy all agents |
| 95 | |
| 96 | The installer skill reads collection assignments from `collections/*.collection.yml` and copies only the agents from your selected bundles to `.github/agents/`. |
| 97 | |
| 98 | > [!IMPORTANT] |
| 99 | > Agent bundle selection currently applies to agents only. Support for prompts, instructions, and skills is planned for a future release. |
| 100 | |
| 101 | ## Developer Setup |
| 102 | |
| 103 | Contributors and advanced users who need to modify HVE Core source code should clone the repository directly. |
| 104 | |
| 105 | 1. Fork and clone the repository: |
| 106 | |
| 107 | ```bash |
| 108 | git clone https://github.com/<your-fork>/hve-core.git |
| 109 | ``` |
| 110 | |
| 111 | 2. Install dependencies: |
| 112 | |
| 113 | ```bash |
| 114 | cd hve-core && npm ci |
| 115 | ``` |
| 116 | |
| 117 | 3. Open the workspace in VS Code. A devcontainer configuration is included for containerized development. |
| 118 | |
| 119 | Detailed instructions for each clone-based approach: |
| 120 | |
| 121 | * [Peer Directory Clone](methods/peer-clone.md) for side-by-side local development |
| 122 | * [Git Submodule](methods/submodule.md) for team version control |
| 123 | * [Contributing Guide](../contributing/) for pull request and development conventions |
| 124 | |
| 125 | ## Choosing a Method |
| 126 | |
| 127 | The three paths above cover the vast majority of scenarios. If your environment has specific constraints (Codespaces-only, mounted containers, multi-root workspaces), the [Comparing Setup Methods](methods/comparison.md) page has a detailed decision matrix and decision tree. The [Setup Methods Overview](methods/) lists every available approach. |
| 128 | |
| 129 | ## Validation |
| 130 | |
| 131 | After installing, verify that HVE Core is active: |
| 132 | |
| 133 | 1. Open Copilot Chat in VS Code. |
| 134 | 2. Type `@` to see available agents. |
| 135 | 3. Look for HVE Core agents like `task-researcher`, `task-planner`, and `task-implementor`. |
| 136 | |
| 137 | If you don't see the agents, check the [Troubleshooting](troubleshooting.md) page for common solutions. |
| 138 | |
| 139 | ## Post-Installation: Update Your .gitignore |
| 140 | |
| 141 | Add this line to your project's `.gitignore`: |
| 142 | |
| 143 | ```text |
| 144 | .copilot-tracking/ |
| 145 | ``` |
| 146 | |
| 147 | > [!IMPORTANT] |
| 148 | > This applies to all installation methods. The `.copilot-tracking/` folder is created in your project directory, not in HVE Core itself. |
| 149 | |
| 150 | The folder stores ephemeral workflow artifacts (research documents, implementation plans, PR review notes, and work item planning files) that help agents maintain context across sessions. These files are useful during your workflow but should not be committed to your repository. |
| 151 | |
| 152 | ## MCP Server Configuration (Optional) |
| 153 | |
| 154 | Some HVE Core agents use MCP (Model Context Protocol) servers to integrate with Azure DevOps, GitHub, or documentation services. Agents work without MCP configuration; it is an optional enhancement. |
| 155 | |
| 156 | See [MCP Server Configuration](mcp-configuration.md) for setup instructions covering server requirements, configuration templates, and troubleshooting. |
| 157 | |
| 158 | ## Next Steps |
| 159 | |
| 160 | * [Your First Interaction](first-interaction.md) to confirm your setup works |
| 161 | * [Your First Workflow](first-workflow.md) to try HVE Core with a real task |
| 162 | * [RPI Workflow](../rpi/) for the Research, Plan, Implement methodology |
| 163 | |
| 164 | --- |
| 165 | |
| 166 | <!-- markdownlint-disable MD036 --> |
| 167 | *🤖 Crafted with precision by ✨Copilot following brilliant human instruction, |
| 168 | then carefully refined by our team of discerning human reviewers.* |
| 169 | <!-- markdownlint-enable MD036 --> |
| 170 | |