Project Instructions

An AGENTS.md file tells the agent how your project works: conventions, architecture decisions, and the commands to run. Freebuff and Codebuff both read it, and the agent follows it for the whole session.

In the CLI, run /init to create a starter AGENTS.md in your project root:

/init

You can also create the file yourself, or ask the agent to write one.

• AGENTS.md in the project root is read first.
• CLAUDE.md in the project root is used if there is no AGENTS.md.

Only one file is read per project. Names are case-insensitive. knowledge.md is no longer read, so rename an old file to AGENTS.md.

The file is read from the root of the project you opened. To cover a large repo, keep it short and link to the deeper docs. The agent opens those when it needs them.

Cloud reads AGENTS.md, then CLAUDE.md, from the root of the workspace, up to about 64 KB. To turn this off, go to Settings → General → Agent instructions.

Capture facts that aren't obvious from the code:

• Project goals and technical decisions
• Coding standards and common pitfalls
• Build, deployment and testing requirements
• Commands to run after a change, such as npm test

## Verifying Changes

After any code change, run:

- `npm run typecheck`
- `npm test`

The agent follows these instructions, but they don't enforce anything. A line like "never touch this folder" is a request and not a permission boundary. Use version control and review to protect what matters.

For preferences across every project, the CLI also reads one file from your home directory:

1. ~/.AGENTS.md
2. ~/.CLAUDE.md

Only the first file found is used, and names are case-insensitive. It loads alongside the project's file, so put personal preferences here and team rules in the project.