awesome-copilot Documentation

1. Project Overview & Quickstart (github/awesome-copilot) Copy Chapter

File: README.md Copy Chapter

🤖 Awesome GitHub Copilot

A community-created collection of custom agents, instructions, skills, hooks, workflows, and plugins to supercharge your GitHub Copilot experience.

[!TIP]
Explore the full collection on the website → awesome-copilot.github.com

The website offers full-text search and filtering across hundreds of resources, plus the Learning Hub for guides and tutorials.

Using this collection in an AI agent? A machine-readable llms.txt is available with structured listings of all agents, instructions, and skills.

📖 Learning Hub Copy Chapter

New to GitHub Copilot customization? The Learning Hub on the website offers curated articles, walkthroughs, and reference material — covering everything from core concepts like agents, skills, and instructions to hands-on guides for hooks, agentic workflows, MCP servers, and the Copilot coding agent.

⬆ Back to Top

What's in this repo Copy Chapter

⬆ Back to Top

Install a Plugin Copy Chapter

For most users, the Awesome Copilot marketplace is already registered in the Copilot CLI/VS Code, so you can install a plugin directly:

copilot plugin install @awesome-copilot

If you are using an older Copilot CLI version or a custom setup and see an error that the marketplace is unknown, register it once and then install:

copilot plugin marketplace add github/awesome-copilot
copilot plugin install @awesome-copilot

⬆ Back to Top

Contributing Copy Chapter

See CONTRIBUTING.md · AGENTS.md for AI agent guidance · Security · Code of Conduct

The customizations here are sourced from third-party developers. Please inspect any agent and its documentation before installing.

⬆ Back to Top

Contributors ✨ Copy Chapter

Thanks goes to these wonderful people (emoji key):

Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

⬆ Back to Top

📚 Additional Resources Copy Chapter

• VS Code Copilot Customization Documentation - Official Microsoft documentation
• GitHub Copilot Chat Documentation - Complete chat feature guide
• VS Code Settings - General VS Code configuration guide

⬆ Back to Top

™️ Trademarks Copy Chapter

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
Microsoft's Trademark & Brand Guidelines.
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.

File: cookbook/copilot-sdk/dotnet/recipe/README.md Copy Chapter

Runnable Recipe Examples

This folder contains standalone, executable C# examples for each cookbook recipe. These are file-based apps that can be run directly with dotnet run.

Prerequisites Copy Chapter

• .NET 10.0 or later
• GitHub Copilot SDK package (referenced automatically)

Running Examples Copy Chapter

Each .cs file is a complete, runnable program. Simply use:

dotnet run <filename>.cs

Available Recipes Copy Section

Examples with Arguments Copy Section

PR Visualization with specific repo:

dotnet run pr-visualization.cs -- --repo github/copilot-sdk

Managing Local Files (edit the file to change target folder):

# Edit the targetFolder variable in managing-local-files.cs first
dotnet run managing-local-files.cs

Safety & Prerequisites Copy Chapter

Some recipes have side effects or external dependencies. Expand each section for safe testing patterns and prerequisites.

⚠️ Managing Local Files — Modifies your filesystem

Before running on a real directory, test it on a copy first.
Run these snippets from this recipe directory so the recipe path is captured before switching to the temporary folder.

PowerShell:

$recipeDir = (Get-Location).Path
$tempDir = New-Item -ItemType Directory -Path ([IO.Path]::Combine([IO.Path]::GetTempPath(), "copilot-test-files"))
@("document1.txt", "image1.png", "data.json") | ForEach-Object { 
    New-Item -Path "$tempDir/$_" -ItemType File
}
cd $tempDir
dotnet run "$recipeDir/managing-local-files.cs"
# Inspect results, then clean up
Remove-Item $tempDir -Recurse

Bash:

recipeDir=$(pwd)
tempDir=$(mktemp -d)
touch "$tempDir"/{document1.txt,image1.png,data.json}
cd "$tempDir"
dotnet run "$recipeDir/managing-local-files.cs"
# Inspect results, then clean up
rm -rf "$tempDir"

Edit the targetFolder variable in the .cs file to point to your test directory before running.

⚠️ Ralph Loop — Creates git commits and modifies files

