|
1 | 1 | # 🤖 Awesome GitHub Copilot |
2 | 2 | [](https://aka.ms/awesome-github-copilot) [](#contributors-) |
3 | 3 |
|
| 4 | +A community-created collection of custom agents, instructions, skills, hooks, workflows, and plugins to supercharge your GitHub Copilot experience. |
4 | 5 |
|
5 | | -A community created collection of custom agents and instructions to supercharge your GitHub Copilot experience across different domains, languages, and use cases. |
| 6 | +> [!TIP] |
| 7 | +> **Explore the full collection on the website →** [awesome-copilot.github.com](https://awesome-copilot.github.com) |
| 8 | +> |
| 9 | +> The website offers full-text search and filtering across hundreds of resources, plus the [Tools](https://awesome-copilot.github.com/tools) section for MCP servers and developer tooling, and the [Learning Hub](https://awesome-copilot.github.com/learning-hub) for guides and tutorials. |
| 10 | +> |
| 11 | +> **Using this collection in an AI agent?** A machine-readable [`llms.txt`](https://awesome-copilot.github.com/llms.txt) is available with structured listings of all agents, instructions, and skills. |
6 | 12 |
|
7 | | -## 🚀 What is Awesome GitHub Copilot? |
| 13 | +## 📖 Learning Hub |
8 | 14 |
|
9 | | -This repository provides a comprehensive toolkit for enhancing GitHub Copilot with specialized: |
| 15 | +New to GitHub Copilot customization? The **[Learning Hub](https://awesome-copilot.github.com/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. |
10 | 16 |
|
11 | | -- **👉 [Awesome Agents](docs/README.agents.md)** - Specialized GitHub Copilot agents that integrate with MCP servers to provide enhanced capabilities for specific workflows and tools |
12 | | -- **👉 [Awesome Instructions](docs/README.instructions.md)** - Comprehensive coding standards and best practices that apply to specific file patterns or entire projects |
13 | | -- **👉 [Awesome Hooks](docs/README.hooks.md)** - Automated workflows triggered by specific events during development, testing, and deployment |
14 | | -- **👉 [Awesome Agentic Workflows](docs/README.workflows.md)** - AI-powered repository automations that run coding agents in GitHub Actions with natural language instructions |
15 | | -- **👉 [Awesome Skills](docs/README.skills.md)** - Self-contained folders with instructions and bundled resources that enhance AI capabilities for specialized tasks |
16 | | -- **👉 [Awesome Plugins](docs/README.plugins.md)** - Curated plugins of related agents and skills organized around specific themes and workflows |
17 | | -- **👉 [Awesome Cookbook Recipes](cookbook/README.md)** - Practical, copy-paste-ready code snippets and real-world examples for working with GitHub Copilot tools and features |
| 17 | +## What's in this repo |
18 | 18 |
|
19 | | -## 🌟 Featured Plugins |
| 19 | +| Resource | Description | Browse | |
| 20 | +|----------|-------------|--------| |
| 21 | +| 🤖 [Agents](docs/README.agents.md) | Specialized Copilot agents that integrate with MCP servers | [All agents →](https://awesome-copilot.github.com/agents) | |
| 22 | +| 📋 [Instructions](docs/README.instructions.md) | Coding standards applied automatically by file pattern | [All instructions →](https://awesome-copilot.github.com/instructions) | |
| 23 | +| 🎯 [Skills](docs/README.skills.md) | Self-contained folders with instructions and bundled assets | [All skills →](https://awesome-copilot.github.com/skills) | |
| 24 | +| 🔌 [Plugins](docs/README.plugins.md) | Curated bundles of agents and skills for specific workflows | [All plugins →](https://awesome-copilot.github.com/plugins) | |
| 25 | +| 🪝 [Hooks](docs/README.hooks.md) | Automated actions triggered during Copilot agent sessions | [All hooks →](https://awesome-copilot.github.com/hooks) | |
| 26 | +| ⚡ [Agentic Workflows](docs/README.workflows.md) | AI-powered GitHub Actions automations written in markdown | [All workflows →](https://awesome-copilot.github.com/workflows) | |
| 27 | +| 🍳 [Cookbook](cookbook/README.md) | Copy-paste-ready recipes for working with Copilot APIs | — | |
20 | 28 |
|
21 | | -Discover our curated plugins of agents and skills organized around specific themes and workflows. |
| 29 | +## 🛠️ Tools |
22 | 30 |
|
23 | | -| Name | Description | Items | Tags | |
24 | | -| ---- | ----------- | ----- | ---- | |
25 | | -| [Awesome Copilot](plugins/awesome-copilot/README.md) | Meta skills that help you discover and generate curated GitHub Copilot agents, collections, instructions, and skills. | 5 items | github-copilot, discovery, meta, prompt-engineering, agents | |
26 | | -| [Copilot SDK](plugins/copilot-sdk/README.md) | Build applications with the GitHub Copilot SDK across multiple programming languages. Includes comprehensive instructions for C#, Go, Node.js/TypeScript, and Python to help you create AI-powered applications. | 5 items | copilot-sdk, sdk, csharp, go, nodejs, typescript, python, ai, github-copilot | |
27 | | -| [Partners](plugins/partners/README.md) | Custom agents that have been created by GitHub partners | 20 items | devops, security, database, cloud, infrastructure, observability, feature-flags, cicd, migration, performance | |
| 31 | +Looking at how to use Awesome Copilot? Check out the **[Tools section](https://awesome-copilot.github.com/tools)** of the website for MCP servers, editor integrations, and other developer tooling to get the most out of this collection. |
28 | 32 |
|
| 33 | +## Install a Plugin |
29 | 34 |
|
30 | | -## How to Install Customizations |
31 | | - |
32 | | -To make it easy to add these customizations to your editor, we have created an [MCP Server](https://developer.microsoft.com/blog/announcing-awesome-copilot-mcp-server) that provides functionality for searching and installing instructions, agents, and skills directly from this repository. You'll need to have Docker installed and running to run the MCP server locally. |
33 | | - |
34 | | -[](https://aka.ms/awesome-copilot/mcp/vscode) [](https://aka.ms/awesome-copilot/mcp/vscode-insiders) [](https://aka.ms/awesome-copilot/mcp/vs) |
35 | | - |
36 | | -<details> |
37 | | -<summary>Show MCP Server JSON configuration</summary> |
38 | | - |
39 | | -```json |
40 | | -{ |
41 | | - "servers": { |
42 | | - "awesome-copilot": { |
43 | | - "type": "stdio", |
44 | | - "command": "docker", |
45 | | - "args": [ |
46 | | - "run", |
47 | | - "-i", |
48 | | - "--rm", |
49 | | - "ghcr.io/microsoft/mcp-dotnet-samples/awesome-copilot:latest" |
50 | | - ] |
51 | | - } |
52 | | - } |
53 | | -} |
54 | | -``` |
55 | | - |
56 | | -</details> |
57 | | - |
58 | | -## 📄 llms.txt |
59 | | - |
60 | | -An [`llms.txt`](https://awesome-copilot.github.com/llms.txt) file following the [llmstxt.org](https://llmstxt.org/) specification is available on the GitHub Pages site. This machine-readable file makes it easy for Large Language Models to discover and understand all available agents, instructions, and skills, providing a structured overview of the repository's resources with names and descriptions. |
61 | | - |
62 | | -## 🔧 How to Use |
63 | | - |
64 | | -### 🔌 Plugins |
65 | | - |
66 | | -Plugins are installable packages that bundle related agents and skills, making it easy to install a curated set of resources. |
67 | | - |
68 | | -#### Installing Plugins |
69 | | - |
70 | | -First, add the Awesome Copilot marketplace to your Copilot CLI: |
| 35 | +For most users, the **Awesome Copilot** marketplace is already registered in the Copilot CLI/VS Code, so you can install a plugin directly: |
71 | 36 |
|
72 | 37 | ```bash |
73 | | -copilot plugin marketplace add github/awesome-copilot |
| 38 | +copilot plugin install <plugin-name>@awesome-copilot |
74 | 39 | ``` |
75 | 40 |
|
76 | | -Then install any plugin: |
| 41 | +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: |
77 | 42 |
|
78 | 43 | ```bash |
| 44 | +copilot plugin marketplace add github/awesome-copilot |
79 | 45 | copilot plugin install <plugin-name>@awesome-copilot |
80 | 46 | ``` |
81 | 47 |
|
82 | | -Alternatively, you can use the `/plugin` command within a Copilot chat session to browse and install plugins interactively. |
83 | | - |
84 | | -### 🤖 Custom Agents |
85 | | - |
86 | | -Custom agents can be used in Copilot coding agent (CCA), VS Code, and Copilot CLI (coming soon). For CCA, when assigning an issue to Copilot, select the custom agent from the provided list. In VS Code, you can activate the custom agent in the agents session, alongside built-in agents like Plan and Agent. |
87 | | - |
88 | | -### 🎯 Skills |
89 | | - |
90 | | -Skills are self-contained folders with instructions and bundled resources that enhance AI capabilities for specialized tasks. They can be accessed through the GitHub Copilot interface or installed via plugins. |
91 | | - |
92 | | -### 📋 Instructions |
93 | | - |
94 | | -Instructions automatically apply to files based on their patterns and provide contextual guidance for coding standards, frameworks, and best practices. |
95 | | - |
96 | | -### 🪝 Hooks |
97 | | - |
98 | | -Hooks enable automated workflows triggered by specific events during GitHub Copilot coding agent sessions (like sessionStart, sessionEnd, userPromptSubmitted). They can automate tasks like logging, auto-committing changes, or integrating with external services. |
99 | | - |
100 | | -### ⚡ Agentic Workflows |
101 | | - |
102 | | -[Agentic Workflows](https://github.github.com/gh-aw) are AI-powered repository automations that run coding agents in GitHub Actions. Defined in markdown with natural language instructions, they enable event-triggered and scheduled automation — from issue triage to daily reports. |
103 | | - |
104 | | -## 🎯 Why Use Awesome GitHub Copilot? |
105 | | - |
106 | | -- **Productivity**: Pre-built agents and instructions save time and provide consistent results. |
107 | | -- **Best Practices**: Benefit from community-curated coding standards and patterns. |
108 | | -- **Specialized Assistance**: Access expert-level guidance through specialized custom agents. |
109 | | -- **Continuous Learning**: Stay updated with the latest patterns and practices across technologies. |
110 | | - |
111 | | -## 🤝 Contributing |
112 | | - |
113 | | -We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to: |
114 | | - |
115 | | -- Add new instructions, hooks, workflows, agents, or skills |
116 | | -- Improve existing content |
117 | | -- Report issues or suggest enhancements |
118 | | - |
119 | | -For AI coding agents working with this project, refer to [AGENTS.md](AGENTS.md) for detailed technical guidance on development workflows, setup commands, and contribution standards. |
120 | | - |
121 | | -### Quick Contribution Guide |
122 | | - |
123 | | -1. Follow our file naming conventions and frontmatter requirements |
124 | | -2. Test your contributions thoroughly |
125 | | -3. Update the appropriate README tables |
126 | | -4. Submit a pull request with a clear description |
127 | | - |
128 | | -## 📖 Repository Structure |
129 | | - |
130 | | -```plaintext |
131 | | -├── instructions/ # Coding standards and best practices (.instructions.md) |
132 | | -├── agents/ # AI personas and specialized modes (.agent.md) |
133 | | -├── hooks/ # Automated hooks for Copilot coding agent sessions |
134 | | -├── workflows/ # Agentic Workflows for GitHub Actions automation |
135 | | -├── plugins/ # Installable plugins bundling related items |
136 | | -├── scripts/ # Utility scripts for maintenance |
137 | | -└── skills/ # AI capabilities for specialized tasks |
138 | | -``` |
139 | | - |
140 | | -## 📄 License |
141 | | - |
142 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
143 | | - |
144 | | -## 🛡️ Security & Support |
145 | | - |
146 | | -- **Security Issues**: Please see our [Security Policy](SECURITY.md) |
147 | | -- **Support**: Check our [Support Guide](SUPPORT.md) for getting help |
148 | | -- **Code of Conduct**: We follow the [Contributor Covenant](CODE_OF_CONDUCT.md) |
149 | | - |
150 | | -## ℹ️ Disclaimer |
151 | | - |
152 | | -The customizations in this repository are sourced from and created by third-party developers. GitHub does not verify, endorse, or guarantee the functionality or security of these agents. Please carefully inspect any agent and its documentation before installing to understand permissions it may require and actions it may perform. |
| 48 | +## Contributing |
153 | 49 |
|
154 | | ---- |
| 50 | +See [CONTRIBUTING.md](CONTRIBUTING.md) · [AGENTS.md](AGENTS.md) for AI agent guidance · [Security](SECURITY.md) · [Code of Conduct](CODE_OF_CONDUCT.md) |
155 | 51 |
|
156 | | -**Ready to supercharge your coding experience?** Start exploring our [instructions](docs/README.instructions.md), [hooks](docs/README.hooks.md), [skills](docs/README.skills.md), [agentic workflows](docs/README.workflows.md), and [custom agents](docs/README.agents.md)! |
| 52 | +> The customizations here are sourced from third-party developers. Please inspect any agent and its documentation before installing. |
157 | 53 |
|
158 | 54 | ## Contributors ✨ |
159 | 55 |
|
|
0 commit comments