gitmyhub

agents.md

★ 143 updated 4d ago

My global instructions for AI agents like OpenCode

agents.md is a publicly shared AGENTS.md configuration file that the author uses as a system-level guide for AI coding agents. AGENTS.md is a plain-text convention: you place the file at the root of a codebase or in a global config location, and AI coding tools read it at the start of each session, treating its contents as standing instructions for how the agent should behave throughout the work.

Without something like this, you would need to repeat your preferences in every prompt: how you want commits formatted, which checks to run before pushing, how verbose you want explanations, and when you want the agent to stop and ask rather than guess. An AGENTS.md file lets you write those rules once and have them apply automatically across every session.

This particular repository is an anonymized version of the file the author keeps on their own machine. It covers areas like what to verify before committing code, how to write commit messages and pull request bodies, what to skip or handle quietly, and when the agent should push back on a task rather than proceeding. AI coding tools like OpenCode, Claude Code, and Codex can all consume AGENTS.md files; the broader convention is documented at agents.md.

The repository is not a library or tool to install. It is a starting point you can copy, fork, and adjust to match your own working style. The README is sparse and does not go into detail about the specific rules; it points to the AGENTS.md file itself for the actual content. The project is released under the MIT license.