Skip to main content

AGENTS.md

Knowledge → Learn → AGENTS.md.

AGENTS.md generates and manages AGENTS.md-style guidance files: short briefings that give AI coding agents the context they need about a given part of your codebase. It uses the identical file-browser layout as Learning Paths and Diagrams: a folder tree mirroring your codebase's key directories on the left, one guidance file per directory, and the same full set of controls:

  • Regenerate re-runs generation for the whole set of files.
  • New file / New folder, plus per-item Rename and Delete via the menu, work exactly as described under Learning Paths, including the same New Document template picker (Blank, Architecture Decision Record, Runbook, Meeting Notes) if you want to add a file by hand rather than generate one.
  • Opening a file gives you the same Edit / View toggle (rich-text editor with autosave) and Fix with AI panel (instruction box → diff preview → Accept / Reject) as every other screen in this section.
  • If nothing is generated yet, you will see No AGENTS.md files yet with a Generate AGENTS.md button.

There is nothing AGENTS.md-specific about the editor itself; it is the same Markdown document experience used everywhere else in Learn. Only the folder structure and generated content are tailored to briefing AI agents.

Who can do this?

knowledge:read to browse and read; knowledge:manage (plus a mutable project) to edit, regenerate, use Fix with AI, or manage files.

On this page