Always run it in an isolated git repository first to verify behavior.
Run these snippets from this recipe directory so the recipe path is captured before switching to the temporary repository.

PowerShell:

$recipeDir = (Get-Location).Path
$tempDir = New-Item -ItemType Directory -Path ([IO.Path]::Combine([IO.Path]::GetTempPath(), "copilot-test-repo"))
cd $tempDir
git init
git config user.email "[email protected]"
git config user.name "Test User"

# Create a PROMPT_task.md for the recipe to work with
"# Task`nCreate a simple README" | Out-File PROMPT_task.md
dotnet run "$recipeDir/ralph-loop.cs"

# Review commits and changes
git log --oneline
git diff

# Clean up
cd ..
Remove-Item $tempDir -Recurse

Bash:

recipeDir=$(pwd)
tempDir=$(mktemp -d)
cd "$tempDir"
git init
git config user.email "[email protected]"
git config user.name "Test User"

# Create a PROMPT_task.md for the recipe to work with
echo -e "# Task\nCreate a simple README" > PROMPT_task.md
dotnet run "$recipeDir/ralph-loop.cs"

# Review commits and changes
git log --oneline
git diff

# Clean up
cd ..
rm -rf "$tempDir"

The recipe requires a git repository with at least one PROMPT_*.md file and will run in an infinite loop until manually stopped.

ℹ️ Accessibility Report — Requires Playwright MCP

This recipe requires Playwright MCP to be installed and available:

npm install @playwright/mcp

Or let Node Package Manager install it on-demand. The recipe will attempt to launch npx @playwright/mcp automatically. Run the recipe as normal:

dotnet run accessibility-report.cs

The recipe will prompt you for a URL to analyze and generate an accessibility report.

ℹ️ PR Visualization — Requires GitHub API access

This recipe requires:

• Access to a GitHub repository (public or private, with appropriate credentials)
• gh CLI tool installed and authenticated: https://cli.github.com/

Run with a repository argument:

dotnet run pr-visualization.cs -- --repo owner/repo-name

Example:

dotnet run pr-visualization.cs -- --repo github/copilot-sdk

Note: GitHub API requests are rate-limited. Large repositories or frequent runs may hit rate limits. See GitHub API rate limiting for details.

File-Based Apps Copy Chapter

These examples use .NET's file-based app feature, which allows single-file C# programs to:

• Run without a project file
• Automatically reference common packages
• Support top-level statements

Learning Resources Copy Chapter

• .NET File-Based Apps Documentation
• GitHub Copilot SDK Documentation
• Parent Cookbook

File: cookbook/copilot-sdk/dotnet/README.md Copy Chapter

