Feature · Platform
Rules & Preferences
Set work rules and preferences. Review their sources here.
How it works
The page
Rules & Preferences has the tabs Preferences, Rules, Rulebook, Rails and Export. Pick a project, or no project for the organization's and your own values.
Add a rule
- Add a rule from a sentence: write the rule in your own words; Agent drafts it.
- New rule: write it in full.
- Add a file
.agents/rules/<name>.mdto a repository.
Where values come from
Each preference shows the layer it comes from. A more specific layer wins: the run, the item, your private presets, the project, you, your team, the organization and the platform.
Export
Export to other tools writes files for other coding tools. Your own rules and private presets are never exported.
Rules and policies
Rules say how to do the work. Policies say what workers may do. See Policies.
From the help article Rules and preferences, checked against the product on .
What you can do
The operations this feature's screens call. Each one is POST /api/<name>, and the badge says who may call it.
ViewergetPreferencesGets preferences.
Types:
GetPreferencesRequestreturnsPreferencesView
ViewerexportRulesExports rules.
Types:
ExportRulesRequestreturnsExportRulesResponse
AdminNo API tokensupdateOrgPreferencesUpdates org preferences.
Types:
UpdateOrgPreferencesRequestreturnsPreferencesView
ViewerNo API tokensupdateMyPreferencesUpdates my preferences.
Types:
UpdateMyPreferencesRequestreturnsPreferencesView
ViewerlistRulesLists rules.
Types:
ListRulesRequestreturnsListResponse<RuleDto>
MemberruleFromSentenceRule from sentence.
Types:
RuleFromSentenceRequestreturnsRuleFromSentenceResponse
ViewergetRulebookCandidateGets the rulebook candidate.
Types:
GetRulebookCandidateRequestreturnsGetRulebookCandidateResponse
ViewerlistRulebookLists rulebook.
Types:
ListRulebookRequestreturnsListRulebookResponse
ViewerNo API tokenssetRailOverrideSets the rail override.
Types:
SetRailOverrideRequestreturnsSetRailOverrideResponse
ViewerlistRailsLists rails.
Types:
ListRailsRequestreturnsListRailsResponse
AdmincompileRailsCompiles rails.
Types:
CompileRailsRequestreturnsCompileRailsResponse
MemberproposeProjectChangeProposes a project change.
Types:
ProposeProjectChangeRequestreturnsProposeProjectChangeResponse
ViewerpreviewRulePreviews the rule.
Types:
PreviewRuleRequestreturnsPreviewRuleResponse
ViewerNo API tokenssaveRuleSaves the rule.
Types:
SaveRuleRequestreturnsRuleDto
ViewerNo API tokensdeleteRuleDeletes the rule.
Types:
RuleIdRequestreturnsOkResponse
ViewerNo API tokensreviewRulebookCandidateReviews the rulebook candidate.
Types:
ReviewRulebookCandidateRequestreturnsReviewRulebookCandidateResponse
ViewerlistMembersLists members.
Types:
EmptyRequestreturnsListMembersResponse