create-agentsmd
Generates standardized AGENTS.md files to help AI coding agents understand and work with your repository.
- Provides a template-driven approach for creating agent-focused documentation that complements README.md with technical setup, workflow, and testing instructions
- Covers essential sections including project overview, setup commands, development workflow, testing, code style, build/deployment, and PR guidelines
- Supports monorepo structures with guidance for creating AGENTS.md files at multiple levels and navigation between packages
- Compatible with 20+ AI coding tools including Cursor, Aider, and Gemini CLI, following the open agents.md format standard
Create high‑quality AGENTS.md file
You are a code agent. Your task is to create a complete, accurate AGENTS.md at the root of this repository that follows the public guidance at https://agents.md/.
AGENTS.md is an open format designed to provide coding agents with the context and instructions they need to work effectively on a project.
What is AGENTS.md?
AGENTS.md is a Markdown file that serves as a "README for agents" - a dedicated, predictable place to provide context and instructions to help AI coding agents work on your project. It complements README.md by containing detailed technical context that coding agents need but might clutter a human-focused README.
Key Principles
- Agent-focused: Contains detailed technical instructions for automated tools
- Complements README.md: Doesn't replace human documentation but adds agent-specific context
- Standardized location: Placed at repository root (or subproject roots for monorepos)
- Open format: Uses standard Markdown with flexible structure
- Ecosystem compatibility: Works across 20+ different AI coding tools and agents
File Structure and Content Guidelines
More from github/awesome-copilot
git-commit
Execute git commit with conventional commit message analysis, intelligent staging, and message generation. Use when user asks to commit changes, create a git commit, or mentions "/commit". Supports: (1) Auto-detecting type and scope from changes, (2) Generating conventional commit messages from diff, (3) Interactive commit with optional type/scope/description overrides, (4) Intelligent file staging for logical grouping
30.2Kgh-cli
GitHub CLI (gh) comprehensive reference for repositories, issues, pull requests, Actions, projects, releases, gists, codespaces, organizations, extensions, and all GitHub operations from the command line.
21.2Kprd
Generate high-quality Product Requirements Documents (PRDs) for software systems and AI-powered features. Includes executive summaries, user stories, technical specifications, and risk analysis.
17.4Kdocumentation-writer
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
17.4Kexcalidraw-diagram-generator
Generate Excalidraw diagrams from natural language descriptions. Use when asked to "create a diagram", "make a flowchart", "visualize a process", "draw a system architecture", "create a mind map", or "generate an Excalidraw file". Supports flowcharts, relationship diagrams, mind maps, and system architecture diagrams. Outputs .excalidraw JSON files that can be opened directly in Excalidraw.
16.4Krefactor
Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.
16.1K