AGENTS.md

Provide always-on instructions to the agent through global and project-level AGENTS.md files.

AGENTS.md

AGENTS.md is a plain markdown file that provides always-on instructions to the agent. Its content is injected directly into the system prompt of every session — no tool call needed, no loading step.

How It Works

Jean2 reads from two locations:

  • ~/.jean2/AGENTS.md — global instructions that apply to every workspace and every session
  • {workspace}/AGENTS.md — project-level instructions that apply only to that workspace

Both are loaded in order (global first, then project) and appended to the system prompt after the preconfig system prompt. The content is wrapped in XML tags:

<instructions source="global">
...global AGENTS.md content...
</instructions>

<instructions source="project">
...project AGENTS.md content...
</instructions>

The file is plain markdown — no frontmatter, no special format. Just write the instructions you want the agent to follow in every conversation.

What to Put Where

Global (~/.jean2/AGENTS.md) — personal preferences that apply everywhere:

  • Coding style preferences (tabs vs spaces, naming conventions)
  • Response language and format
  • Output formatting rules
  • Personal workflow preferences

Project ({workspace}/AGENTS.md) — conventions specific to a codebase:

  • Architecture overview and key patterns
  • Build and test commands
  • Project-specific naming conventions
  • Team workflows and contribution guidelines
  • Framework or library constraints

Both files are optional. If neither exists, no additional instructions are injected.