# agent-rules

Generates and verifies AGENTS.md instruction files for AI coding agents. Keeps project guidelines structured and under strict line limits.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 811 installs · ★ 88
- Author: Netresearch DTT GmbH
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/netresearch/agent-rules-skill/tree/HEAD/skills/agent-rules/SKILL.md
- Updated: 2026-10-25
- HTML: https://affpapa.org/en/nevibecode/skills/agent-rules

## What it does

This skill creates machine-oriented documentation following the `AGENTS.md` convention. It inspects the repository, identifies languages and build tools across Go, PHP, TypeScript, or Python, and extracts CI quality gates. It can also link `CLAUDE.md` and `GEMINI.md` automatically.

Under the hood, several bash utilities inspect scopes, score files, and verify that documented shell commands execute properly. Scripts must be invoked via their full `${CLAUDE_SKILL_DIR}` path. Relative paths trigger security permission prompts on every call.

Execution requires `bash 4.3+`, `jq 1.7+`, and `git 2.0+`. The root `AGENTS.md` must stay under 150 lines, or CI harness validation checks fail.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add netresearch/agent-rules-skill --skill agent-rules -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/agent-rules/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/agent-rules/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add netresearch/agent-rules-skill --skill agent-rules -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/agent-rules/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add netresearch/agent-rules-skill --skill agent-rules -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/agent-rules/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install netresearch/agent-rules-skill agent-rules
```

2. **Manually: put the files in place**
- File: `.github/skills/agent-rules/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add netresearch/agent-rules-skill --skill agent-rules -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/netresearch/agent-rules-skill --path skills/agent-rules
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/agent-rules/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add netresearch/agent-rules-skill --skill agent-rules -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/netresearch/agent-rules-skill/tree/HEAD/skills/agent-rules/SKILL.md

## When to use it
- scaffold AGENTS.md files for new or existing codebases
- verify documented commands and paths against actual code
- audit and grade existing AI agent documentation
- create symlinks for CLAUDE.md and GEMINI.md automatically

## Example prompts
- Generate an AGENTS.md file for this project
- Verify that all commands in AGENTS.md are working
- Score the quality of existing agent rule files

## Similar
- [sync](https://affpapa.org/en/nevibecode/skills/sync.md) — skill · 4300 installs
- [audit](https://affpapa.org/en/nevibecode/skills/jsmastery-pro-audit.md) — skill · 4300 installs
- [decision-doc-sync](https://affpapa.org/en/nevibecode/skills/decision-doc-sync.md) — skill · 3000 installs
- [index-knowledge](https://affpapa.org/en/nevibecode/skills/index-knowledge.md) — skill · 1300 installs
- [deepinit](https://affpapa.org/en/nevibecode/skills/deepinit.md) — skill · 1000 installs
- [intent-layer](https://affpapa.org/en/nevibecode/skills/intent-layer.md) — skill · 627 installs

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md