Download free

Project rules

Write in AGENTS.md or OSIRIS.md how work is done in your project; the app reads those two files, from the project's root down to the folder you work in.

Updated · version 2.0.164 · Markdown

Project rules are instructions your agents read before they work in a folder: how it builds, which style it uses, what is not to be touched. They live in text files inside the project.

Create the rules

  1. Open a chat in your project.
  2. In the message box type /init and send. The agent reads the code and writes the project's AGENTS.md.
  3. Open the file and correct it: it is yours, and what it says is what your agents will do.

Instructions you type in the app

Open the project's settings and write in «How should the agents work in this project?». It is kept in the app, not in your folder, and every chat of the project follows it. It saves when you leave the box. If it is too long it is refused and nothing is saved; it is never cut.

In «Reference material for this project» you add files (books, PDFs, notes) that only this project's chats read.

What is read, and when

FileWhen it reaches the agent
AGENTS.md or OSIRIS.md at the project's root (the folder with .git)When the chat starts.
The same files in each folder from the root down to the folder the chat works inWhen the chat starts. The closer a file is to your folder, the later it comes, because it is the more specific.
AGENTS.md or OSIRIS.md in a subfolder the chat does not work inWhen the agent reads a file in that subfolder, with the file-reading tool or with a command that shows it, such as cat, head or grep.

Your own rules, the ones that apply to every project, are the AGENTS.md or OSIRIS.md in your profile's folder and, for a business, its own AGENTS.md. They come first, and they always keep room.

Rules written for another tool are not read

Rule files that other coding tools keep in a project, or in your home folder, are written for those tools' models. NoBreiniers does not read them, so an instruction meant for another model never reaches the ones you use here. To keep something from them, copy it into your AGENTS.md.

The home folder is no project

A chat that works in your home folder has no project, so it reads no project rules: the home folder, the folders above it and the hidden folders inside it are never a project's.

What the app takes care of

  • Every rule file reaches your agents whole. Whatever a rule file says, the app gives it to your agents as it is, without holding anything back. A project's own file (one a downloaded project may bring) is marked as that project's text, so your agents know it is not yours. Your own rules come as you wrote them.
  • Nothing is lost in silence. All the rules share 64 KiB, filled from the closest folder outward so the most specific always fit. What does not fit is named.
  • No repeats. If AGENTS.md and OSIRIS.md are links to one shared file, it is given once.
  • No way out of the folder. A link that leaves the project's folder is not followed.
  • After a compaction. In a long conversation, the rules a read brought come back with the next read.