microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
docs/getting-started/README.md
123lines · modecode
| 1 | --- |
| 2 | title: Getting Started with HVE Core |
| 3 | description: Quick setup guide for using HVE Core Copilot customizations in your projects |
| 4 | author: Microsoft |
| 5 | ms.date: 2025-12-02 |
| 6 | ms.topic: tutorial |
| 7 | keywords: |
| 8 | - github copilot |
| 9 | - multi-root workspace |
| 10 | - setup |
| 11 | - getting started |
| 12 | estimated_reading_time: 5 |
| 13 | --- |
| 14 | |
| 15 | HVE Core provides GitHub Copilot customizations (custom agents, instructions, and prompts) that enhance your development workflow. This guide helps you get started quickly. |
| 16 | |
| 17 | ## Installation |
| 18 | |
| 19 | ### Quick Install: VS Code Extension ⭐ |
| 20 | |
| 21 | **Simplest method:** Install directly from VS Code Marketplace: |
| 22 | |
| 23 | 1. Open VS Code Extensions view (`Ctrl+Shift+X`) |
| 24 | 2. Search for "HVE Core" |
| 25 | 3. Click **Install** |
| 26 | |
| 27 | Or visit: [HVE Core on Marketplace](https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-core) |
| 28 | |
| 29 | **Pros:** Zero configuration, automatic updates, works everywhere |
| 30 | **Cons:** Cannot customize components |
| 31 | |
| 32 | See [Extension Installation Guide](methods/extension.md) for full details. |
| 33 | |
| 34 | ### Custom Installation |
| 35 | |
| 36 | For customization or version control, see [Installing HVE-Core](install.md) to choose from six installation methods. |
| 37 | |
| 38 | > **Contributing to HVE-Core?** See the [Contributing Guide](../contributing/README.md) for development setup and contribution guidelines. |
| 39 | |
| 40 | **Quick start:** Use the `hve-core-installer` agent: |
| 41 | |
| 42 | 1. Open GitHub Copilot Chat (`Ctrl+Alt+I`) |
| 43 | 2. Select `hve-core-installer` from the agent picker |
| 44 | 3. Follow the guided installation |
| 45 | |
| 46 | ### Installation Methods |
| 47 | |
| 48 | HVE-Core supports eight installation methods. See the [installation guide](install.md) for a decision matrix to help you choose: |
| 49 | |
| 50 | | Method | Best For | |
| 51 | |-----------------------------------------------|-------------------------------| |
| 52 | | [VS Code Extension](methods/extension.md) ⭐ | Simplest, no config needed | |
| 53 | | [Multi-Root Workspace](methods/multi-root.md) | Any environment, portable | |
| 54 | | [Submodule](methods/submodule.md) | Teams needing version control | |
| 55 | | [Peer Directory Clone](methods/peer-clone.md) | Local VS Code, solo | |
| 56 | | [Git-Ignored Folder](methods/git-ignored.md) | Local devcontainer, solo | |
| 57 | | [Mounted Directory](methods/mounted.md) | Advanced devcontainer sharing | |
| 58 | | [GitHub Codespaces](methods/codespaces.md) | Codespaces-only projects | |
| 59 | | [Copilot CLI Plugins](methods/cli-plugins.md) | Terminal-based CLI workflows | |
| 60 | |
| 61 | ## Verifying Setup |
| 62 | |
| 63 | After installation, verify everything works: |
| 64 | |
| 65 | 1. Open GitHub Copilot Chat (`Ctrl+Alt+I`) |
| 66 | 2. Click the **agent picker dropdown** |
| 67 | 3. Verify HVE-Core agents appear: |
| 68 | - task-planner |
| 69 | - task-researcher |
| 70 | - prompt-builder |
| 71 | - pr-review |
| 72 | 4. Select an agent and submit a test prompt |
| 73 | |
| 74 | ## Troubleshooting |
| 75 | |
| 76 | ### Installation Issues |
| 77 | |
| 78 | #### Agent not available |
| 79 | |
| 80 | - Ensure GitHub Copilot extension is installed and active |
| 81 | - Reload VS Code window: `Ctrl+Shift+P` → "Developer: Reload Window" |
| 82 | - Check that hve-core is accessible (cloned or configured correctly) |
| 83 | |
| 84 | #### Copilot not discovering customizations |
| 85 | |
| 86 | - For Multi-Root: Ensure you opened the `.code-workspace` file, not just the folder |
| 87 | - Verify `chat.agentFilesLocations` points to the correct path |
| 88 | - Check the window title shows the workspace name |
| 89 | |
| 90 | #### Git or clone errors |
| 91 | |
| 92 | - Verify Git is installed: run `git --version` in terminal |
| 93 | - Check network connectivity to github.com |
| 94 | - See the [installation guide](install.md) for method-specific troubleshooting |
| 95 | |
| 96 | ## Optional Scripts |
| 97 | |
| 98 | HVE Core includes utility scripts you may want to copy into your project: |
| 99 | |
| 100 | | Script | Purpose | |
| 101 | |----------------------------------------------------|-----------------------------------------------------| |
| 102 | | `scripts/dev-tools/Generate-PrReference.ps1` | Generate PR reference docs for handoff to reviewers | |
| 103 | | `scripts/linting/Validate-MarkdownFrontmatter.ps1` | Validate markdown frontmatter against JSON schemas | |
| 104 | | `scripts/linting/Invoke-PSScriptAnalyzer.ps1` | Run PSScriptAnalyzer with project settings | |
| 105 | | `scripts/security/Test-DependencyPinning.ps1` | Check GitHub Actions for pinned dependencies | |
| 106 | |
| 107 | Copy the scripts you need to your project's `scripts/` directory and adjust paths as needed. |
| 108 | |
| 109 | ## Next Steps |
| 110 | |
| 111 | - Try [Your First Workflow](first-workflow.md) for a quick start |
| 112 | - Learn the [RPI Workflow](../rpi/README.md) for complex tasks |
| 113 | - Browse the [Agent Catalog](../agents/README.md) for all agent system documentation |
| 114 | - Explore [Agents](../../.github/CUSTOM-AGENTS.md) for available agents |
| 115 | - Review [Instructions](../../.github/instructions/README.md) for coding guidelines |
| 116 | - Check the [README](../../README.md) for feature overview |
| 117 | |
| 118 | --- |
| 119 | |
| 120 | <!-- markdownlint-disable MD036 --> |
| 121 | *🤖 Crafted with precision by ✨Copilot following brilliant human instruction, |
| 122 | then carefully refined by our team of discerning human reviewers.* |
| 123 | <!-- markdownlint-enable MD036 --> |
| 124 | |