Skip to content

Zircoz/agents.md-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

agents-md skill

A Claude Code skill that generates a tailored AGENTS.md file for your project.

AGENTS.md is the standard open format for giving AI coding agents context about your project — how to build it, test it, run it, and contribute to it. It's supported by Claude Code, OpenAI Codex, Cursor, Amp, Jules, Factory, and more.

Install

npx skills add Zircoz/agents.md-skill

Usage

In any Claude Code session, run:

/agents-md

The skill will:

  1. Analyze your project — detects language, package manager, framework, build/test/lint commands, code style config, monorepo structure, and contribution conventions
  2. Draft a tailored AGENTS.md — only includes sections relevant to your project, with real commands (not placeholders)
  3. Confirm with you before writing
  4. Write AGENTS.md to your repo root

What gets generated

Depending on what's detected, the output includes some or all of:

  • Setup — install command for the right package manager
  • Development — dev server and build commands
  • Testing — exact test commands, focus patterns, environment notes
  • Code Style — rules extracted from your actual config files
  • PR Instructions — commit format, branch conventions from CONTRIBUTING.md
  • Project Structure — for non-obvious layouts and monorepos
  • Monorepo Tips — workspace commands for Turborepo, Nx, etc.
  • Security — any security notes found in the repo

License

MIT

About

A Skill to generate AGENTS.md

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors