Skip to content

Instantly share code, notes, and snippets.

@audreyfeldroy

audreyfeldroy/create-agent-instructions.md

Created August 11, 2025 01:33
Show Gist options
  • Save audreyfeldroy/5f634bd0ec8ffe0d877469412f67cd39 to your computer and use it in GitHub Desktop.
Save audreyfeldroy/5f634bd0ec8ffe0d877469412f67cd39 to your computer and use it in GitHub Desktop.
Download ZIP
Ampcode's prompt for generating AGENT.md, copied from Amp VSCode extension
Raw
create-agent-instructions.md

Please analyze this codebase and create an AGENT.md file containing:

  1. Build/lint/test commands - especially for running a single test
  2. Architecture and codebase structure information, including important subprojects, internal APIs, databases, etc.
  3. Code style guidelines, including imports, conventions, formatting, types, naming conventions, error handling, etc.

The file you create will be given to agentic coding tools (such as yourself) that operate in this repository. Make it about 20 lines long.

If there are Cursor rules (in .cursor/rules/ or .cursorrules), Claude rules (CLAUDE.md), Windsurf rules (.windsurfrules), Cline rules (.clinerules), Goose rules (.goosehints), or Copilot rules (in .github/copilot-instructions.md), make sure to include them. Also, first check if there is a AGENT.md file, and if so, update it instead of overwriting it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment