|
1 | | -# win-dev-skills — Copilot CLI agents and skills for Windows app development |
| 1 | +# Agents and skills for Windows app development |
2 | 2 |
|
3 | | -A [Copilot CLI](https://github.com/github/gh-copilot) plugin for building native Windows apps with **WinUI 3** and the **Windows App SDK**. Ships **one agent**, **seven skills**, and a small set of **supporting tools** that together cover the end-to-end inner loop: scaffold → design → build → run → test → package → ship. |
| 3 | +A [Copilot CLI](https://github.com/github/gh-copilot) plugin for building native Windows apps with **WinUI 3** and the **Windows App SDK** to cover the end-to-end inner loop: scaffold → design → build → run → test → package → ship. |
4 | 4 |
|
5 | 5 | > [!WARNING] |
6 | 6 | > **🚧 Preview · v0.x — expect breaking changes.** Skill names, on-disk layout, agent configuration, analyzer rule IDs, and CLI tool surfaces are all subject to change without notice. There is no SemVer commitment until v1.0. Pin to a specific commit if you need stability today. Outputs are suggestions, not authoritative answers — review them before committing or shipping anything they produce. |
7 | 7 |
|
| 8 | +## Install |
| 9 | + |
| 10 | +### Prerequisites |
| 11 | + |
| 12 | +| Tool | Minimum | Recommended | Install | |
| 13 | +|---|---|---|---| |
| 14 | +| .NET SDK | 8.0 | 10.0 | `winget install Microsoft.DotNet.SDK.10` | |
| 15 | +| WinApp CLI | 0.3 | latest | `winget install Microsoft.WinAppCLI` | |
| 16 | +| WinUI 3 templates | — | latest | `dotnet new install Microsoft.WindowsAppSDK.WinUI.CSharp.Templates` | |
| 17 | +| Copilot CLI | latest | latest | `winget install GitHub.Copilot` | |
| 18 | +| Visual Studio (WinUI workload) | — | 2022 17.10+ | recommended for the XAML-diagnostics workaround | |
| 19 | + |
| 20 | +Developer Mode must be enabled in Windows (Settings → System → Advanced → Developer Mode). |
| 21 | + |
| 22 | +### Install the plugin |
| 23 | + |
| 24 | +```powershell |
| 25 | +# Add the win-dev-skills marketplace, then install the winui plugin from it. |
| 26 | +copilot plugin marketplace add microsoft/win-dev-skills |
| 27 | +copilot plugin install winui@win-dev-skills |
| 28 | +``` |
| 29 | + |
| 30 | +> The marketplace registration is a one-time step. After that, `copilot plugin install winui@win-dev-skills` is all anyone needs to add or upgrade the plugin. |
| 31 | +
|
| 32 | +### Quick start |
| 33 | + |
| 34 | +```sh |
| 35 | +copilot --agent winui:winui-dev -p "Build me a WinUI 3 markdown editor with live preview and a custom title bar" |
| 36 | +``` |
| 37 | + |
8 | 38 | > [!IMPORTANT] |
9 | 39 | > **For best results, install Visual Studio with the WinUI workload.** There is a known XAML-compiler issue under `dotnet build` where a malformed XAML file produces no useful diagnostic — the build just fails with no indication of what's wrong in which `.xaml`. Agents that hit this thrash through unrelated guesses. The `winui-dev-workflow` skill works around it via a small [`BuildAndRun.ps1`](plugins/winui/skills/winui-dev-workflow/BuildAndRun.ps1) helper that prefers MSBuild when it's available on the machine and falls back to `dotnet build` otherwise. **This workaround is explicitly temporary** and goes away when the next Windows App SDK release fixes the underlying compiler. |
10 | 40 |
|
@@ -47,38 +77,6 @@ Each skill is a focused, self-contained playbook. The agent loads `winui-design` |
47 | 77 | | **`winui-wpf-migration`** | WPF → WinUI 3 migration — namespace replacement, control mapping (`DataGrid` → `ListView`, `WrapPanel` → `ItemsRepeater`, `TabControl` → `TabView`), `Dispatcher` → `DispatcherQueue`, `System.Drawing` → `BitmapImage`, MVVM conversion to CommunityToolkit.Mvvm, `DynamicResource` → `ThemeResource`. | |
48 | 78 | | **`winui-session-report`** | Diagnostic report on the current or a recent Copilot session. Use when filing a bug, debugging agent behaviour, or reviewing what happened during a build session. | |
49 | 79 |
|
50 | | -## Install |
51 | | - |
52 | | -### Prerequisites |
53 | | - |
54 | | -| Tool | Minimum | Recommended | Install | |
55 | | -|---|---|---|---| |
56 | | -| .NET SDK | 8.0 | 10.0 | `winget install Microsoft.DotNet.SDK.10` | |
57 | | -| WinApp CLI | 0.3 | latest | `winget install Microsoft.WinAppCLI` | |
58 | | -| WinUI 3 templates | — | latest | `dotnet new install Microsoft.WindowsAppSDK.WinUI.CSharp.Templates` | |
59 | | -| Copilot CLI | latest | latest | `winget install GitHub.Copilot` | |
60 | | -| Visual Studio (WinUI workload) | — | 2022 17.10+ | recommended for the XAML-diagnostics workaround | |
61 | | - |
62 | | -Developer Mode must be enabled in Windows (Settings → System → Advanced → Developer Mode). |
63 | | - |
64 | | -### Install the plugin |
65 | | - |
66 | | -```powershell |
67 | | -# Add the win-dev-skills marketplace, then install the winui plugin from it. |
68 | | -copilot plugin marketplace add microsoft/win-dev-skills |
69 | | -copilot plugin install winui@win-dev-skills |
70 | | -``` |
71 | | - |
72 | | -> The marketplace registration is a one-time step. After that, `copilot plugin install winui@win-dev-skills` is all anyone needs to add or upgrade the plugin. |
73 | | -
|
74 | | -### Quick start |
75 | | - |
76 | | -```sh |
77 | | -copilot --agent winui:winui-dev -p "Build me a WinUI 3 markdown editor with live preview and a custom title bar" |
78 | | -``` |
79 | | - |
80 | | -Then ask Copilot CLI for the WinUI 3 app you've been meaning to build, and tell us how it goes. |
81 | | - |
82 | 80 | ## The tools we lean on |
83 | 81 |
|
84 | 82 | Skills are *prompts plus playbooks*. They get their actual leverage from a small set of tools — some external, some included in this repo. |
|
0 commit comments