Copilot Installation

GitHub Copilot Installation

Install ai-coding-ok in a Copilot project via the install script and customize-prompt.

---

Prerequisites

• GitHub Copilot subscription (Individual / Business / Enterprise)
• Git installed
• Bash (macOS/Linux/Git Bash) or Python 3 (Windows)

---

Step 1: Clone ai-coding-ok

git clone https://github.com/Mark7766/ai-coding-ok ~/tools/ai-coding-ok

The path is arbitrary — ~/tools/ai-coding-ok is just a suggestion. Keep it somewhere you can reference later.

---

Step 2: Run the install script

cd your-project

# macOS / Linux / Git Bash
bash ~/tools/ai-coding-ok/install.sh --copilot

# Windows (PowerShell)
python $env:USERPROFILE\tools\ai-coding-ok\install.py --copilot

Expected output:

[ai-coding-ok] Installing Copilot templates -> /home/you/your-project
[ai-coding-ok] Templates installed.
[ai-coding-ok] Next: paste scripts/customize-prompt.md into Copilot Chat to fill in placeholders.

---

Step 3: Customize with Copilot Chat

1. Open VS Code / JetBrains with Copilot Chat
2. Open ~/tools/ai-coding-ok/scripts/customize-prompt.md
3. Copy the entire content
4. Paste into Copilot Chat
5. Replace the placeholder sentence with your own description:

我想做的东西（一句话）：

> [REPLACE THIS] A personal expense tracker that records what I spend each day

Copilot will:

• Infer your project name, tech stack, architecture
• Open each file with {{placeholders}} and replace them
• Report what decisions it made

What gets customized

File	Placeholders filled
AGENTS.md	Project name, type, tech stack, architecture
CLAUDE.md	Project name
.github/copilot-instructions.md	Project name, tech stack, conventions
.github/project-metadata.yml	All metadata fields
.github/agent/system-prompt.md	Project name, tech stack, constraints
.github/agent/coding-standards.md	Language, framework, conventions
.github/agent/workflows.md	Project name, module list
.github/agent/memory/project-memory.md	All project facts
.github/agent/memory/decisions-log.md	Initial ADR
.github/agent/memory/task-history.md	TASK-001 bootstrap

---

Step 4: Verify

bash ~/tools/ai-coding-ok/scripts/verify.sh .

Exit code	Meaning
0	Perfect — all files present, no placeholders
1	Missing files — re-run install
2	Unfilled placeholders — re-paste customize-prompt.md

See Installation Verification for details.

---

Step 5: Commit to your repo

git add AGENTS.md CLAUDE.md .github/
git commit -m "chore: install ai-coding-ok framework"

All team members using Copilot will now automatically share the same project memory.

---

How it works with Copilot

Copilot automatically reads .github/copilot-instructions.md at the start of every session. This file contains:

1. PDCA enforcement rules — Copilot must read memory files before coding and update them after
2. Coding standards — language-specific conventions
3. Output format requirements — including mandatory ## Memory Updates section

Because Copilot auto-loads this file, no manual trigger is needed — PDCA runs on every task.

v3.0.1+: The output format section now requires a mandatory ## Memory Updates section in every response. Copilot cannot skip the Act phase.

---

Upgrading later

To upgrade ai-coding-ok in a Copilot project:

1. Pull the latest framework: cd ~/tools/ai-coding-ok && git pull
2. Paste scripts/upgrade-prompt.md into Copilot Chat
3. Copilot will merge framework changes while preserving your project customizations

See Upgrade ai-coding-ok for details.

---

Common issues

"Copilot doesn't seem to read the memory files"

Make sure .github/copilot-instructions.md exists and starts with the PDCA enforcement block. If Copilot still skips it, manually remind it:

Follow the PDCA instructions in .github/copilot-instructions.md.
Read the memory files first, then proceed.

"I'm using Cursor instead"

Cursor has its own install path. See Cursor Installation.

"Can I use this with Copilot AND Claude Code?"

Yes. The same .github/ files work for both. Install ai-coding-ok once, and both tools pick up the memory system automatically.

---

Next steps

• Verify your installation
• Understand the PDCA workflow
• Daily workflow with Copilot