acreadiness-generate-instructions

Generate VS Code Copilot instruction files from repository code using AgentRC.

38.5k|4.9k|Updated Jun 11, 2025
One-click install
npx skills add https://github.com/github/awesome-copilot --skill acreadiness-generate-instructions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: acreadiness-generate-instructions
Source: https://github.com/github/awesome-copilot/tree/main/skills/acreadiness-generate-instructions
Command: npx skills add https://github.com/github/awesome-copilot --skill acreadiness-generate-instructions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Repositories often lack tailored AI agent instructions, causing Copilot and other coding agents to produce generic or inconsistent output. This Skill generates instruction files grounded in the repository's actual code, conventions, and structure.

Core Features & Use Cases

  • Instruction file generation: Produces .github/copilot-instructions.md by default, with options for AGENTS.md, CLAUDE.md, and scoped .instructions.md files.
  • Flat and nested strategies: Creates a single always-on file or a hub plus per-topic .github/instructions/<topic>.instructions.md files with applyTo globs.
  • Monorepo area support: Reads agentrc.config.json to emit per-area instruction files with path-scoped applyTo frontmatter.
  • Use Case: A team with a pnpm monorepo runs this Skill to generate a root Copilot instructions file plus per-area files for apps/frontend/** and apps/api/**, so Copilot loads only relevant rules per file.

Quick Start

Ask the agent to generate Copilot instructions for this repository using the nested strategy with a dry-run preview first.

Frequently Asked Questions about acreadiness-generate-instructions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a copilot-instructions.md file for my repository?

Run the AgentRC instructions command with the output set to .github/copilot-instructions.md, starting with a dry-run to preview changes. The tool analyzes your actual code to capture detected languages, frameworks, and conventions rather than using templates.

What is the difference between flat and nested instruction strategies?

Flat produces a single .github/copilot-instructions.md file that is simple to review in one PR. Nested creates a hub file plus per-topic .github/instructions/<topic>.instructions.md files with applyTo globs, which suits large or multi-stack repositories.

How do applyTo globs work in VS Code instructions files?

Each .instructions.md file starts with frontmatter declaring an applyTo glob such as apps/frontend/**. VS Code automatically loads that file only when the active file matches the glob, while the root copilot-instructions.md always loads.

Should I use copilot-instructions.md or AGENTS.md?

Default to .github/copilot-instructions.md for VS Code Copilot, since it is the native auto-discovered location. Choose AGENTS.md only when the repository serves multiple agents such as Copilot, Claude, and Cursor together.

Can I generate per-area instructions for a monorepo?

Yes, if agentrc.config.json declares areas with paths, the Skill emits one .github/instructions/<area>.instructions.md file per area using those paths as the applyTo glob. You can also pass --area or --apply-to for single-area generation.

When should I not run instruction generation automatically?

Never run it non-interactively in CI, because instruction files are part of the repository and should land via a reviewed pull request. Always preview with --dry-run and confirm before writing files.