Skip to content

README.md

Latest commit

 

History

History
121 lines (86 loc) · 4.7 KB

README.md

File metadata and controls

121 lines (86 loc) · 4.7 KB
title Getting Started with HVE Core
description Quick setup guide for using HVE Core Copilot customizations in your projects
author Microsoft
ms.date 2025-12-02
ms.topic tutorial
keywords
github copilot
multi-root workspace
setup
getting started
estimated_reading_time 5

HVE Core provides GitHub Copilot customizations (custom agents, instructions, and prompts) that enhance your development workflow. This guide helps you get started quickly.

Installation

Quick Install: VS Code Extension ⭐

Simplest method: Install directly from VS Code Marketplace:

  1. Open VS Code Extensions view (Ctrl+Shift+X)
  2. Search for "HVE Core"
  3. Click Install

Or visit: HVE Core on Marketplace

Pros: Zero configuration, automatic updates, works everywhere Cons: Cannot customize components

See Extension Installation Guide for full details.

Custom Installation

For customization or version control, see Installing HVE-Core to choose from six installation methods.

Contributing to HVE-Core? See the Contributing Guide for development setup and contribution guidelines.

Quick start: Use the hve-core-installer agent:

  1. Open GitHub Copilot Chat (Ctrl+Alt+I)
  2. Select hve-core-installer from the agent picker
  3. Follow the guided installation

Installation Methods

HVE-Core supports seven installation methods. See the installation guide for a decision matrix to help you choose:

Method Best For
VS Code Extension ⭐ Simplest, no config needed
Multi-Root Workspace Any environment, portable
Submodule Teams needing version control
Peer Directory Clone Local VS Code, solo
Git-Ignored Folder Local devcontainer, solo
Mounted Directory Advanced devcontainer sharing
GitHub Codespaces Codespaces-only projects

Verifying Setup

After installation, verify everything works:

  1. Open GitHub Copilot Chat (Ctrl+Alt+I)
  2. Click the agent picker dropdown
  3. Verify HVE-Core agents appear:
    • task-planner
    • task-researcher
    • prompt-builder
    • pr-review
  4. Select an agent and submit a test prompt

Troubleshooting

Installation Issues

Agent not available

  • Ensure GitHub Copilot extension is installed and active
  • Reload VS Code window: Ctrl+Shift+P → "Developer: Reload Window"
  • Check that hve-core is accessible (cloned or configured correctly)

Copilot not discovering customizations

  • For Multi-Root: Ensure you opened the .code-workspace file, not just the folder
  • Verify chat.modeFilesLocations points to the correct path
  • Check the window title shows the workspace name

Git or clone errors

  • Verify Git is installed: run git --version in terminal
  • Check network connectivity to github.com
  • See the installation guide for method-specific troubleshooting

Optional Scripts

HVE Core includes utility scripts you may want to copy into your project:

Script Purpose
scripts/dev-tools/Generate-PrReference.ps1 Generate PR reference docs for handoff to reviewers
scripts/linting/Validate-MarkdownFrontmatter.ps1 Validate markdown frontmatter against JSON schemas
scripts/linting/Invoke-PSScriptAnalyzer.ps1 Run PSScriptAnalyzer with project settings
scripts/security/Test-DependencyPinning.ps1 Check GitHub Actions for pinned dependencies

Copy the scripts you need to your project's scripts/ directory and adjust paths as needed.

Next Steps

🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.