Rabbitrabbit/ide

Docs / Project rules

.rabbitrules

What is .rabbitrules?

A .rabbitrules file at your project root injects custom instructions into the agent's system prompt. Use it to define coding conventions, architecture constraints, and project-specific behavior.

Where to place it

  • .rabbitrules -- workspace root (loaded first)
  • .rabbit-ide/.rabbitrules -- alternative location
  • ~/.rabbitrules -- global rules applied to all projects

Example

# .rabbitrules

- Always use TypeScript strict mode.
- Prefer functional components with hooks.
- Use Tailwind CSS for styling, never inline styles.
- Write tests for every new function.
- Use pnpm, not npm or yarn.
- Database queries must use parameterized statements.
- Never commit API keys or secrets.

How it works

On workspace open, Rabbit scans for rule files in priority order. The contents are injected as a <user_rules> block in the system prompt, giving the rules highest priority over default instructions.

Scope

Rules apply to the agent chat, inline completions, and CLI runs. They are plain text -- no special syntax required. Write them as you would write instructions to a colleague.