agentleFS
aaronreneaaronrene/knowtation/AGENTS.md

knowtation

AGENTS.md1 starsChanged 2 months agoMITView on GitHub

This repo uses Muse for the canonical history on MuseHub (staging) and Git for GitHub (PRs, CI, mirrors). NEVER push directly to main on GitHub. Every Muse merge to local main must be mirrored to GitHub via a PR from the muse-mirror branch. This is what preserves the PR audit trail (PR #NNN links, diff view, review threads). Required steps every time code lands on Muse main: Hard stops — if you are about to run either of these, STOP:…

  • Commits and pushes

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    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. Distinctive:

    If the user says "commit" without specifying Muse or Git, prefer Muse for this tree or ask once.

    line 14
  2. Very specific:

    NEVER push directly to main on GitHub: Every Muse merge to local main must be mirrored to GitHub via a PR from the muse-mirror branch.

    line 18
  3. Very specific:

    Follow project conventions in CONTRIBUTING.md and existing test layout under test/.

    line 51

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

Knowtation — agent instructions

Version control (read first)

This repo uses Muse for the canonical history on MuseHub (staging) and Git for GitHub (PRs, CI, mirrors).

IntentTooling
Default — ship product changes to MuseHubmuse status → muse code add … → muse commit -m "…" → muse push staging <branch>
GitHub-only — PR, branch protection, Actionsgit add / git commit / git push when the user or task says Git is the target
  • Staging remote name: staging (aaronrene/knowtation on staging.musehub.ai).
  • .museignore governs Muse snapshots; keep it aligned with .gitignore for secrets and local data (config/local.yaml, data/, etc.).
  • If the user says "commit" without specifying Muse or Git, prefer Muse for this tree or ask once.

GitHub mirror workflow — MANDATORY, no exceptions

NEVER push directly to main on GitHub. Every Muse merge to local main must be mirrored to GitHub via a PR from the muse-mirror branch. This is what preserves the PR audit trail (PR #NNN links, diff view, review threads).

Required steps every time code lands on Muse main:

# 1. After: muse checkout main && muse merge feat/<branch>
git add -A && git commit -m "mirror: muse <sha-before>..<sha-after> (<description>)"
git checkout -B muse-mirror          # reset muse-mirror branch to current HEAD
git push origin muse-mirror --force  # push mirror branch to GitHub

# 2. Open a PR from muse-mirror → main
gh pr create --base main --head muse-mirror \
  --title "mirror: <description>" \
  --body "Muse mirror — <muse-sha-range>"

# 3. Merge the PR (merge commit, not squash or rebase)
gh pr merge --merge

Hard stops — if you are about to run either of these, STOP:

  • git push origin main — use muse-mirror instead
  • git push origin HEAD while on main — use muse-mirror instead

Why this rule exists: The GitHub PR history is the permanent, human-readable audit record. PRs #226, #227, … are proof that every change was reviewed before landing. Pushing directly to main skips that record entirely and is not recoverable after the fact.

Knowtation product (MCP / CLI / vault)

Orchestration, MCP vs CLI, retrieval, and write-back: docs/AGENT-ORCHESTRATION.md. One-page surface overview: docs/AGENT-INTEGRATION.md.

Private vaults: outside the repo or only via ignored config/local.yaml — not under in-repo vault/ if remotes may be public.

Tests and quality

Follow project conventions in CONTRIBUTING.md and existing test layout under test/. Do not commit secrets or gitignored paths.

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.