Agent setup

The init command generates a muselet.md file in your repo root. This file is designed to be read by AI coding agents (Claude, Copilot, Codex, etc.) and tells them:

  • The commit message format and required sections
  • Which sections apply to which commit types
  • Examples of well-structured commit messages
  • How to handle the lint error when they forget

How agents discover it

Most agents will read muselet.md automatically if it's in the project root or referenced in your agent config.

For agents that use a specific instructions file (like AGENTS.md, .cursorrules, or CLAUDE.md), you can reference it:

Read muselet.md for commit message conventions.

What it contains

The generated file includes the full section reference, required sections per commit type, and example commit messages. It's designed to be self-contained — agents don't need to look anything else up.