### Install Dependencies and Start Local Server

Source: https://github.com/microsoft/hve-core/blob/main/docs/docusaurus/README.md

Installs project dependencies and starts a local development server. Changes are reflected live without restarting.

```bash
npm install
npm start
```

--------------------------------

### Quick Start Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/contributing/skills.md

Demonstrates basic usage of a skill script with default settings.

```bash
./scripts/convert.sh input.mp4
```

--------------------------------

### Start Guided RPI Mode

Source: https://github.com/microsoft/hve-core/blob/main/docs/hve-guide/roles/new-contributor.md

Begin with `/rpi mode=guided` for step-by-step workflow assistance. Transition to the non-guided mode as confidence grows.

```shell
/rpi mode=guided
```

--------------------------------

### Prompt Prerequisites Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/contributing/prompts.md

Lists the necessary information, tools, setup, environment assumptions, and input requirements for using the prompt.

```markdown
## Prerequisites

* Active Azure DevOps connection
* Current branch with committed changes
* Work item IDs or branch naming following conventions
```

--------------------------------

### Prerequisites: Install FFmpeg on Linux

Source: https://github.com/microsoft/hve-core/blob/main/docs/contributing/skills.md

Installs FFmpeg using apt, a prerequisite for certain skills.

```bash
sudo apt install ffmpeg
```

--------------------------------

### Install Dependencies

Source: https://github.com/microsoft/hve-core/blob/main/docs/getting-started/tts-voiceover.md

Install Python dependencies using uv. Navigate to the skill's directory first.

```bash
cd .github/skills/experimental/tts-voiceover
uv sync
```

--------------------------------

### HVE Core Project Workflow

Source: https://github.com/microsoft/hve-core/blob/main/docs/hve-guide/README.md

A flowchart illustrating the starting points for navigating the HVE Core project documentation. It guides users to understand the workflow, find tools for their phase, get their role guide, or install collections.

```mermaid
flowchart TD
    START{Where to Start?} -->|Understand the workflow| LC[Lifecycle Overview]
    START -->|Find tools for my phase| SN[Stage Navigator]
    START -->|Get my role guide| RF[Role Finder]
    START -->|Install collections| CQ[Collection Quick Reference]
```

--------------------------------

### Complete Pester Test Example

Source: https://github.com/microsoft/hve-core/blob/main/plugins/coding-standards/instructions/coding-standards/powershell/pester.instructions.md

A comprehensive Pester test example demonstrating setup, context-specific tests, and cleanup.

```powershell
#Requires -Modules Pester
# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: MIT

BeforeAll {
    . (Join-Path $PSScriptRoot '../../linting/Invoke-Linter.ps1')
    Import-Module (Join-Path $PSScriptRoot '../Mocks/GitMocks.psm1') -Force
    $script:FixtureRoot = Join-Path $PSScriptRoot '../fixtures/Linting'
    Mock Write-Host {}
}

Describe 'Invoke-Linter' -Tag 'Unit' {
    Context 'when input file is valid' {
        BeforeAll {
            $script:result = Invoke-Linter -Path (Join-Path $script:FixtureRoot 'valid.md')
        }

        It 'Returns zero violations' {
            $script:result.Violations | Should -HaveCount 0
        }

        It 'Sets status to pass' {
            $script:result.Status | Should -Be 'Pass'
        }
    }

    Context 'when input file has errors' {
        BeforeAll {
            $script:result = Invoke-Linter -Path (Join-Path $script:FixtureRoot 'invalid.md')
        }

        It 'Returns violations' {
            $script:result.Violations | Should -Not -BeNullOrEmpty
        }

        It 'Includes file path in each violation' {
            $script:result.Violations | ForEach-Object {
                $_.File | Should -Not -BeNullOrEmpty
            }
        }
    }
}

AfterAll {
    Remove-Module GitMocks -Force -ErrorAction SilentlyContinue
}
```

--------------------------------

### Full RPI Workflow Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/hve-guide/lifecycle/implementation.md

Use this starter prompt for a complete Request-Process-Implement workflow, specifying endpoint, pagination type, page sizes, and referencing existing patterns.

```text
/rpi Implement the pagination logic for the /api/v2/search endpoint.
Add cursor-based pagination with a default page size of 50 and a maximum
of 200 results per request. Follow the existing pagination pattern in
src/api/handlers/list-resources.py.
```

--------------------------------

### Configuration Examples Snippet

Source: https://github.com/microsoft/hve-core/blob/main/plugins/hve-core-all/agents/hve-core/task-researcher.md

This snippet demonstrates configuration examples, often used to show how to set up or use specific tools or features within the project.

```text
{{config_examples}}
```

--------------------------------

### Start Task Implementation

