agentleFS
Sign inStart free
ahonnahonn/dotfiles/AGENTS.md

dotfiles

AGENTS.md62 starsChanged 2 months agoMITView on GitHub

nix-darwin dotfiles repository managing macOS development environments via Nix flakes. Two hosts, workstation (primary dev machine) and homelab (Mac Mini), share base modules and add host-specific overrides. Run these without asking, and fix failures caused by your change: Confirm before running: Update flake inputs only when the task is about updating them; ./scripts/update-homebrew-inputs.sh keeps brew and its taps in step. Git uses conventional commits via cz commit or git cz.

  • Installs packages

The file

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

2 rules. About 0 are common, 1 is distinctive, and 1 is 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.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run these without asking, and fix failures caused by your change:

    line 15
  2. Very specific:

    Update flake inputs only when the task is about updating them.

    line 26

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

This file provides guidance to coding agents when working with code in this repository.

nix-darwin dotfiles repository managing macOS development environments via Nix flakes. Two hosts, workstation (primary dev machine) and homelab (Mac Mini), share base modules and add host-specific overrides.

Where to Look

  • Nix modules, hosts, packages, Homebrew, or darwin-rebuild failures: use the nix-darwin skill.
  • .claude/, config/, and symlink/ are linked with mkOutOfStoreSymlink, so edits apply without a rebuild. Adding or removing a skill directory is the exception: ~/.agents/skills links are generated at evaluation time.
  • Changes under flake.nix, hosts/, or modules/ apply only after darwin-rebuild switch.

Permissions

Run these without asking, and fix failures caused by your change:

  • nix eval --raw .#darwinConfigurations.<host>.system.drvPath for each affected host. This is the evaluation check; nix flake check only checks formatting.
  • nix flake check and nix fmt.

Confirm before running:

  • darwin-rebuild switch: requires sudo and changes the live system.
  • nix-collect-garbage: deletes rollback generations.
  • brew install, brew uninstall, or brew cleanup against managed packages: Homebrew state is declared in hosts/<host>/homebrew.nix.

Update flake inputs only when the task is about updating them; ./scripts/update-homebrew-inputs.sh keeps brew and its taps in step.

Git uses conventional commits via cz commit or git cz.

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