Rules

A shared instructions file that every agent follows.

What are Rules?

Rules is a shared file that Clustr manages for you. Every agent receives its contents when it starts, and agents periodically re-read it to pick up any changes.

Think of it as a team rulebook — anything you put here applies to every agent in the workspace.

Default contents

# Global Agent Instructions

This file is read by every agent at startup and should be re-read periodically.
Keep entries concise to save tokens.

## Rules
- Write concise context: bullet points, key facts only — no verbose prose.
- Re-read this file periodically to stay current with team knowledge.
- When stuck, list other agents and ask for help.
- Before starting work, read shared context to see what others have already discovered.

## Project Notes
- **Never push from master branch.** Only push from feature branches.
- Branch naming: `corpID/JIRA_ID` (e.g. `apatel15/PLICS-1234`)

Editing Rules

You can edit the rules from three places:

• Dashboard — the Rules tab provides a live editor
• Any agent — agents can read and edit the rules file directly using their file editing tools
• REST API — read and update programmatically

What to put in Rules

• Team rules — e.g., "never push directly to the main branch", "always run tests before committing"
• Naming conventions — branch naming patterns, commit message formats
• Project notes — architectural decisions, known issues, migration status
• Agent coordination — e.g., "Agent A owns the API; check with it before changing endpoints"
• Context writing guidelines — what to write to shared context and when