domfiles
AGENTS.md7 starsChanged 8 days agoMITView on GitHub
Unqualified phrases such as “global agent instructions,” “global AGENTS.md,” and “global AGENTS document,” along with equivalent wording, refer to .agents/GLOBAL.md. For changed JSON files, run pnpm run lint:json <changed-json-files>. Pass paths explicitly unless repository-wide validatio
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository26 other files it gives its agents.
- auditSkill
- harmonizeSkill
- shell-integrationSkill
- agent-task-directoriesSkill
- agent-task-relaySkill
- agent-documentationSkill
- browser-automationSkill
- cli-subagentSkill
- full-reviewSkill
- prepushSkill
- skill-developmentSkill
- vitest-conventionsSkill
- dom-release-notes-for-humansSkill
- dom-sensible-commit-flowSkill
- dom-sensible-contribution-flowSkill
- fish-shell-scriptingSkill
- human-facing-writingSkill
- intentional-dependency-choiceSkill
- posix-shell-scriptingSkill
- refine-agent-workflowSkill
- release-notes-for-humansSkill
- sensible-commit-flowSkill
- sensible-contribution-flowSkill
- simple-github-cliSkill
- subagent-review-flowSkill
- verify-findingsSkill
The file
We split this AGENTS.md into the rules it gives an agent
8 rules. About 2 are common, 4 are distinctive, and 2 are very specific to this project.
≈2
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Public surfaces: Treat every tracked file, proposed repository artifact, patch, and relay as publicly disclosed.
- Distinctive: line 10
Authentication review: Before recommending or implementing a tool that uses authentication or private configuration, establish:
- Common: line 15
Feasibility: Treat a tool as feasible only when its public configuration can remain separate from secret material through an established …
- Common: line 17
No safe route: If no established public-safe route exists, report the tool as infeasible or ask the user to choose a secret storage …
- Distinctive: line 33
Environment: Follow the supported environment, including its default-shell requirement.
- Distinctive: line 34
Command entrypoints: Use the entrypoint documented for each task, including validation, rather than another route to the same …
- Very specific: line 47
Fish: Treat home/.config/fish/local.fish as secret-bearing machine-local configuration.
- Very specific: line 62
Follow the domfiles skill policy for project-authored skill work, including classification, supported installation, scripts, and test …
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Agent Instructions
Overview
- Repository: Contains all actively used dotfiles and is also called domfiles.
Public Repository Boundary
- Public surfaces: Treat every tracked file, proposed repository artifact, patch, and relay as publicly disclosed.
- Authentication review: Before recommending or implementing a tool that uses authentication or private configuration, establish:
- Which secrets or private values it requires.
- How those values enter at runtime without appearing in command literals or repository files.
- Where the tool persists credentials and generated configuration.
- Whether any generated or modified file can enter the repository.
- Feasibility: Treat a tool as feasible only when its public configuration can remain separate from secret material through an established machine-local source or external credential store.
- Ignored-file boundary: A Git-ignored file qualifies as an established machine-local source only when public repository provisioning creates or adopts it without embedding secret values, restricts it to user-only access, and tracked configuration refers only to its path. Ignore status alone isn’t enough.
- No safe route: If no established public-safe route exists, report the tool as infeasible or ask the user to choose a secret storage boundary.
Agent Documentation
| Source | Authority and Ownership |
.agents/GLOBAL.md | Defines global user defaults. |
AGENTS.md | Defines project instructions, scope, and documentation authority. Applicable project instructions override global defaults. |
Project-authored skill directories under .agents/skills/ and skills/ | Own delegated domain policy, workflows, validation, and reporting exceptions without contradicting applicable AGENTS.md instructions. |
.agents/PROJECT.md | Records constraints, durable facts, maintenance decisions, and rationale. It doesn’t override agent instructions. |
Unqualified phrases such as “global agent instructions,” “global AGENTS.md,” and “global AGENTS document,” along with equivalent wording, refer to .agents/GLOBAL.md.
General
- User direction: The global Explicit user direction policy applies to this repository’s workflow requirements, conventions, and non-secret content exclusions, including those in project-authored skills. The public repository boundary remains applicable.
- Environment: Follow the supported environment, including its default-shell requirement.
- Command entrypoints: Use the entrypoint documented for each task, including validation, rather than another route to the same implementation. Invoke repository-scoped commands through
PATH, overriding global Direct invocation forskillsandvercelin this repository. This exercises the interfaces other users and agents rely on. - Navigation: Consult the relevant sections of
.agents/PROJECT.md. - Durable knowledge: Add project knowledge to
.agents/PROJECT.mdonly when it meets the global Durable knowledge threshold. Don’t record optimization recaps, routine implementation details, or workflow summaries. Prefer updating existing material over adding another explanation. If the task doesn’t permit the edit, report deferred documentation work only if it meets that threshold. - Zed settings: Keep
.zed/settings.jsonandhome/.config/zed/settings.jsonfree of redundant entries. An entry is redundant only when omitting it preserves the supported workflow, including tool-managed state and later invocations. Matching a default or inherited value alone doesn’t make an entry redundant. See the CLI persistence rationale.
Validation
For changed JSON files, run pnpm run lint:json <changed-json-files>. Pass paths explicitly unless repository-wide validation is intended.
For Markdown validation, invoke doclint and follow Check Markdown.
Scope
- Fish: Treat
home/.config/fish/local.fishas secret-bearing machine-local configuration. Exclude its contents from analysis, execution, and validation, including indirect sourcing through Fish startup. - Symlink: Exclude the contents of
home/.local/bin/git-diff-highlightby default because its target is outside the repository. Include its target only when the user explicitly requests that analysis and access boundaries permit it. - Secret-bearing local files: Don’t read, analyze, echo, or stage Git-ignored files that public provisioning and tracked configuration designate for machine-local secret material. Path-level metadata and public provisioning code remain in scope.
Reporting
- Empty configuration: Don’t report empty configuration files.
- Fixed locations: Report cases that would tie this repository to a fixed filesystem location, except:
$HOME/*paths, system paths, or vendor paths.- Symlinks created through
domfiles sync. home/.config/fish/fish_variables.- Documentation.
Skills
Follow the domfiles skill policy for project-authored skill work, including classification, supported installation, scripts, and test integration.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

