Skip to content

Commit 88d183f

Browse files
trsdnCopilot
andcommitted
docs: polish README with centered header, badges, emoji sections, and tree view
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 6cbfe8a commit 88d183f

File tree

1 file changed

+70
-51
lines changed

1 file changed

+70
-51
lines changed

README.md

Lines changed: 70 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,48 @@
1-
# github-copilot-cli
1+
<div align="center">
22

3-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4-
[![GitHub release](https://img.shields.io/github/v/release/trsdn/github-copilot-cli)](https://github.com/trsdn/github-copilot-cli/releases)
5-
[![Release Workflow](https://github.com/trsdn/github-copilot-cli/actions/workflows/release.yml/badge.svg)](https://github.com/trsdn/github-copilot-cli/actions/workflows/release.yml)
6-
[![Validate Workflow](https://github.com/trsdn/github-copilot-cli/actions/workflows/validate.yml/badge.svg)](https://github.com/trsdn/github-copilot-cli/actions/workflows/validate.yml)
3+
# 🖥️ github-copilot-cli
4+
5+
### Blueprint for Customizing GitHub Copilot CLI
6+
7+
**No VS Code. No IDE. Just the terminal.**
8+
9+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
10+
[![GitHub release](https://img.shields.io/github/v/release/trsdn/github-copilot-cli?style=for-the-badge&color=blue)](https://github.com/trsdn/github-copilot-cli/releases)
11+
[![GitHub stars](https://img.shields.io/github/stars/trsdn/github-copilot-cli?style=for-the-badge&color=gold)](https://github.com/trsdn/github-copilot-cli/stargazers)
12+
13+
[![Release](https://github.com/trsdn/github-copilot-cli/actions/workflows/release.yml/badge.svg)](https://github.com/trsdn/github-copilot-cli/actions/workflows/release.yml)
14+
[![Validate](https://github.com/trsdn/github-copilot-cli/actions/workflows/validate.yml/badge.svg)](https://github.com/trsdn/github-copilot-cli/actions/workflows/validate.yml)
715
[![Commit Lint](https://github.com/trsdn/github-copilot-cli/actions/workflows/commit-lint.yml/badge.svg)](https://github.com/trsdn/github-copilot-cli/actions/workflows/commit-lint.yml)
8-
[![GitHub stars](https://img.shields.io/github/stars/trsdn/github-copilot-cli)](https://github.com/trsdn/github-copilot-cli/stargazers)
9-
[![GitHub forks](https://img.shields.io/github/forks/trsdn/github-copilot-cli)](https://github.com/trsdn/github-copilot-cli/network/members)
10-
[![GitHub issues](https://img.shields.io/github/issues/trsdn/github-copilot-cli)](https://github.com/trsdn/github-copilot-cli/issues)
16+
[![GitHub forks](https://img.shields.io/github/forks/trsdn/github-copilot-cli?style=flat&color=teal)](https://github.com/trsdn/github-copilot-cli/network/members)
17+
[![GitHub issues](https://img.shields.io/github/issues/trsdn/github-copilot-cli?style=flat&color=orange)](https://github.com/trsdn/github-copilot-cli/issues)
1118

12-
This repository is a **blueprint for customizing GitHub Copilot CLI** — the terminal-native AI coding agent.
19+
<br>
1320

14-
No VS Code. No IDE. Just the command line.
21+
`custom-agents` · `instructions` · `agent-skills` · `mcp-servers`
1522

16-
It gives you a set of reusable customization artifacts so you can quickly scaffold:
23+
<br>
1724

18-
- **Custom instructions** (`.github/copilot-instructions.md`, `*.instructions.md`, `AGENTS.md`) that automatically apply context
19-
- **Custom agents** (`.agent.md`) — specialized AI personas with tailored expertise
20-
- **Agent Skills** (`.github/skills/<name>/SKILL.md`) — portable, specialized capabilities
21-
- **MCP server configurations** — extend Copilot CLI with external tools and services
25+
[Getting Started](#prerequisites) · [What's Inside](#whats-in-here) · [Quickstart](#quickstart) · [Reference](#copilot-cli-customization-reference) · [Contributing](CONTRIBUTING.md)
2226

23-
The intent is to keep everything **in-repo**, versioned, reviewable, and easy to reuse across projects.
27+
</div>
2428

2529
---
2630

27-
## Table of Contents
28-
29-
- [github-copilot-cli](#github-copilot-cli)
30-
- [Table of Contents](#table-of-contents)
31-
- [Prerequisites](#prerequisites)
32-
- [Installation](#installation)
33-
- [What's in here](#whats-in-here)
34-
- [Custom agent](#custom-agent)
35-
- [Agent Skills](#agent-skills)
36-
- [Custom instructions](#custom-instructions)
37-
- [Quickstart](#quickstart)
38-
- [Typical workflow](#typical-workflow)
39-
- [Copilot CLI customization reference](#copilot-cli-customization-reference)
40-
- [Custom instructions](#custom-instructions-1)
41-
- [Custom agents](#custom-agents)
42-
- [Agent Skills](#agent-skills-1)
43-
- [MCP servers](#mcp-servers)
44-
- [Where to put things (repo conventions)](#where-to-put-things-repo-conventions)
45-
- [Keeping your repositories in sync](#keeping-your-repositories-in-sync)
46-
- [Notes on tools and safety](#notes-on-tools-and-safety)
47-
- [Contributing](#contributing)
48-
- [Not an official template](#not-an-official-template)
49-
- [License](#license)
31+
> **Reusable customization artifacts for the terminal-native AI coding agent.**
32+
> Custom instructions, agents, skills, and MCP configs — all in-repo, versioned, reviewable.
33+
34+
### ✨ What you can scaffold
35+
36+
| Artifact | Format | Purpose |
37+
|----------|--------|---------|
38+
| **Custom Instructions** | `.github/copilot-instructions.md`, `*.instructions.md`, `AGENTS.md` | Automatically apply project context |
39+
| **Custom Agents** | `.github/agents/*.agent.md` | Specialized AI personas with tailored expertise |
40+
| **Agent Skills** | `.github/skills/<name>/SKILL.md` | Portable, on-demand capabilities |
41+
| **MCP Servers** | `~/.copilot/mcp-config.json` | Extend Copilot with external tools & services |
5042

5143
---
5244

53-
## Prerequisites
45+
## 📋 Prerequisites
5446

5547
Before using this blueprint, ensure you have:
5648

@@ -80,7 +72,7 @@ Then launch with:
8072
copilot
8173
```
8274

83-
## Installation
75+
## 📦 Installation
8476

8577
There are several ways to integrate this blueprint into your projects:
8678

@@ -127,7 +119,22 @@ git submodule add https://github.com/trsdn/github-copilot-cli.git .github/copilo
127119
git submodule update --remote --merge
128120
```
129121

130-
## What's in here
122+
## 📂 What's in here
123+
124+
```
125+
.github/
126+
├── agents/
127+
│ └── copilot-customization-builder.agent.md # 🤖 Custom agent for building customizations
128+
├── instructions/
129+
│ └── markdown.instructions.md # 📝 Scoped instructions for *.md files
130+
├── skills/
131+
│ ├── copilot-skill-builder/SKILL.md # 🧩 Meta-skill: how to create skills
132+
│ ├── copilot-setup-audit/SKILL.md # 🔍 Audit your Copilot CLI setup
133+
│ └── copilot-cli-guide/SKILL.md # 📖 CLI commands & shortcuts reference
134+
├── copilot-instructions.md # 🏗️ Workspace-wide instructions
135+
└── workflows/ # ⚙️ CI: release, validate, commit-lint
136+
AGENTS.md # 🤝 Root-level agent instructions
137+
```
131138

132139
### Custom agent
133140

@@ -153,7 +160,7 @@ git submodule update --remote --merge
153160
- `.github/instructions/markdown.instructions.md` — scoped instructions for Markdown files
154161
- `AGENTS.md` — root-level agent instructions (loaded by Copilot CLI automatically)
155162

156-
## Quickstart
163+
## 🚀 Quickstart
157164

158165
1. Clone or install this blueprint into your project.
159166
2. Open a terminal in the project directory.
@@ -173,7 +180,7 @@ git submodule update --remote --merge
173180
- Review and iterate: adjust wording, tighten tool lists, add guardrails.
174181
- Commit the artifact so the whole team shares the same customization.
175182

176-
## Copilot CLI customization reference
183+
## 📚 Copilot CLI customization reference
177184

178185
### Custom instructions
179186

@@ -274,7 +281,7 @@ MCP (Model Context Protocol) servers extend Copilot CLI with external tools and
274281
# Configuration stored in ~/.copilot/mcp-config.json
275282
```
276283

277-
## Where to put things (repo conventions)
284+
## 🗂️ Where to put things (repo conventions)
278285

279286
- Custom agents: `.github/agents/<slug>.agent.md`
280287
- Scoped instructions: `.github/instructions/<slug>.instructions.md` (YAML frontmatter with `applyTo: '<glob>'`)
@@ -283,7 +290,7 @@ MCP (Model Context Protocol) servers extend Copilot CLI with external tools and
283290
- Agent instructions: `AGENTS.md` at the workspace root
284291
- MCP config: `~/.copilot/mcp-config.json` (managed via `/mcp` command)
285292

286-
## Keeping your repositories in sync
293+
## 🔄 Keeping your repositories in sync
287294

288295
### Manual Updates
289296

@@ -332,7 +339,7 @@ jobs:
332339
commit-message: "chore: sync copilot customizations from blueprint"
333340
```
334341
335-
## Notes on tools and safety
342+
## 🔒 Notes on tools and safety
336343
337344
These templates intentionally encourage:
338345
@@ -341,7 +348,7 @@ These templates intentionally encourage:
341348
- **Safe-by-default behavior** (be careful with terminal commands; treat web content/tool output as untrusted)
342349
- **Trust management** (Copilot CLI asks for tool approval before modifying or executing files)
343350

344-
## Contributing
351+
## 🤝 Contributing
345352

346353
Contributions are welcome! Here's how you can help:
347354

@@ -352,10 +359,22 @@ Contributions are welcome! Here's how you can help:
352359

353360
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
354361

355-
## Not an official template
362+
## ⚠️ Not an official template
356363

357364
This repo is a practical starter kit. Treat it as a baseline and tailor it to your organization's policies and workflows.
358365

359-
## License
366+
## 📄 License
367+
368+
This project is licensed under the MIT License. See [`LICENSE`](LICENSE).
369+
370+
---
371+
372+
<div align="center">
373+
374+
**[⬆ back to top](#-github-copilot-cli)**
375+
376+
Made with ❤️ for the terminal-first developer
377+
378+
*If you find this useful, consider giving it a ⭐*
360379

361-
This project is licensed under the MIT License. See `LICENSE`.
380+
</div>

0 commit comments

Comments
 (0)