Skip to content

Add AGENTS.md and ignore all Herdr runtime files - #23

Merged
user3301 merged 3 commits into
masterfrom
add-agents-md
Sep 27, 2026
Merged

user3301 merged 3 commits into
masterfrom
add-agents-md

Conversation

@user3301

@user3301 user3301 commented Sep 27, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add AGENTS.md: agent-agnostic instructions that Claude Code (v2.1.277+, when no CLAUDE.md exists), Copilot and other agents read automatically. It covers:
    • platform boundaries and repo layout
    • hard rules: keep stateVersion fixed, keep app configs hand-written and Stow-compatible, note that Home Manager's shell modules are off, don't activate systems or update inputs unless asked, never commit secrets
    • package pins (Azure CLI input, Copilot overlay hashes)
    • Nix gotchas: flakes only see tracked files, deadnix/statix, nixfmt
    • validation commands that mirror CI, plus evaluating the native host, which CI skips
  • Ignore all Herdr runtime files except config.toml: Herdr started writing session-snapshots/, which contain local paths and agent session IDs. The per-file ignore list is replaced with an allowlist so new runtime files stay out of git status.

Test plan

  • git check-ignore confirms the snapshots, session.json, sockets and plugins/ are ignored and config.toml is still tracked
  • The nix fmt and nix eval commands listed in AGENTS.md run successfully locally
  • CI passes (no Nix files changed)

🤖 Generated with Claude Code

user3301 and others added 2 commits September 27, 2026 10:19
Agent-agnostic instructions read by Claude Code, Copilot and other
agents: platform boundaries, hard rules (stateVersion, Stow-compatible
config, disabled Home Manager shell modules, no system activation or
input updates unless asked), package pins, Nix gotchas and the
CI-equivalent validation commands.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Herdr keeps adding state files to its symlinked config directory, most
recently session-snapshots/, which hold local paths and agent session
IDs. Replace the per-file list with an allowlist for config.toml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Correct the invalid nix fmt validation command in AGENTS.md.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

Adds repository-wide agent guidance and ignores Herdr runtime files while preserving config.toml.

Changes:

  • Added AGENTS.md with repository rules and validation guidance.
  • Updated .gitignore with a Herdr runtime-file allowlist.
File Description
AGENTS.md Adds agent instructions and workflows.
.gitignore Ignores Herdr runtime files except config.toml.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread AGENTS.md
These commands mirror CI (`.github/workflows/ci.yml`) and need no `sudo`:

```sh
nix fmt <changed .nix files>
@user3301
user3301 merged commit f7da0df into master Sep 27, 2026
1 check passed
@user3301
user3301 deleted the add-agents-md branch September 27, 2026 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants