74 lines
2.5 KiB
Markdown
74 lines
2.5 KiB
Markdown
# Copilot Resources
|
|
|
|
Copilot Resources is a shared, Git-backed home for prompts, skills, agents,
|
|
instructions, hooks, scripts, and templates that should follow you across
|
|
machines and across VS Code and Copilot CLI sessions.
|
|
|
|
## Goals
|
|
|
|
- Keep one canonical source of truth for shared Copilot assets.
|
|
- Make new resources easy to create, publish, and propagate.
|
|
- Minimize per-machine setup after the first bootstrap.
|
|
- Support macOS, Linux, and Windows.
|
|
|
|
## Current Foundation
|
|
|
|
This initial implementation provides:
|
|
|
|
- A stable install model based on `~/.copilot-resources`
|
|
- Bootstrap scripts for macOS/Linux and Windows
|
|
- Publish, update, and verify scripts
|
|
- Scripted VS Code settings merge for managed Copilot-related keys
|
|
- Scripted Copilot CLI environment wiring through a managed sourced fragment
|
|
- Scripted managed MCP config generation for VS Code and Copilot CLI
|
|
|
|
## Operating Model
|
|
|
|
There are two supported ways to add shared assets:
|
|
|
|
- Repo-first: create the resource directly in this repository.
|
|
- Local-first: create the resource in a normal workspace or user profile, then
|
|
publish it into this repository with the publish script.
|
|
|
|
Once a resource lands in this repository, the repository becomes authoritative.
|
|
Git push and pull plus scheduled sync spread the change to other systems.
|
|
|
|
## Bootstrap
|
|
|
|
Run one of these from the repository root:
|
|
|
|
```bash
|
|
install/bootstrap.sh
|
|
```
|
|
|
|
```powershell
|
|
install/bootstrap.ps1
|
|
```
|
|
|
|
The bootstrap scripts create a stable canonical path and connect default
|
|
discovery locations back to this repository. For most surfaces, that means
|
|
symlinks or junctions into default VS Code and Copilot paths rather than
|
|
per-machine copies. They also merge the managed VS Code settings keys and add a
|
|
small managed shell or PowerShell profile block for Copilot CLI environment
|
|
variables without replacing the rest of the user config.
|
|
|
|
Bootstrap also generates managed user-level MCP configuration for VS Code and
|
|
Copilot CLI from the tracked templates in `config/mcp/`. Machine-local MCP
|
|
values live in `.local/mcp.local.jsonc`, which bootstrap creates from the
|
|
tracked example file on first run.
|
|
|
|
Today the managed MCP set is:
|
|
|
|
- Playwright for VS Code
|
|
- Filesystem for VS Code and Copilot CLI
|
|
- Gitea/Forgejo for VS Code and Copilot CLI when enabled locally
|
|
|
|
`install/update.*` now reruns bootstrap after pulling so those managed config
|
|
files propagate when this repository changes.
|
|
|
|
## Next Docs
|
|
|
|
The rest of the handbook will live in `docs/` and will cover architecture,
|
|
authoring, publishing, governance, versioning, review standards, and
|
|
troubleshooting.
|