### Local Development Setup Source: https://github.com/github/awesome-copilot/blob/main/skills/ai-team-orchestration/references/project-brief-template.md Installs project dependencies and starts the local development server. Ensure you copy the example settings file before running. ```bash npm install cd api && npm install cp api/local.settings.json.example api/local.settings.json npm run dev:all ``` -------------------------------- ### Quickstart: First API Call Examples Source: https://github.com/github/awesome-copilot/blob/main/skills/onboard-context-matic/SKILL.md Examples of how to initiate common API integrations using the `/integrate-context-matic` command, covering setup, authentication, and basic calls. ```bash /integrate-context-matic Set up the Spotify TypeScript SDK and fetch my top 5 tracks. Show me the complete client initialization and the API call. ``` ```bash /integrate-context-matic How do I authenticate with the Twilio API and send an SMS? Give me the full PHP setup including the SDK client and the send call. ``` ```bash /integrate-context-matic Walk me through initializing the Slack API client in a Python script and posting a message to a channel. ``` -------------------------------- ### Workflow 1: First-Time Store Setup Source: https://github.com/github/awesome-copilot/blob/main/skills/msstore-cli/SKILL.md Guides through the initial setup of the Microsoft Store CLI, including installation, credential configuration, and verification. ```bash # 1. Install the CLI winget install "Microsoft Store Developer CLI" # 2. Configure credentials (get these from Partner Center) msstore reconfigure --tenantId $TENANT_ID --sellerId $SELLER_ID --clientId $CLIENT_ID --clientSecret $CLIENT_SECRET # 3. Verify configuration msstore info # 4. List your apps to confirm access msstore apps list ``` -------------------------------- ### Install Dependencies and Run Example Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/nodejs/accessibility-report.md Navigate to the recipe directory, install its dependencies, and then run the accessibility report script. This is a runnable example. ```bash cd recipe && npm install npx tsx accessibility-report.ts ``` -------------------------------- ### Install and Build Penpot MCP Server Source: https://github.com/github/awesome-copilot/blob/main/skills/penpot-uiux-design/SKILL.md Quick start commands to clone the repository, install dependencies, and build the Penpot MCP server. This is only needed if the server is not already installed. ```bash git clone https://github.com/penpot/penpot-mcp.git cd penpot-mcp npm install npm run bootstrap ``` -------------------------------- ### Basic Client Setup Source: https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-nodejs.instructions.md Demonstrates how to initialize and start a CopilotClient, and then stop it. ```APIDOC ## Basic Client Setup ```typescript import { CopilotClient, approveAll } from "@github/copilot-sdk"; const client = new CopilotClient(); await client.start(); // Use client... await client.stop(); ``` ``` -------------------------------- ### Install and Run Ralph Loop Example Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/nodejs/ralph-loop.md Installs dependencies and runs a Ralph loop recipe. Ensure you have Node.js and npm installed. ```bash npm install npx tsx recipe/ralph-loop.ts ``` -------------------------------- ### Client Initialization Source: https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-csharp.instructions.md Demonstrates the basic setup and asynchronous start of a CopilotClient instance. ```APIDOC ## Client Initialization ### Basic Client Setup ```csharp await using var client = new CopilotClient(); await client.StartAsync(); ``` ``` -------------------------------- ### Project Setup and Build Instructions Source: https://github.com/github/awesome-copilot/blob/main/skills/game-engine/assets/gameBase-template-repo.md Provides commands for cloning the repository, installing Haxe dependencies, and building/running the project using the HashLink target. ```bash # Clone the repository git clone https://github.com/deepnight/gameBase.git my-game cd my-game # Install Haxe dependencies haxelib install heaps haxelib install deepnightLibs haxelib install ldtk-haxe-api # Build and run (HashLink target) haxe build.hxml hl bin/client.hl # Or use the Makefile (if available) make run ``` -------------------------------- ### Run Ralph Loop Example Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/python/ralph-loop.md Installs dependencies and runs the Ralph Loop example. Ensure PROMPT.md and PROMPT_plan.md exist in the working directory. ```bash pip install -r cookbook/copilot-sdk/python/recipe/requirements.txt python cookbook/copilot-sdk/python/recipe/ralph_loop.py ``` -------------------------------- ### Setup CodeQL CLI Source: https://github.com/github/awesome-copilot/blob/main/skills/codeql/references/cli-commands.md Extract the CodeQL bundle and add the CLI to your system's PATH. Verify the installation by resolving packs and languages. ```bash tar xf codeql-bundle-linux64.tar.zst export PATH="$HOME/codeql:$PATH" codeql resolve packs codeql resolve languages ``` -------------------------------- ### Install GitHub Copilot SDK for Go Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/recipe/README.md Use `go get` to install the GitHub Copilot SDK for Go. Ensure you have Go 1.21 or later. ```bash go get github.com/github/copilot-sdk/go ``` -------------------------------- ### Install and Initialize Power BI Visuals Project Source: https://github.com/github/awesome-copilot/blob/main/instructions/power-bi-custom-visuals-development.instructions.md Installs the Power BI visuals tools globally, creates a new visual project, and starts the development server. ```bash npm install -g powerbi-visuals-tools pbiviz new MyCustomVisual cd MyCustomVisual pbiviz start ``` -------------------------------- ### Node.js/JavaScript Setup Steps for GitHub Actions Source: https://github.com/github/awesome-copilot/blob/main/skills/github-copilot-starter/SKILL.md Includes Node.js version setup, dependency installation using npm, linting, and testing for Node.js/JavaScript projects. ```yaml - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: "20" cache: "npm" - name: Install dependencies run: npm ci - name: Run linter run: npm run lint - name: Run tests run: npm test ``` -------------------------------- ### Example: Select Deployment Region Source: https://github.com/github/awesome-copilot/blob/main/skills/azure-architecture-autopilot/references/phase1-advisor.md This example shows how to use the `ask_user` tool to get the user's preferred Azure region for deployment. It includes a recommendation and a reference link. ```javascript ask_user({ question: "Please select the Azure region for deployment. Ref: https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models", choices: [ "Korea Central - Korea region, supports most services (Recommended)", "East US - US East, supports all AI models", "Japan East - Japan East, close to Korea" ] }) ``` -------------------------------- ### Pre-commit Setup and Commands Source: https://github.com/github/awesome-copilot/blob/main/skills/python-pypi-package-builder/references/tooling-ruff.md Install pre-commit and set up git hooks. Run checks manually or update hooks. ```bash pip install pre-commit pre-commit install # Installs git hook — runs on every commit pre-commit run --all-files # Run manually on all files pre-commit autoupdate # Update all hooks to latest pinned versions ``` -------------------------------- ### Python Test Setup Example Source: https://github.com/github/awesome-copilot/blob/main/skills/quality-playbook/references/functional_tests.md Example of setting up a Python test, emphasizing the need to import and call actual project code rather than using placeholders. ```python pass ``` -------------------------------- ### Start Development Server Source: https://github.com/github/awesome-copilot/blob/main/instructions/tailwind-v4-vite.instructions.md Run the development server to test your Tailwind CSS installation. ```bash npm run dev ``` -------------------------------- ### Initial Setup and Project Selection Source: https://github.com/github/awesome-copilot/blob/main/agents/atlassian-requirements-to-jira.agent.md This sample interaction flow demonstrates the initial setup where the agent fetches available Jira projects and prompts the user for selection. ```text 🚀 STARTING REQUIREMENTS ANALYSIS Step 1: Let me get your available Jira projects... [Fetching projects using mcp_atlassian_getVisibleJiraProjects] 📋 Available Projects: 1. HRDB - HR Database Project 2. DEV - Development Tasks 3. PROJ - Main Project Backlog ❓ Which project should I use? (Enter number or project key) ``` -------------------------------- ### Quick Start Python Tracing Setup Source: https://github.com/github/awesome-copilot/blob/main/skills/phoenix-tracing/references/setup-python.md Installs and registers Phoenix tracing with auto-instrumentation enabled. Connects to http://localhost:6006 by default. ```python from phoenix.otel import register register(project_name="my-app", auto_instrument=True) ``` -------------------------------- ### Basic Client Setup Source: https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-python.instructions.md Demonstrates the basic asynchronous setup for initializing and using the CopilotClient with an async context manager. ```APIDOC ## Basic Client Setup ### Description This snippet shows how to initialize the `CopilotClient` using an asynchronous context manager, which handles the client's lifecycle automatically. ### Code ```python from copilot import CopilotClient import asyncio async def main(): async with CopilotClient() as client: # Use client... pass asyncio.run(main()) ``` ``` -------------------------------- ### Documentation Template Source: https://github.com/github/awesome-copilot/blob/main/agents/se-technical-writer.agent.md This Markdown template is for creating comprehensive documentation for features or components. It covers an overview, quick start guide, core concepts, API reference, examples, and troubleshooting. ```markdown # [Feature/Component Name] ## Overview [What it does in one sentence] [When to use it] [When NOT to use it] ## Quick Start [Minimal working example] [Most common use case] ## Core Concepts [Essential understanding needed] [Mental model for how it works] ## API Reference [Complete interface documentation] [Parameter descriptions] [Return values] ## Examples [Common patterns] [Advanced usage] [Integration scenarios] ## Troubleshooting [Common errors and solutions] [Debug strategies] [Performance tips] ``` -------------------------------- ### README.md Structure and Content Source: https://github.com/github/awesome-copilot/blob/main/skills/python-pypi-package-builder/references/community-docs.md A comprehensive README template including badges, installation instructions, quick start examples, features, configuration, and contribution guidelines. Essential for project adoption and clarity. ```markdown # your-package > One-line description — what it does and why it's useful. [![PyPI version](https://badge.fury.io/py/your-package.svg)](https://pypi.org/project/your-package/) [![Python Versions](https://img.shields.io/pypi/pyversions/your-package)](https://pypi.org/project/your-package/) [![CI](https://github.com/you/your-package/actions/workflows/ci.yml/badge.svg)](https://github.com/you/your-package/actions/workflows/ci.yml) [![Coverage](https://codecov.io/gh/you/your-package/branch/master/graph/badge.svg)](https://codecov.io/gh/you/your-package) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) ## Installation pip install your-package # With Redis backend: pip install "your-package[redis]" ## Quick Start (A copy-paste working example — no setup required to run it) from your_package import YourClient client = YourClient(api_key="sk-...") result = client.process({"input": "value"}) print(result) ## Features - Feature 1 - Feature 2 ## Configuration | Parameter | Type | Default | Description | |---|---|---|—--| | api_key | str | required | Authentication credential | | timeout | int | 30 | Request timeout in seconds | | retries | int | 3 | Number of retry attempts | ## Backends Brief comparison — in-memory vs Redis — and when to use each. ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) ## Changelog See [CHANGELOG.md](./CHANGELOG.md) ## License MIT — see [LICENSE](./LICENSE) ``` -------------------------------- ### MSTest: API Returns Products Test Source: https://github.com/github/awesome-copilot/blob/main/skills/aspire/references/testing.md An example using MSTest to test if the API returns products. It starts the application, creates an HTTP client, and asserts that the status code of the GET request to /products is OK. ```csharp [TestClass] public class IntegrationTests { [TestMethod] public async Task ApiReturnsProducts() { var builder = await DistributedApplicationTestingBuilder .CreateAsync(); await using var app = await builder.BuildAsync(); await app.StartAsync(); var client = app.CreateHttpClient("api"); var response = await client.GetAsync("/products"); Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); } } ``` -------------------------------- ### Example NuGet Tool Installer Task Source: https://github.com/github/awesome-copilot/blob/main/instructions/dotnet-upgrade.instructions.md An example of a NuGet Tool Installer task in Azure Pipelines. Replace `` with the desired NuGet version. ```yaml - task: NuGetToolInstaller@0 displayName: Use NuGet inputs: versionSpec: ``` -------------------------------- ### Workflow 2: Initialize and Publish New App Source: https://github.com/github/awesome-copilot/blob/main/skills/msstore-cli/SKILL.md Steps to initialize a new application for the Store, package it, and publish it for the first time. ```bash # 1. Navigate to project cd my-winui-app # 2. Initialize for Store (creates/updates app identity) msstore init . # 3. Package the application msstore package . --arch x64,arm64 # 4. Publish to Store msstore publish . # 5. Check submission status msstore submission status ``` -------------------------------- ### Install dotnet-coverage Tool Source: https://github.com/github/awesome-copilot/blob/main/agents/CSharpExpert.agent.md Installs the dotnet-coverage tool globally. This is a one-time setup. ```bash dotnet tool install -g dotnet-coverage ``` -------------------------------- ### NUnit: API Returns Products Test Source: https://github.com/github/awesome-copilot/blob/main/skills/aspire/references/testing.md An example using NUnit to test if the API returns products. It starts the application, creates an HTTP client, and asserts that the status code of the GET request to /products is OK using NUnit's assertion syntax. ```csharp [TestFixture] public class IntegrationTests { [Test] public async Task ApiReturnsProducts() { var builder = await DistributedApplicationTestingBuilder .CreateAsync(); await using var app = await builder.BuildAsync(); await app.StartAsync(); var client = app.CreateHttpClient("api"); var response = await client.GetAsync("/products"); Assert.That(response.StatusCode, Is.EqualTo(HttpStatusCode.OK)); } } ``` -------------------------------- ### Quick Start: Copilot Client in Go Source: https://github.com/github/awesome-copilot/blob/main/skills/copilot-sdk/SKILL.md Demonstrates creating a Copilot client, starting a session, sending a prompt, and receiving a response in Go. Requires Go 1.21+. ```go package main import ( "fmt" "log" "os" copilot "github.com/github/copilot-sdk/go" ) func main() { client := copilot.NewClient(nil) if err := client.Start(); err != nil { log.Fatal(err) } defer client.Stop() session, err := client.CreateSession(&copilot.SessionConfig{ OnPermissionRequest: copilot.PermissionHandler.ApproveAll, Model: "gpt-4.1", }) if err != nil { log.Fatal(err) } response, err := session.SendAndWait(copilot.MessageOptions{Prompt: "What is 2 + 2?"}, 0) if err != nil { log.Fatal(err) } fmt.Println(*response.Data.Content) os.Exit(0) } ``` -------------------------------- ### Use Directory Steps for Onboarding Source: https://github.com/github/awesome-copilot/blob/main/skills/code-tour/references/examples.md Employ `directory` steps to guide users through project structure, providing context for entire folders rather than individual files. ```json { "directory": "src/_data", "description": "This folder contains the **data files** for the site. Think of them as a lightweight database — YAML files that power the resource listings, posts index, and nav." } ``` -------------------------------- ### Install JBang Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/java/recipe/README.md Install JBang using package managers like Homebrew, or via curl. Refer to the JBang installation guide for other methods. ```bash # macOS (using Homebrew) brew install jbangdev/tap/jbang # Linux/macOS (using curl) curl -Ls https://sh.jbang.dev | bash -s - app setup # Windows (using Scoop) scoop install jbang ``` -------------------------------- ### Configuration File Example Source: https://github.com/github/awesome-copilot/blob/main/instructions/use-cliche-data-in-docs.instructions.md In documentation for configuration files, replace sensitive details such as hostnames, user credentials, and output directories with generic examples like 'imap.example.com', 'admin@example.com', and './downloads'. ```json { "host": "imap.example.com", "user": "admin@example.com", "folder": "INBOX/Reports", "outputDir": "./downloads" } ``` -------------------------------- ### Ellipse Element Example Source: https://github.com/github/awesome-copilot/blob/main/skills/excalidraw-diagram-generator/references/element-types.md A JSON example of an ellipse element, demonstrating its use for a 'Start' point in a flow. ```json { "type": "ellipse", "x": 100, "y": 100, "width": 120, "height": 120, "backgroundColor": "#d0f0c0", "text": "Start", "fontSize": 18, "textAlign": "center", "verticalAlign": "middle" } ``` -------------------------------- ### Get specific configuration value Source: https://github.com/github/awesome-copilot/blob/main/skills/gh-cli/SKILL.md Retrieve a specific configuration value using `gh config get `. For example, to get the configured editor or git protocol. ```bash gh config list git_protocol gh config get editor ``` -------------------------------- ### Verify Copilot CLI Setup with /help Source: https://github.com/github/awesome-copilot/blob/main/skills/copilot-cli-quickstart/SKILL.md Use the `/help` command to confirm Copilot CLI is functioning correctly and to view available commands. This is the first step in verifying your installation. ```bash Use ask_user: "🏋️ Let's make sure everything is working! Try typing /help right now. Did you see a list of commands?" choices: ["✅ Yes! I see all the commands!", "🤔 Something looks different than expected", "❓ What am I looking at?"] ``` -------------------------------- ### Run a Copilot SDK Recipe Example Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/recipe/README.md Execute any of the standalone Go recipe files using the `go run` command. Each file is a complete program. ```bash go run .go ``` -------------------------------- ### Get Dataset Examples or Filter by Split Source: https://github.com/github/awesome-copilot/blob/main/skills/phoenix-cli/SKILL.md Fetches examples from a specific dataset, allowing extraction of input/output pairs. You can also filter examples by a specific split (e.g., 'train'). ```bash px dataset get --format raw | jq '.examples[] | {input, output: .expected_output}' ``` ```bash px dataset get --split train --format raw | jq . ``` -------------------------------- ### Create Dataset from Examples Source: https://github.com/github/awesome-copilot/blob/main/skills/phoenix-evals/references/experiments-datasets-python.md Use this to create a new dataset by providing a list of examples directly. Ensure each example has 'input', 'output', and optional 'metadata'. ```python from phoenix.client import Client client = Client() # From examples dataset = client.datasets.create_dataset( name="qa-test-v1", examples=[ { "input": {"question": "What is 2+2?"}, "output": {"answer": "4"}, "metadata": {"category": "math"}, }, ], ) ``` -------------------------------- ### Multi-Repo Project Setup Source: https://github.com/github/awesome-copilot/blob/main/skills/ai-team-orchestration/references/project-brief-template.md Clones a repository, checks out a specific branch, and installs dependencies for a new team member or project setup. ```bash git clone cd git checkout -b npm install ``` -------------------------------- ### Install Copilot SDK for Go Source: https://github.com/github/awesome-copilot/blob/main/skills/copilot-sdk/SKILL.md Initializes a Go module and fetches the Copilot SDK for use in a Go project. ```bash mkdir copilot-demo && cd copilot-demo go mod init copilot-demo go get github.com/github/copilot-sdk/go ``` -------------------------------- ### HTTP GET Request Example Source: https://github.com/github/awesome-copilot/blob/main/skills/web-coder/references/http-networking.md Demonstrates a typical HTTP GET request with common headers. Includes Host, User-Agent, Accept, and Authorization. ```http GET /api/users HTTP/1.1 Host: example.com User-Agent: Mozilla/5.0 Accept: application/json, text/plain Accept-Language: en-US,en;q=0.9 Accept-Encoding: gzip, deflate, br Authorization: Bearer token123 Cookie: sessionId=abc123 If-None-Match: "etag-value" If-Modified-Since: Wed, 21 Oct 2015 07:28:00 GMT Origin: https://example.com Referer: https://example.com/page ``` -------------------------------- ### File Structure Example Source: https://github.com/github/awesome-copilot/blob/main/instructions/codexer.instructions.md Illustrates a recommended project file structure for organization and maintainability. ```text project/ ├── src/ # Actual code, not "src" dumping ground ├── tests/ # Tests that actually test ├── docs/ # Real documentation, not wikis ├── requirements.txt # Pinned versions - no "latest" └── pyproject.toml # Project metadata, not config dumps ``` -------------------------------- ### Install and Verify CodeQL CLI Source: https://github.com/github/awesome-copilot/blob/main/skills/codeql/SKILL.md Download the CodeQL bundle, add it to the PATH, and verify the installation by resolving packs and languages. Always use the bundle for query compatibility and performance. ```bash # Download from https://github.com/github/codeql-action/releases # Extract and add to PATH export PATH="$HOME/codeql:$PATH" # Verify installation codeql resolve packs codeql resolve languages ``` -------------------------------- ### Symfony MCP Bundle Installation Source: https://github.com/github/awesome-copilot/blob/main/instructions/php-mcp-server.instructions.md Install the official Symfony MCP bundle for native integration with Symfony applications. This simplifies the setup process. ```bash // Use symfony/mcp-bundle for native integration composer require symfony/mcp-bundle ``` -------------------------------- ### Package Installation Explanation (Noob Mode) Source: https://github.com/github/awesome-copilot/blob/main/skills/noob-mode/references/examples.md Explains a package installation request, detailing the package, its purpose, associated risks, and the consequences of approval or denial. ```text 📋 WHAT I'M ASKING TO DO: I want to download a widely-used utility library called "lodash" (version 4.17.21). It provides helper functions for working with data. 🎯 WHY: The code I'm writing needs a function to safely access nested data. Lodash provides this, and it's the industry standard. ⚠️ RISK: 🟡 Moderate This downloads code from the internet and adds it to your project. Lodash is extremely well-known and trusted — it's used by millions of projects. ✅ If you approve: The library gets downloaded into a "node_modules" folder. Your actual project files aren't changed. ❌ If you decline: I'll write the utility function by hand instead, which takes a bit longer. [y/n] ``` -------------------------------- ### Start Agents Playground Locally Source: https://github.com/github/awesome-copilot/blob/main/instructions/declarative-agents-microsoft365.instructions.md Install and start the Agents Playground locally to test your agent. Ensure you have an agent manifest file available. ```bash # Start Agents Playground npm install -g @microsoft/agents-playground agents-playground start --manifest=./agent.json ``` -------------------------------- ### Example Azure Function Source: https://github.com/github/awesome-copilot/blob/main/skills/azure-static-web-apps/SKILL.md An example HTTP-triggered Azure Function that returns a greeting. It handles GET and POST requests and allows a 'name' query parameter. ```javascript const { app } = require('@azure/functions'); app.http('message', { methods: ['GET', 'POST'], authLevel: 'anonymous', handler: async (request) => { const name = request.query.get('name') || 'World'; return { jsonBody: { message: `Hello, ${name}!` } }; } }); ``` -------------------------------- ### Onboarding Tour Structure Example Source: https://github.com/github/awesome-copilot/blob/main/agents/code-tour.agent.md An example of a primary tour file structured for new developer onboarding, including an introduction and a file-specific step. ```json { "title": "1 - Getting Started", "description": "Essential concepts for new team members", "isPrimary": true, "nextTour": "2 - Core Architecture", "steps": [ { "description": "# Welcome!\n\nThis tour will guide you through our codebase...", "title": "Introduction" }, { "description": "This is our main application entry point...", "file": "src/app.ts", "line": 1 } ] } ``` -------------------------------- ### Migrate Application.MainPage to CreateWindow Source: https://github.com/github/awesome-copilot/blob/main/instructions/dotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md This example demonstrates the migration from the deprecated `Application.MainPage` property to the recommended `CreateWindow` method for initializing the application's main window. It also shows how to switch pages in the new model. ```csharp // ❌ OLD (Deprecated) public partial class App : Application { public App() { InitializeComponent(); MainPage = new AppShell(); } // Changing page later public void SwitchToLoginPage() { MainPage = new LoginPage(); } } // ✅ NEW (Recommended) public partial class App : Application { public App() { InitializeComponent(); } protected override Window CreateWindow(IActivationState? activationState) { return new Window(new AppShell()); } // Changing page later public void SwitchToLoginPage() { if (Windows.Count > 0) { Windows[0].Page = new LoginPage(); } } } ``` -------------------------------- ### Full Release Flow with setuptools_scm Source: https://github.com/github/awesome-copilot/blob/main/skills/python-pypi-package-builder/references/pyproject-toml.md Demonstrates the minimal steps required for a full package release using git tags and pushing to origin, which can trigger automated publishing workflows. ```bash git tag v1.2.0 git push origin master --tags # GitHub Actions publish.yml triggers automatically ``` -------------------------------- ### Eyeball Setup Check Source: https://github.com/github/awesome-copilot/blob/main/skills/eyeball/SKILL.md Run this command to verify that all necessary dependencies for the Eyeball tool are installed. If dependencies are missing, the subsequent installation command should be used. ```bash python3 /eyeball.py setup-check ``` -------------------------------- ### Code Example Documentation Format Source: https://github.com/github/awesome-copilot/blob/main/instructions/update-docs-on-code-change.instructions.md Recommended format for including runnable code examples within documentation, including setup, code, and expected output. ```markdown ### Example: [Clear description of what example demonstrates] ```language // Include necessary imports/setup import { function } from 'package'; // Complete, runnable example const result = function(parameter); console.log(result); ``` **Output:** ``` expected output ``` ``` -------------------------------- ### Chaining Tools for Full Integrations Examples Source: https://github.com/github/awesome-copilot/blob/main/skills/onboard-context-matic/SKILL.md Examples showcasing how to combine multiple API calls and tools for complex integrations, such as real-time notifications or cross-API data synchronization. ```bash /integrate-context-matic I want to add real-time order shipping notifications to my Next.js store. Use Twilio to send an SMS when the order status changes to "shipped". Show me the full integration: SDK setup, the correct endpoint and its parameters, and the TypeScript code. ``` ```bash /integrate-context-matic I need to post a Slack message every time a Spotify track changes in my playlist monitoring app. Walk me through integrating both APIs in TypeScript — start by discovering what's available, then show me the auth setup and the exact API calls. ``` ```bash /integrate-context-matic In my ASP.NET Core app, I want to geocode user addresses using Google Maps and cache the results. Look up the geocode endpoint and response model, then generate the C# code including error handling. ``` -------------------------------- ### Get WorkIQ Version Source: https://github.com/github/awesome-copilot/blob/main/skills/workiq-copilot/SKILL.md Display the installed version of the WorkIQ CLI. ```bash workiq version ``` -------------------------------- ### Quick Start: Copilot Client in .NET (C#) Source: https://github.com/github/awesome-copilot/blob/main/skills/copilot-sdk/SKILL.md Demonstrates creating a Copilot client, starting a session, sending a prompt, and receiving a response in C#. Requires .NET 8.0+. ```csharp using GitHub.Copilot.SDK; await using var client = new CopilotClient(); await using var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Model = "gpt-4.1", }); var response = await session.SendAndWaitAsync(new MessageOptions { Prompt = "What is 2 + 2?" }); Console.WriteLine(response?.Data.Content); ``` -------------------------------- ### Run C# Copilot SDK Example Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/recipe/README.md Execute a C# Copilot SDK recipe example using the `dotnet run` command with the specific filename. ```bash dotnet run .cs ``` -------------------------------- ### Python Setup Steps for GitHub Actions Source: https://github.com/github/awesome-copilot/blob/main/skills/github-copilot-starter/SKILL.md Includes Python version setup, dependency installation from requirements.txt, linting with flake8, and testing with pytest for Python projects. ```yaml - name: Set up Python uses: actions/setup-python@v4 with: python-version: "3.11" - name: Install dependencies run: pip install -r requirements.txt - name: Run linter run: flake8 . - name: Run tests run: pytest ``` -------------------------------- ### Test Local Deployment with API Source: https://github.com/github/awesome-copilot/blob/main/skills/azure-static-web-apps/SKILL.md Start the local development server using `swa start`, specifying the output location for your built application and the location of your API. ```bash npx swa start ./dist --api-location ./api # Access API at http://localhost:4280/api/message ``` -------------------------------- ### tRPC Server and Client Example Source: https://github.com/github/awesome-copilot/blob/main/skills/web-coder/references/architecture-patterns.md Demonstrates a tRPC setup with a server-side router defining a `getUser` procedure and a client-side example showing type-safe API calls. ```typescript // Server const appRouter = router({ getUser: publicProcedure .input(z.string()) .query(async ({ input }) => { return await db.user.findUnique({ where: { id: input } }); }) }); // Client (fully typed!) const user = await trpc.getUser.query('1'); ``` -------------------------------- ### Example PROMPT_build.md Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/ralph-loop.md This markdown file provides instructions for the building mode. It instructs the AI to select the most important task from the implementation plan, implement it, run tests, update the plan, and commit changes. ```markdown 0a. Study `specs/*` to learn the application specifications. 0b. Study IMPLEMENTATION_PLAN.md. 0c. Study `src/` for reference. 1. Choose the most important item from IMPLEMENTATION_PLAN.md. Before making changes, search the codebase (don't assume not implemented). 2. After implementing, run the tests. If functionality is missing, add it. 3. When you discover issues, update IMPLEMENTATION_PLAN.md immediately. 4. When tests pass, update IMPLEMENTATION_PLAN.md, then `git add -A` then `git commit` with a descriptive message. 5. When authoring documentation, capture the why. 6. Implement completely. No placeholders or stubs. 7. Keep IMPLEMENTATION_PLAN.md current — future iterations depend on it. ``` -------------------------------- ### Excalidraw Library Setup Instructions Source: https://github.com/github/awesome-copilot/blob/main/skills/excalidraw-diagram-generator/SKILL.md Provides instructions for setting up custom icon libraries in Excalidraw. This involves downloading a library file, placing it in the correct directory, and running a script to split it into individual icon files. ```bash To use [AWS/GCP/Azure/etc.] architecture icons, please follow these steps: 1. Visit https://libraries.excalidraw.com/ 2. Search for "[AWS Architecture Icons/etc.]" and download the .excalidrawlib file 3. Create directory: skills/excalidraw-diagram-generator/libraries/[icon-set-name]/ 4. Place the downloaded file in that directory 5. Run the splitter script: python skills/excalidraw-diagram-generator/scripts/split-excalidraw-library.py skills/excalidraw-diagram-generator/libraries/[icon-set-name]/ This will split the library into individual icon files for efficient use. After setup is complete, I can create your diagram using the actual AWS/cloud icons. Alternatively, I can create the diagram now using simple shapes (rectangles, ellipses) which you can later replace with icons manually in Excalidraw. ``` -------------------------------- ### Full JPA Repository Test Example Source: https://github.com/github/awesome-copilot/blob/main/skills/spring-boot-testing/references/testcontainers-jdbc.md A complete example of testing a JPA repository with Testcontainers and PostgreSQL. Includes setup, data persistence, and query execution. ```java @DataJpaTest @AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE) @Testcontainers class OrderRepositoryTest { @Container @ServiceConnection static PostgreSQLContainer postgres = new PostgreSQLContainer<>("postgres:18"); @Autowired private OrderRepository orderRepository; @Autowired private TestEntityManager entityManager; @Test void shouldFindOrdersByStatus() { // Given entityManager.persist(new Order("PENDING")); entityManager.persist(new Order("COMPLETED")); entityManager.flush(); // When List pending = orderRepository.findByStatus("PENDING"); // Then assertThat(pending).hasSize(1); assertThat(pending.get(0).getStatus()).isEqualTo("PENDING"); } @Test void shouldSupportPostgresSpecificFeatures() { // Can use Postgres-specific features like: // - JSONB columns // - Array types // - Full-text search } } ``` -------------------------------- ### Java Setup Steps for GitHub Actions Source: https://github.com/github/awesome-copilot/blob/main/skills/github-copilot-starter/SKILL.md Includes JDK setup, building with Maven, and running tests with Maven for Java projects. ```yaml - name: Set up JDK uses: actions/setup-java@v4 with: java-version: "17" distribution: "temurin" - name: Build with Maven run: mvn compile - name: Run tests run: mvn test ``` -------------------------------- ### Initialize Custom Instructions with /init Source: https://github.com/github/awesome-copilot/blob/main/skills/copilot-cli-quickstart/SKILL.md Run the '/init' command to set up custom instruction files for your project. These files allow you to define your coding style and preferences, which Copilot will automatically follow. ```bash /init ``` -------------------------------- ### Example .NET SDK Task Display Name Source: https://github.com/github/awesome-copilot/blob/main/instructions/dotnet-upgrade.instructions.md An example of how a .NET SDK installation task might be displayed in Azure Pipelines logs. Replace `` with the actual version. ```yaml displayName: Use .NET Core sdk ``` -------------------------------- ### Execute Example Accessibility Report Source: https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/accessibility-report.md Run the provided Go example to generate an accessibility report for a given URL. This command initiates the CLI tool. ```bash go run recipe/accessibility-report.go ```