dotfiles AGENTS.md

A project instruction file for a personal configuration repository, covering documentation, macOS setup files, Nix package configuration, and Git practices.

In plain words
What is it for?
Use it when editing dotfiles, Nix configuration, keyboard shortcuts, shell settings, editor settings, scripts, or related documentation.
Why use it?
It tells the coding agent which project rules apply, including when changes take effect immediately and when a system rebuild is required.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/rgomezcasas/dotfiles/agents-md
Clone the repo
git clone --depth 1 https://github.com/rgomezcasas/dotfiles

Made for: Codex, OpenCode.

Per session 341 This file is loaded in full into every session.
When invoked 341 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00341 $0.00341
Opus 5 $0.00170 $0.00170
Sonnet 5 $0.00068 $0.00068
Haiku 4.5 $0.00034 $0.00034

Measured 2d ago against content hash 31697555d51d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

dotfiles AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 31 lines

What it actually says

Documentation

Refer to the docs/ folder for detailed guides:

  • docs/karabiner/ — Karabiner keyboard shortcuts
  • docs/nix/ — Adding packages (nix, brew, casks, node, Mac App Store)
  • docs/raycast/ — Creating Raycast scripts
  • docs/scripts/ — Creating new scripts (docblock format, structure)
  • docs/shell/ — Shell command portability and aliases
  • docs/vscode-and-cursor/ — Custom shortcuts and settings

Almost every file under config/ (shell, editors, macos, git, agents) is symlinked into place by home-manager with mkOutOfStoreSymlink (see config/nix/system/symlinks.nix). Editing those files takes effect immediately — never suggest running rebuild after editing them.

rebuild is only needed when config/nix/ itself changes:

  • packages/*.nix — packages added or removed
  • system/symlinks.nix — symlink entries added, removed, or repointed
  • system/macos-defaults.nix, flake.nix

Special cases:

  • karabiner.edn → run goku (never edit karabiner.json)
  • Shell config (aliases, functions, zshrc) → only affects new shell sessions

Git

  • If you think it makes sense to split something into separate commits, go ahead and do it.
  • Do not autocommit
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 31 lines · 341 tokens per session scan A 31697555d51d

Subscribe to this mod's changes

dotfiles AGENTS.md is an instructions file published in the GitHub repository rgomezcasas/dotfiles (362 stars, last pushed 14d ago), licensed MIT. It adds 341 tokens to every session, about $0.0017 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories