Rabbitrabbit/ide

Docs / Project rules

AGENTS.md support.

What is AGENTS.md?

AGENTS.md is a cross-IDE convention for embedding agent instructions inside a repository. Rabbit IDE readsAGENTS.md files from the workspace root and any subdirectory, giving per-directory context to the agent.

Format

# AGENTS.md

## Build
- Run `pnpm build` to build the project.
- Run `pnpm test` for the test suite.

## Architecture
- src/core/ contains the domain logic.
- src/api/ is the HTTP layer (Express).
- Never import from api/ into core/.

## Rules
- All new endpoints need integration tests.
- Use zod for request validation.

Scoped rules

Place an AGENTS.md in a subdirectory to provide context scoped to that part of the codebase. For example,src/billing/AGENTS.md will only be loaded when the agent operates on files under src/billing/.

Priority

AGENTS.md rules are loaded alongside.rabbitrules and other rule files. The merge order is:

  • Global ~/.rabbitrules
  • AGENTS.md (root)
  • AGENTS.md (scoped subdirectory)
  • .cursorrules / .windsurfrules
  • .rabbitrules (highest priority)