whatisgithub

What is agents.md?

zeke/agents.md — explained in plain English

Analysis updated 2026-05-18

43Audience · developerComplexity · 1/5LicenseSetup · easy

In one sentence

A personal AGENTS.md file with one developer's standing instructions for how AI coding agents like Claude Code and Codex should behave.

Mindmap

mindmap
  root((repo))
    What it does
      Global agent rules
      Loads every session
      System level guide
    Contents
      Verification steps
      Commit conventions
      PR body format
      When to ask first
    Use cases
      Template for own rules
      Study agent prompting
      Standardize behavior
    Audience
      Developers
      AI agent users
      Prompt engineers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Copy this AGENTS.md as a starting template for your own AI agent instructions.

USE CASE 2

Study how an experienced developer structures standing rules for coding agents.

USE CASE 3

Adapt the commit and pull request conventions for your own team's workflow.

What is it built with?

Markdown

How does it compare?

zeke/agents.mdalibaba/omnidoc-tokenbencharccalc/dwmfix
Stars434343
LanguagePythonPython
Setup difficultyeasymoderateeasy
Complexity1/53/52/5
Audiencedeveloperresearchergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min
Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

So what is it?

This repository is a personal collection of global instructions that its author uses to guide AI coding agents such as OpenCode, Claude Code, and Codex. The core of the project is a single file called AGENTS.md, which is loaded automatically at the start of every coding session and acts as a system level guide telling the AI agent how to behave. The instructions cover things like what the agent should verify before finishing a task, what steps it can safely skip, how to write commit messages and pull request descriptions, and when the agent should stop and ask the human for input instead of guessing. The version published here is described as an anonymized copy of the file the author actually keeps on their own machine, with personal or identifying details removed. The README is short and does not go into detail about the specific rules themselves, those live inside the AGENTS.md file rather than the README. The project follows a broader convention called agents.md, which is a shared format some developers use for writing this kind of instruction file so that different AI coding tools can read it in a consistent way. The author explicitly invites others to copy, fork, or reuse any part of the file for their own setups. This is less a piece of software and more a reference document, useful mainly as an example of how one experienced user structures their standing instructions for AI agents. Anyone curious about prompt engineering for coding assistants, or looking for a starting template for their own AGENTS.md file, could read through it for ideas. It is released under the MIT license, so reuse is unrestricted.

Copy-paste prompts

Prompt 1
Read this AGENTS.md file and summarize the main rules it sets for an AI coding agent.
Prompt 2
Adapt this AGENTS.md template so it fits a Python backend project instead of a general one.
Prompt 3
Compare this AGENTS.md file to the agents.md convention and point out anything missing.
Prompt 4
Turn the commit message rules in this file into a short checklist I can reuse.

Frequently asked questions

What is agents.md?

A personal AGENTS.md file with one developer's standing instructions for how AI coding agents like Claude Code and Codex should behave.

What license does agents.md use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is agents.md to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is agents.md for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.