Source: https://github.com/microsoft/hve-core/blob/main/docs/rpi/using-together.md

Use this command to initiate the implementation phase and switch to the Task Implementor role. Alternatively, use a specific prompt for a targeted implementation.

```text
/task-implement
```

```text
/implement-blob-storage
```

--------------------------------

### State Initialization Example

Source: https://github.com/microsoft/hve-core/blob/main/plugins/project-planning/commands/security/security-plan-from-prd.md

Illustrates the structure of the state.json file upon initialization for 'from-prd' entry mode.

```json
{
  "entryMode": "from-prd",
  "currentPhase": 1,
  "projectSlug": "{project-slug}",
  "technologyInventory": [],
  "deploymentTargets": [],
  "complianceRequirements": []
}
```

--------------------------------

### Scope Conversation Starting Prompt

Source: https://github.com/microsoft/hve-core/blob/main/docs/design-thinking/method-01-scope-conversations.md

Use this prompt to initiate a scope conversation session. It guides the identification of stakeholders and the classification of constraints.

```text
I'm beginning a Design Thinking project focused on [topic]. Help me identify
stakeholders across three tiers (decision makers, direct users, affected parties)
and classify the known constraints as frozen or fluid.

```

--------------------------------

### Example Execution Prompt

Source: https://github.com/microsoft/hve-core/blob/main/docs/agents/github-backlog/execution.md

Specify the handoff file path and add conditions, such as skipping operations on recently updated issues.

```text
Execute the triage handoff at .copilot-tracking/github-issues/triage/2026-02-10/triage-plan.md.
Skip any operations on issues that have been updated in the last 24 hours.
```

--------------------------------

### Markdown Example for Phase Announcement

Source: https://github.com/microsoft/hve-core/blob/main/plugins/hve-core/agents/hve-core/prompt-builder.md

Use this markdown structure to announce the start of a new phase, including relevant context and next steps.

```markdown
## Starting Phase 2: Research
{{criteria from user}}
{{findings from prior phases}}
{{how you will progress based on instructions in phase 2}}
```

--------------------------------

### Basic Prompt File Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/customization/prompts.md

A complete example of a prompt file for generating release notes, including YAML frontmatter and a Markdown body with instructions.

```markdown
---
description: "Generates release notes from recent commits and merged pull requests"
---

# Generate Release Notes

Analyze the recent commit history and merged pull requests to produce
release notes.

## Requirements

1. Group changes by category: Features, Bug Fixes, Breaking Changes,
   Documentation.
2. Include PR numbers and brief descriptions for each entry.
3. Highlight breaking changes at the top with migration guidance.
4. Use past tense for all entries.
```

--------------------------------

### Mural Doctor Verdict: Missing Dependencies

Source: https://github.com/microsoft/hve-core/blob/main/plugins/experimental/instructions/experimental/mural/mural-bootstrap.instructions.md

Use this message when `mural doctor` returns `deps_missing`. It guides the user to install the necessary Mural tool dependencies and retry.

```text
The Mural tool dependencies are not installed in this environment. Please run the repository's documented dependency setup for the Mural skill, then ask me to retry.
```

--------------------------------

### Capture Mode Entry

Source: https://github.com/microsoft/hve-core/blob/main/plugins/hve-core-all/agents/security/sssc-planner.md

Activates the capture mode for the SSSC agent. This mode is used for a fresh start, guiding the user through a Q&A to build project context from scratch.

```markdown
sssc-capture.prompt.md
```

--------------------------------

### Comprehensive BeforeAll Setup

Source: https://github.com/microsoft/hve-core/blob/main/plugins/coding-standards/instructions/coding-standards/powershell/pester.instructions.md

Initialize the test environment in a file-level BeforeAll block, including SUT import, mock module import, fixture path resolution, and output suppression.

```powershell
BeforeAll {
    . (Join-Path $PSScriptRoot '../../security/Test-DependencyPinning.ps1')
    Import-Module (Join-Path $PSScriptRoot '../../security/Modules/SecurityHelpers.psm1') -Force
    Import-Module (Join-Path $PSScriptRoot '../Mocks/GitMocks.psm1') -Force
    $script:FixtureRoot = Join-Path $PSScriptRoot '../fixtures/Security'
    Mock Write-Host {}
    Mock Write-CIAnnotation {} -ModuleName SecurityHelpers
}
```

--------------------------------

### Complete PowerShell Script Example Header

Source: https://github.com/microsoft/hve-core/blob/main/plugins/hve-core-all/instructions/coding-standards/powershell/powershell.instructions.md

This is a basic header for a PowerShell script, including a shebang line for execution and a copyright notice. It's a starting point for a complete script file.

```powershell
#!/usr/bin/env pwsh
# Copyright (c) Microsoft Corporation.
```