GitHub Copilot SDK Cookbook — .NET (C#)

This folder hosts short, practical recipes for using the GitHub Copilot SDK with .NET. Each recipe is concise, copy‑pasteable, and points to fuller examples and tests.

Recipes Copy Chapter

• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.

Contributing Copy Chapter

Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in CONTRIBUTING.md.

Status Copy Chapter

These recipes are now complete and ready to use; the cookbook will continue to evolve as new scenarios are added.

File: cookbook/copilot-sdk/go/recipe/README.md Copy Chapter

Runnable Recipe Examples

This folder contains standalone, executable Go examples for each cookbook recipe. Each file is a complete program that can be run directly with go run.

Prerequisites Copy Chapter

• Go 1.21 or later
• GitHub Copilot SDK for Go

go get github.com/github/copilot-sdk/go

Running Examples Copy Chapter

Each .go file is a complete, runnable program. Simply use:

go run <filename>.go

Available Recipes Copy Section

Examples with Arguments Copy Section

PR Visualization with specific repo:

go run pr-visualization.go -repo github/copilot-sdk

Managing Local Files (edit the file to change target folder):

# Edit the targetFolder variable in managing-local-files.go first
go run managing-local-files.go

Go Best Practices Copy Chapter

These examples follow Go conventions:

• Proper error handling with explicit checks
• Use of defer for cleanup
• Idiomatic naming (camelCase for local variables)
• Standard library usage where appropriate
• Clean separation of concerns

Learning Resources Copy Chapter

• Go Documentation
• GitHub Copilot SDK for Go
• Parent Cookbook

File: cookbook/copilot-sdk/go/README.md Copy Chapter

GitHub Copilot SDK Cookbook — Go

This folder hosts short, practical recipes for using the GitHub Copilot SDK with Go. Each recipe is concise, copy‑pasteable, and points to fuller examples and tests.

Recipes Copy Chapter

• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.

Contributing Copy Chapter

Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in CONTRIBUTING.md.

Status Copy Chapter

These recipes are complete, practical examples and can be used directly or adapted for your own projects.

File: cookbook/copilot-sdk/nodejs/recipe/README.md Copy Chapter

Runnable Recipe Examples

This folder contains standalone, executable TypeScript examples for each cookbook recipe. Each file can be run directly with tsx or via npm scripts.

Prerequisites Copy Chapter

• Node.js 18 or later
• Install dependencies (this links to the local SDK in the repo):

npm install

Running Examples Copy Chapter

Each .ts file is a complete, runnable program. You can run them in two ways:

Using npm scripts: Copy Section

npm run <script-name>

Using tsx directly: Copy Section

npx tsx <filename>.ts

Available Recipes Copy Section

Examples with Arguments Copy Section

PR Visualization with specific repo:

npx tsx pr-visualization.ts --repo github/copilot-sdk

Managing Local Files (edit the file to change target folder):

# Edit the targetFolder variable in managing-local-files.ts first
npx tsx managing-local-files.ts

Local SDK Development Copy Chapter

The package.json references the local Copilot SDK using "*", which resolves to the local SDK source. This means:

• Changes to the SDK source are immediately available
• No need to publish or install from npm
• Perfect for testing and development

If you modify the SDK source, you may need to rebuild:

cd ../../src
npm run build

TypeScript Features Copy Chapter

These examples use modern TypeScript/Node.js features:

• Top-level await (requires "type": "module" in package.json)
• ESM imports
• Type safety with TypeScript
• async/await patterns

Learning Resources Copy Chapter

• TypeScript Documentation
• Node.js Documentation
• GitHub Copilot SDK for Node.js
• Parent Cookbook

File: cookbook/copilot-sdk/nodejs/README.md Copy Chapter

GitHub Copilot SDK Cookbook — Node.js / TypeScript

This folder hosts short, practical recipes for using the GitHub Copilot SDK with Node.js/TypeScript. Each recipe is concise, copy‑pasteable, and points to fuller examples and tests.

Recipes Copy Chapter

• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.

Contributing Copy Chapter

Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in CONTRIBUTING.md.

Status Copy Chapter

This README is a scaffold; recipe files are placeholders until populated.

File: cookbook/copilot-sdk/python/recipe/README.md Copy Chapter

Runnable Recipe Examples

This folder contains standalone, executable Python examples for each cookbook recipe. Each file can be run directly as a Python script.

Prerequisites Copy Chapter

• Python 3.8 or later
• Install dependencies (this installs the SDK from PyPI):

pip install -r requirements.txt

Running Examples Copy Chapter

Each .py file is a complete, runnable program with executable permissions:

python <filename>.py
# or on Unix-like systems:
./<filename>.py

Available Recipes Copy Section

Examples with Arguments Copy Section

PR Visualization with specific repo:

python pr_visualization.py --repo github/copilot-sdk

Managing Local Files (edit the file to change target folder):

# Edit the target_folder variable in managing_local_files.py first
python managing_local_files.py

Local SDK Development Copy Chapter

The requirements.txt installs the Copilot SDK package from PyPI. This means:

• You get the latest stable release of the SDK
• No need to build from source
• Perfect for using the SDK in your projects

If you want to use a local development version, edit requirements.txt to use -e ../.. for editable mode development.

Python Best Practices Copy Chapter

These examples follow Python conventions:

• PEP 8 naming (snake_case for functions and variables)
• Shebang line for direct execution
• Proper exception handling
• Type hints where appropriate
• Standard library usage

Virtual Environment (Recommended) Copy Chapter

For isolated development:

# Create virtual environment
python -m venv venv

# Activate it
# Windows:
venv\Scripts\activate
# Unix/macOS:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

Learning Resources Copy Chapter

• Python Documentation
• PEP 8 Style Guide
• GitHub Copilot SDK for Python
• Parent Cookbook

File: cookbook/copilot-sdk/python/README.md Copy Chapter

GitHub Copilot SDK Cookbook — Python

This folder hosts short, practical recipes for using the GitHub Copilot SDK with Python. Each recipe is concise, copy‑pasteable, and points to fuller examples and tests.

Recipes Copy Chapter

• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Error Recovery Hooks: Classify tool failures and nudge the LLM to keep investigating instead of giving up.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• PyInstaller Frozen Build: Package a Copilot SDK application into a standalone executable with PyInstaller.

Contributing Copy Chapter

Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in CONTRIBUTING.md.

Status Copy Chapter

These recipes are complete and ready to use; new contributions and additional recipes are welcome.

File: cookbook/copilot-sdk/README.md Copy Chapter

GitHub Copilot SDK Cookbook

This cookbook collects small, focused recipes showing how to accomplish common tasks with the GitHub Copilot SDK across languages. Each recipe is intentionally short and practical, with copy‑pasteable snippets and pointers to fuller examples and tests.

Recipes by Language Copy Chapter

.NET (C#) Copy Section

• Ralph Loop: Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• Accessibility Report: Generate WCAG accessibility reports using the Playwright MCP server.

Node.js / TypeScript Copy Section

• Ralph Loop: Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• Accessibility Report: Generate WCAG accessibility reports using the Playwright MCP server.

Python Copy Section

• Ralph Loop: Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• Accessibility Report: Generate WCAG accessibility reports using the Playwright MCP server.

Go Copy Section

• Ralph Loop: Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• Accessibility Report: Generate WCAG accessibility reports using the Playwright MCP server.

Java Copy Section

• Ralph Loop: Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
• Error Handling: Handle errors gracefully including connection failures, timeouts, and cleanup.
• Multiple Sessions: Manage multiple independent conversations simultaneously.
• Managing Local Files: Organize files by metadata using AI-powered grouping strategies.
• PR Visualization: Generate interactive PR age charts using GitHub MCP Server.
• Persisting Sessions: Save and resume sessions across restarts.
• Accessibility Report: Generate WCAG accessibility reports using the Playwright MCP server.

How to Use Copy Chapter

• Browse your language section above and open the recipe links
• Each recipe includes runnable examples in a recipe/ subfolder with language-specific tooling
• See existing examples and tests for working references:
  • Node.js examples: nodejs/examples/basic-example.ts
  • E2E tests: go/e2e, python/e2e, nodejs/test/e2e, dotnet/test/Harness

Running Examples Copy Chapter

.NET Copy Section

cd dotnet/cookbook/recipe
dotnet run <filename>.cs

Node.js Copy Section

cd nodejs/cookbook/recipe
npm install
npx tsx <filename>.ts

Python Copy Section

cd python/cookbook/recipe
pip install -r requirements.txt
python <filename>.py

Go Copy Section

cd go/cookbook/recipe
go run <filename>.go

Java Copy Section

cd java/recipe
jbang <FileName>.java

Contributing Copy Chapter

• Propose or add a new recipe by creating a markdown file in your language's cookbook/ folder and a runnable example in recipe/
• Follow repository guidance in CONTRIBUTING.md

Status Copy Chapter

Cookbook structure is complete with 7 recipes across all 5 supported languages. Each recipe includes both markdown documentation and runnable examples.

2. Official Technical Reference & Guides (github/docs) Copy Chapter

GitHub Docs

Welcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our contributing guide.

Quick links by contributor type Copy Chapter

• Hubbers (GitHub employees): See CONTRIBUTING.md in the docs-content repository for GitHub-specific processes.

• Open source contributors: See CONTRIBUTING.md in the docs repository for a quick-start summary.

How we sync changes across Docs repositories Copy Chapter

There are two GitHub Docs repositories:

• github/docs (public): Open to external contributions

• github/docs-internal (private): For GitHub employee contributions.

The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in docs when working with a customer, but docs has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to docs-internal.

Important: The docs repository accepts contributions to content files (.md files in /content and select /data sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification.

New to contributing Copy Chapter

Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

License Copy Chapter

This project is dual-licensed under:

• Creative Commons Attribution 4.0 - for documentation and content in the assets, content, and data folders (see LICENSE)
• MIT License - for code (see LICENSE-CODE)