agentleFS
Sign inStart free
docxologydocxology/codomyrmex/config/AGENTS.md

codomyrmex / config

AGENTS.md10 starsChanged 38 days agoMITView on GitHub

Define safe maintenance rules for versioned configuration examples and defaults. - Never add credentials, tokens, private keys, personal contact data, or production-only endpoints. - Preserve documented precedence between defaults, files, environment variables, and explicit caller values. - Keep examples minimal and syntactically valid. - Use the owning module's schema and loader rather than inventing a global validation rule. - Reject unsafe values by default when configuration controls authentication, host verification, publication, deployment, or destructive operations. - Update source defaults, example…

The file

We split this AGENTS.md into the rules it gives an agent

8 rules. About 1 is common, 5 are distinctive, and 2 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    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
  • could be automatic: a setting could enforce it
  1. Common:

    Never add credentials, tokens, private keys, personal contact data, or production-only endpoints.

    line 12
  2. Distinctive:

    Keep examples minimal and syntactically valid.

    line 16
  3. Distinctive:

    Use the owning module's schema and loader rather than inventing a global validation rule.

    line 17
  4. Very specific:

    Update source defaults, example files, tests, README/SPEC/PAI/security, and changelog together.

    line 21
  5. Distinctive:

    Run GitNexus impact analysis before changing loader or validator symbols.

    line 23
  6. Distinctive:

    Do not bulk-regenerate folder documentation during the hand-pass freeze.

    line 24
  7. Distinctive:

    Run the owning module's focused tests and the repository configuration/source gates relevant to the change.

    line 35
  8. Very specific:

    If a named test path differs, discover the current path with rg --files tests instead of copying a stale command.

    line 43

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md
<!-- agents: curated -->

Agent guidance for configuration

Purpose

Define safe maintenance rules for versioned configuration examples and defaults.

Development Guidelines

  • Never add credentials, tokens, private keys, personal contact data, or production-only endpoints.
  • Preserve documented precedence between defaults, files, environment variables, and explicit caller values.
  • Keep examples minimal and syntactically valid.
  • Use the owning module's schema and loader rather than inventing a global validation rule.
  • Reject unsafe values by default when configuration controls authentication, host verification, publication, deployment, or destructive operations.
  • Update source defaults, example files, tests, README/SPEC/PAI/security, and changelog together.
  • Run GitNexus impact analysis before changing loader or validator symbols.
  • Do not bulk-regenerate folder documentation during the hand-pass freeze.

Key Files

  • README.md — human-facing configuration boundary
  • SPEC.md — configuration-surface specification
  • default.yaml — repository default example
  • hermes_skills_profile.example.yaml — optional Hermes profile example

Validation

Run the owning module's focused tests and the repository configuration/source gates relevant to the change. At minimum:

uv run --locked ruff check config src/codomyrmex/config_management
uv run --locked pytest -q tests/unit/config_management

If a named test path differs, discover the current path with rg --files tests instead of copying a stale command.

Navigation

  • Human overview
  • Configuration specification
  • Repository agent contract
  • Configuration management source

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free