--------------------------------

### Frontmatter Example for Instructions

Source: https://github.com/microsoft/hve-core/blob/main/docs/contributing/instructions.md

Defines metadata for an instruction file, including its description, applicability, version, author, and last updated date. Ensure all required fields are present.

```yaml
---
description: 'Required instructions for Python script implementation with type hints, docstrings, and error handling'
applyTo: '**/*.py, **/*.ipynb'
version: '1.0.0'
author: 'microsoft/hve-core'
lastUpdated: '2025-11-19'
---
```

--------------------------------

### Markdown Heading Examples

Source: https://github.com/microsoft/hve-core/blob/main/plugins/hve-core/instructions/hve-core/markdown.instructions.md

Demonstrates the correct use of ATX-style headings, including title, section, and subsection levels. Ensure headings start at column 1 and are surrounded by blank lines.

```markdown
# Title

## Section

### Subsection
```

--------------------------------

### Skill File Structure Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/architecture/ai-artifacts.md

Skills are organized with a SKILL.md entry point and implementation scripts. Cross-platform scripts like .sh and .ps1 ensure consistent behavior.

```text
.github/skills/{collection-id}/<skill-name>/
├── SKILL.md                    # Entry point documentation
├── convert.sh                  # Bash implementation
├── convert.ps1                 # PowerShell implementation
└── examples/
    └── README.md

```

--------------------------------

### HVE Core Extension File Structure Example

Source: https://github.com/microsoft/hve-core/blob/main/docs/getting-started/methods/extension.md

Illustrates the internal file structure of the HVE Core VS Code extension, showing how components like agents, prompts, and instructions are organized. No configuration is needed after installation.

```text
VS Code Extension System
├── Extension installed via marketplace
│   ├── .github/agents/         # All chat agents
│   ├── .github/prompts/        # All prompt templates
│   ├── .github/instructions/   # All coding guidelines
│   └── .github/skills/         # All skill packages
└── Only optional workspace configuration needed!
```

--------------------------------

### Install HVE Core Installer Plugin

Source: https://github.com/microsoft/hve-core/blob/main/plugins/installer/README.md

Use this command to install the HVE Core installer plugin. This command is typically run in a terminal environment that supports Copilot plugin management.

```bash
copilot plugin install installer@hve-core
```

--------------------------------

### Create Directories Safely and Source Configuration Files

Source: https://github.com/microsoft/hve-core/blob/main/plugins/coding-standards/instructions/coding-standards/bash/bash.instructions.md

Ensure directories exist before use with `mkdir -p`. Safely source configuration files if they exist.

```bash
mkdir -p "$(dirname "$OUTPUT_FILE")"

if [[ -f "${config_file}" ]]; then
  source "${config_file}"
fi
```

--------------------------------

### Install Experimental HVE-Core Plugin

Source: https://github.com/microsoft/hve-core/blob/main/plugins/experimental/README.md

Use this command to install the experimental plugin from the hve-core project. Ensure you have Copilot CLI installed.

```bash
copilot plugin install experimental@hve-core
```

--------------------------------

### Install HVE Core All Plugin

Source: https://github.com/microsoft/hve-core/blob/main/docs/getting-started/methods/cli-plugins.md

Install the 'hve-core-all' plugin for the full bundle, including 'hve-core' and all additional collections.

```bash
copilot plugin install hve-core-all@hve-core
```

--------------------------------

### Prepare Extension (Stable Channel)

Source: https://github.com/microsoft/hve-core/blob/main/extension/PACKAGING.md

Discovers components and updates package.json for the stable channel. This is the recommended first step before packaging.

```bash
pwsh ./scripts/extension/Prepare-Extension.ps1
```

--------------------------------

### Install Data Science Plugin

Source: https://github.com/microsoft/hve-core/blob/main/plugins/data-science/README.md

Use this command to install the data-science plugin for HVE Core. Ensure you have Copilot CLI installed.

```bash
copilot plugin install data-science@hve-core
```

--------------------------------

### Install Design Thinking Plugin

Source: https://github.com/microsoft/hve-core/blob/main/plugins/design-thinking/README.md

Use this command to install the Design Thinking plugin from the hve-core repository. Ensure you have Copilot CLI installed.

```bash
copilot plugin install design-thinking@hve-core
```

--------------------------------

### Instruction File Naming Convention Examples

Source: https://github.com/microsoft/hve-core/blob/main/docs/contributing/instructions.md

Provides examples of recommended naming conventions for instruction files, emphasizing specificity and domain relevance.

```text
*.instructions.md
```

--------------------------------

### Install Dependencies

Source: https://github.com/microsoft/hve-core/blob/main/docs/customization/forking.md

Install all project dependencies using npm.

```bash
npm install
```