
Generate AI Agent Instructions
OfficialFreeCreate tailored instructions for AI coding agents easily.
Free · Opens the source repo
What Generate AI Agent Instructions does
The /acreadiness-generate-instructions skill is designed to facilitate the creation, regeneration, or refreshing of custom instructions for AI coding agents like Copilot and Claude. This skill is part of the AgentRC framework's Measure → Generate → Maintain loop, with a focus on enhancing the AI Tooling pillar. By running this skill, users can generate essential instruction files that guide how AI agents interact with their codebase, ensuring that the agents are aligned with the project's specific needs and conventions.
The skill produces a primary instruction file, .github/copilot-instructions.md, which is the default format recommended for use with VS Code Copilot. Additionally, it offers the flexibility to create scoped instruction files for different areas or languages within a monorepo setup. This is particularly useful for larger projects where different parts of the codebase may require distinct instructions to optimize the AI's performance. Users can choose between flat or nested output strategies, allowing for a simple single-file approach or a more organized structure with multiple topic-specific files.
For monorepos, the skill can generate area-specific instruction files that contain applyTo globs, ensuring that the right instructions are applied only when relevant. This targeted approach helps maintain clarity and relevance, reducing noise in the AI's interactions with the code. The skill reads the actual codebase to determine the languages and frameworks in use, producing output that accurately reflects the project's structure and conventions.
This skill is particularly beneficial for developers and teams looking to enhance their productivity by ensuring that AI coding agents are effectively guided by tailored instructions. It streamlines the process of maintaining AI tooling, making it easier to keep instructions up to date as the codebase evolves.
When to use it
Use this skill when you need to generate or update instructions for AI coding agents in your project, especially in monorepo setups.
When not to use it
Avoid using this skill in CI environments or when a simple, static instruction file suffices without the need for ongoing updates.
What you can build with it
Updating AI Instructions
Run this skill to refresh your AI agent instructions after significant changes in your codebase.
Generating Instructions for Monorepos
Use this skill to create area-specific instructions for different parts of a monorepo, ensuring tailored guidance.
Switching AI Tools
If you're transitioning between AI coding agents, this skill helps regenerate the necessary instruction files accordingly.
How to install Generate AI Agent Instructions
View source1. Install with the skills CLI
npx skills add github/awesome-copilot/acreadiness-generate-instructions --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by github/acreadiness-generate-instructions — write AI agent instructions
Use this skill whenever the user wants to create, regenerate, or refresh their custom instructions for AI coding agents (Copilot, Claude, etc.). This is the Generate step in AgentRC's Measure → Generate → Maintain loop and the single highest-leverage action for the AI Tooling pillar.
Output options
VS Code recognises several instruction file types — AgentRC generates the most common ones:
| File | Scope | When to use |
|---|---|---|
.github/copilot-instructions.md | Always-on, whole workspace | Default — VS Code Copilot's native instruction file |
AGENTS.md | Always-on, whole workspace | Multi-agent repos (Copilot + Claude + others) |
.github/instructions/*.instructions.md | Scoped by applyTo glob | Per-area / per-language rules in monorepos |
CLAUDE.md | Claude-specific | Add via --claude-md (nested only) |
Strategies
flat(default) — single.github/copilot-instructions.mdat the chosen path. Simple, easy to review.nested— hub at.github/copilot-instructions.md+ per-topic detail files at.github/instructions/<topic>.instructions.md, each with anapplyToglob so VS Code only loads the topic when it's relevant. Better for large or multi-stack repos.
Why
.github/instructions/and not.agents/? AgentRC's default nested layout writes to.agents/, which is the right home for agent-agnostic repos (Copilot + Claude + Cursor readingAGENTS.md). For VS Code Copilot specifically, the native location is.github/instructions/withapplyTofrontmatter — that's what Copilot auto-discovers. This skill rewrites AgentRC's nested output to the VS Code-native location whenever the main output is.github/copilot-instructions.md. If you instead chose--output AGENTS.md, nested keeps AgentRC's default.agents/layout.
For monorepos, generate area-scoped instructions with --areas, --area <name>, or --areas-only. Areas are defined in agentrc.config.json. Per-area output is written as VS Code .instructions.md files with an applyTo glob (see below).
Topic vs area .instructions.md files
Both end up in .github/instructions/ but they answer different questions:
| Kind | Filename example | applyTo example | Where it comes from |
|---|---|---|---|
| Topic (nested) | testing.instructions.md | **/*.{test,spec}.{ts,tsx,js} | AgentRC --strategy nested topic split |
| Area (monorepo) | frontend.instructions.md | apps/frontend/** | agentrc.config.json areas + --areas |
You can have both at once: a nested set of topic files plus per-area files for a monorepo.
Per-area files with applyTo
When the user opts into areas, emit one VS Code-native .instructions.md file per area at .github/instructions/<area>.instructions.md. Each file MUST start with frontmatter declaring the glob the rules apply to:
---
applyTo: "apps/frontend/**"
---
# Frontend area instructions
…AgentRC-generated content for this area…
Workflow:
- Read
agentrc.config.jsonto discover declared areas and theirpaths/ globs. Ifpathsis missing, ask the user for the glob (e.g.src/api/**). - Run
agentrc instructions --areas(or--area <name>) to produce the per-area body content. - Wrap each area's content in
.github/instructions/<area>.instructions.mdwith theapplyTofrontmatter taken from the area'spaths. If the user passed--apply-to <glob>on a single-area call, use that glob verbatim. - Leave the main file alone — the root
.github/copilot-instructions.mdstays as the always-on instructions;.instructions.mdfiles only kick in for matching paths.
Naming: lowercase, kebab-case area name. Examples: .github/instructions/frontend.instructions.md, .github/instructions/api.instructions.md, .github/instructions/infra.instructions.md.
Steps
- Pick the target file. Default to
.github/copilot-instructions.md. Switch toAGENTS.mdonly if the user mentions multi-agent / Claude / Cursor support. - Always ask which strategy to use —
flatornested— unless the user already specified one in their message or via--strategy. Present the trade-off briefly:- Flat (default) — one
.github/copilot-instructions.md. Simple, easy to review in a single PR. Best for small/medium repos with one stack. - Nested — hub
.github/copilot-instructions.md+ per-topic.github/instructions/<topic>.instructions.mdfiles (each with anapplyToglob so VS Code only loads them when relevant). Best for large or multi-stack repos. Add--claude-mdto also emitCLAUDE.md. Recommendnestedproactively when the repo has > 5 top-level directories, multiple stacks, or already uses a monorepo tool (turbo/nx/pnpm workspaces).
- Flat (default) — one
- Detect monorepo areas by reading
agentrc.config.json. If areas exist, ask the user whether they want per-area.instructions.mdfiles withapplyToin addition to the root file. Default to "yes" whenagentrc.config.jsondeclares areas. - Run dry-run first so the user can preview:
npx -y github:microsoft/agentrc instructions --output <file> --strategy <flat|nested> [--areas|--area <name>] [--claude-md] --dry-run - Show a short summary of what would change — files that would be created or overwritten, area count + their
applyToglobs, model used (defaultclaude-sonnet-4.6). - On confirmation, run the same command without
--dry-run(and optionally--forceif files already exist). - Post-process layout for Copilot output:
- If
--outputends incopilot-instructions.mdand strategy isnested: move/rewrite AgentRC's.agents/<topic>.mdfiles to.github/instructions/<topic>.instructions.md. Add frontmatter to each file with an appropriateapplyToglob (see "Topic applyTo defaults" below). Delete the now-empty.agents/directory. - If
--areaswas used: also write.github/instructions/<area>.instructions.mdfor every area, using each area'spathsfromagentrc.config.jsonas theapplyToglob (override with--apply-tofor single-area calls). - If
--output AGENTS.mdwas chosen: keep AgentRC's native.agents/layout for nested — agent-agnostic readers expect it there. Create the.github/instructions/directory if missing.
- If
Topic applyTo defaults
When promoting AgentRC's nested topic files to .instructions.md, use these defaults unless the user specifies otherwise:
| Topic | Default applyTo |
|---|---|
testing | **/*.{test,spec}.{ts,tsx,js,jsx,mjs,cjs} |
style / code-quality / formatting | **/*.{ts,tsx,js,jsx,mjs,cjs,py,go,rs,java,kt,cs} |
build / ci | **/{package.json,turbo.json,nx.json,.github/workflows/**} |
docs | **/*.md |
security | ** |
| anything else / hub-level | ** |
- Verify by reading the generated file(s) back and showing the user a 1-paragraph synopsis: stack detected, conventions captured, length, list of
.instructions.mdfiles with their globs. - Suggest next steps:
- Re-run the
assessskill to confirm the AI Tooling pillar score improved. - If the user already has both
copilot-instructions.mdandAGENTS.md, recommend consolidating to a single source of truth (AgentRC flags this at maturity Level 2+).
- Re-run the
Notes
- AgentRC reads your actual code — no templates. Output reflects detected languages, frameworks, and conventions.
--claude-md(nested strategy only) also emitsCLAUDE.md.- VS Code applies
.instructions.mdfiles automatically when the active file matchesapplyTo. The root.github/copilot-instructions.mdalways loads. - Never run this skill non-interactively in CI; instructions are part of the repo and should land via PR.
Frequently asked questions about Generate AI Agent Instructions
Similar skills
Rhino 3D Scripting
Streamline your Rhinoceros 3D scripting tasks.
MVVM Toolkit
Streamline ViewModel development with source generators.
FreeCAD Scripts
Generate Python scripts for FreeCAD automation and modeling.
Azure Architecture Builder
Design and deploy Azure infrastructure using natural language.
Command Development
Streamline your command creation for Claude Code.
Create Cowork Plugin
Easily build and package plugins through guided sessions.
