agent-rules

Category: Tools & Productivity | Uploader: netresearch | Downloads: 0 | Version: v1.0（Latest）

Use when creating or updating AGENTS.md files, .github/copilot-instructions.md, or other AI agent rule files, onboarding AI agents to a project, standardizing agent documentation, or when anyone mentions AGENTS.md, agent rules, project onboarding, or codebase documentation for AI agents.

Changelog: Source: GitHub https://github.com/netresearch/agent-rules-skill

Directory Structure

Current level: tree/main/skills/agent-rules/

📁 assets/
- 📁 example-workflows/
  - 📄 validate-agents.yml 2.7 KB
- 📁 scoped/
  - 📄 backend-go.md 3.6 KB
  - 📄 backend-php.md 3.0 KB
  - 📄 backend-python.md 2.6 KB
  - 📄 backend-typescript.md 2.8 KB
  - 📄 claude-code-skill.md 3.4 KB
  - 📄 cli.md 2.7 KB
  - 📄 concourse.md 5.2 KB
  - 📄 ddev.md 2.4 KB
  - 📄 docker.md 5.3 KB
  - 📄 documentation.md 3.5 KB
  - 📄 examples.md 3.4 KB
  - 📄 frontend-typescript.md 2.7 KB
  - 📄 github-actions.md 5.2 KB
  - 📄 gitlab-ci.md 4.6 KB
  - 📄 oro-bundle.md 6.5 KB
  - 📄 oro-project.md 5.5 KB
  - 📄 python-modern.md 6.1 KB
  - 📄 resources.md 3.5 KB
  - 📄 skill-repo.md 5.4 KB
  - 📄 symfony.md 5.3 KB
  - 📄 testing.md 3.0 KB
  - 📄 typo3-docs.md 3.6 KB
  - 📄 typo3-extension.md 5.1 KB
  - 📄 typo3-project.md 4.7 KB
  - 📄 typo3-testing.md 3.0 KB
- 📄 root-thin.md 4.5 KB
- 📄 root-verbose.md 4.3 KB
📁 evals/
- 📄 evals.json 20.7 KB
📁 references/
- 📁 examples/
  - 📁 coding-agent-cli/
    
    📄 AGENTS.md 2.5 KB
    
    📄 go.mod 45 B
    
    📄 scripts-AGENTS.md 10.1 KB
  - 📁 express-api-ts/
    
    📁 src/
    
    📁 controllers/
    
    📄 userController.ts 2.1 KB
    
    📁 middleware/
    
    📄 errorHandler.ts 1.0 KB
    
    📄 requestLogger.ts 471 B
    
    📁 routes/
    
    📄 health.ts 428 B
    
    📄 users.ts 397 B
    
    📁 utils/
    
    📄 errors.ts 1.2 KB
    
    📄 logger.ts 441 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 config.ts 917 B
    
    📄 index.ts 671 B
    
    📄 .env.example 232 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 package.json 757 B
    
    📄 pnpm-lock.yaml 101 B
    
    📄 tsconfig.json 630 B
  - 📁 fastapi-app/
    
    📁 src/
    
    📁 models/
    
    📄 __init__.py 278 B
    
    📄 item.py 1.0 KB
    
    📄 user.py 922 B
    
    📁 routes/
    
    📄 __init__.py 110 B
    
    📄 health.py 470 B
    
    📄 items.py 1.9 KB
    
    📄 users.py 1.7 KB
    
    📁 services/
    
    📄 __init__.py 174 B
    
    📄 item_service.py 2.5 KB
    
    📄 user_service.py 2.1 KB
    
    📄 __init__.py 58 B
    
    📄 AGENTS.md 2.9 KB
    
    📄 config.py 1.1 KB
    
    📄 main.py 1.5 KB
    
    📄 .env.example 348 B
    
    📄 AGENTS.md 3.2 KB
    
    📄 pyproject.toml 1.8 KB
    
    📄 uv.lock 136 B
  - 📁 go-api-with-react-admin/
    
    📁 admin/
    
    📁 src/
    
    📄 App.tsx 101 B
    
    📄 package.json 422 B
    
    📁 cmd/
    
    📁 api/
    
    📄 main.go 75 B
    
    📄 .scopes 93 B
    
    📄 AGENTS.md 3.0 KB
    
    📄 go.mod 31 B
    
    📄 main.go 71 B
  - 📁 go-with-internal-web-tsx/
    
    📁 internal/
    
    📁 web/
    
    📁 src/
    
    📄 App.tsx 57 B
    
    📄 Button.tsx 63 B
    
    📄 Footer.tsx 63 B
    
    📄 Header.tsx 63 B
    
    📄 Sidebar.tsx 65 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 package.json 328 B
    
    📄 .scopes 102 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 go.mod 34 B
    
    📄 main.go 85 B
    
    📄 package-lock.json 0 B
    
    📄 package.json 192 B
  - 📁 ldap-selfservice/
    
    📄 AGENTS.md 2.5 KB
    
    📄 go.mod 45 B
    
    📄 internal-AGENTS.md 10.0 KB
    
    📄 internal-web-AGENTS.md 12.1 KB
  - 📁 php-with-frontend/
    
    📁 src/
    
    📄 Controller.php 41 B
    
    📁 web/
    
    📁 src/
    
    📄 App.tsx 63 B
    
    📄 Button.tsx 215 B
    
    📄 Footer.tsx 125 B
    
    📄 Header.tsx 122 B
    
    📄 main.tsx 68 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 package.json 489 B
    
    📄 tsconfig.json 280 B
    
    📄 .scopes 89 B
    
    📄 AGENTS.md 3.1 KB
    
    📄 composer.json 185 B
    
    📄 package.json 277 B
    
    📄 pnpm-lock.yaml 0 B
  - 📁 pnpm-workspace/
    
    📁 packages/
    
    📁 web/
    
    📁 src/
    
    📄 index.ts 258 B
    
    📄 package.json 187 B
    
    📄 AGENTS.md 2.6 KB
    
    📄 package.json 105 B
    
    📄 pnpm-lock.yaml 920 B
    
    📄 pnpm-workspace.yaml 27 B
  - 📁 simple-ldap-go/
    
    📄 AGENTS.md 2.5 KB
    
    📄 examples-AGENTS.md 1.8 KB
    
    📄 go.mod 43 B
  - 📁 t3x-rte-ckeditor-image/
    
    📄 AGENTS.md 2.5 KB
    
    📄 Classes-AGENTS.md 12.0 KB
    
    📄 composer.json 174 B
- 📄 ai-contribution-guidelines.md 2.5 KB
- 📄 ai-tool-compatibility.md 7.9 KB
- 📄 analysis.md 10.8 KB
- 📄 directory-coverage.md 2.4 KB
- 📄 git-hooks-setup.md 2.4 KB
- 📄 output-structure.md 3.8 KB
- 📄 scripts-guide.md 4.9 KB
- 📄 verification-guide.md 5.5 KB
📁 scripts/
- 📁 lib/
  - 📄 config-root.sh 5.8 KB
  - 📄 summary.sh 10.7 KB
  - 📄 template.sh 13.1 KB
- 📄 analyze-git-history.sh 9.8 KB
- 📄 check-freshness.sh 6.3 KB
- 📄 detect-golden-samples.sh 5.3 KB
- 📄 detect-heuristics.sh 3.2 KB
- 📄 detect-project.sh 19.3 KB
- 📄 detect-scopes.sh 11.8 KB
- 📄 detect-utilities.sh 4.3 KB
- 📄 extract-adrs.sh 6.6 KB
- 📄 extract-agent-configs.sh 9.2 KB
- 📄 extract-architecture-rules.sh 19.9 KB
- 📄 extract-ci-commands.sh 12.5 KB
- 📄 extract-ci-rules.sh 15.4 KB
- 📄 extract-commands.sh 11.0 KB
- 📄 extract-documentation.sh 7.7 KB
- 📄 extract-github-rulesets.sh 3.5 KB
- 📄 extract-github-settings.sh 3.3 KB
- 📄 extract-ide-settings.sh 7.0 KB
- 📄 extract-platform-files.sh 7.9 KB
- 📄 extract-quality-configs.sh 14.8 KB
- 📄 generate-agents.sh 113.4 KB
- 📄 generate-file-map.sh 4.4 KB
- 📄 validate-structure.sh 8.6 KB
- 📄 verify-commands.sh 22.0 KB
- 📄 verify-content.sh 9.5 KB
📄 AGENTS.md 3.9 KB
📄 checkpoints.yaml 9.0 KB
📄 CLAUDE.md 9 B
📄 SKILL.md 3.9 KB

SKILL.md

---
name: agent-rules
description: "Use when creating or updating AGENTS.md files, .github/copilot-instructions.md, or other AI agent rule files, onboarding AI agents to a project, standardizing agent documentation, or when anyone mentions AGENTS.md, agent rules, project onboarding, or codebase documentation for AI agents."
license: "(MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0"
compatibility: "Requires bash 4.3+, jq 1.5+, git 2.0+."
metadata:
  author: Netresearch DTT GmbH
  version: "3.7.0"
  repository: https://github.com/netresearch/agent-rules-skill
allowed-tools: Bash(git:*) Bash(jq:*) Bash(grep:*) Bash(find:*) Bash(bash:*) Read Glob Grep
---

# AGENTS.md Generator Skill

Generate and maintain AGENTS.md files following the [agents.md convention](https://agents.md/). AGENTS.md is FOR AGENTS, not humans.

## When to Use

- Creating or updating AGENTS.md for new/existing projects
- Standardizing agent documentation across repositories
- Checking if AGENTS.md files are current with recent code changes
- Onboarding AI agents to an unfamiliar codebase

## Scripts

| Script | Purpose |
|--------|---------|
| `scripts/generate-agents.sh PATH` | Generate AGENTS.md files |
| `scripts/validate-structure.sh PATH` | Validate structure compliance |
| `scripts/check-freshness.sh PATH` | Check if files are outdated |
| `scripts/verify-content.sh PATH` | Verify documented files/commands match codebase |
| `scripts/verify-commands.sh PATH` | Verify documented commands execute |
| `scripts/detect-project.sh PATH` | Detect language, version, build tools |
| `scripts/detect-scopes.sh PATH` | Identify directories needing scoped files |
| `scripts/extract-commands.sh PATH` | Extract commands from build configs |
| `scripts/extract-ci-rules.sh PATH` | Extract CI quality gates and version matrix |
| `scripts/extract-architecture-rules.sh PATH` | Extract module boundaries |
| `scripts/extract-adrs.sh PATH` | Extract architectural decision records |
| `scripts/extract-github-rulesets.sh PATH` | Extract GitHub rulesets and merge rules |

See `references/scripts-guide.md` for full options.

## Workflow

1. **Detect**: `detect-project.sh` + `detect-scopes.sh` to identify stacks and subsystems
2. **Extract**: `extract-commands.sh`, `extract-ci-rules.sh`, etc. to gather facts
3. **Generate**: `generate-agents.sh` with `--style=thin` (default) or `--verbose`
4. **Verify**: `verify-content.sh` + `verify-commands.sh` -- MANDATORY before done

Use `--update` to preserve human-curated content outside `<!-- GENERATED -->` markers.

## Core Principles

- **Structured over Prose** -- tables parse faster than paragraphs
- **Never Fabricate** -- only document what exists; verify every command and path
- **Pointer Principle** -- point to files, don't duplicate content
- **Auto Symlinks** -- CLAUDE.md/GEMINI.md symlinks by default (see [`ai-tool-compatibility.md`](references/ai-tool-compatibility.md))

## References

| File | Contents |
|------|----------|
| [`verification-guide.md`](references/verification-guide.md) | Verification steps, design principles |
| [`scripts-guide.md`](references/scripts-guide.md) | Script options, validation checklist |
| [`ai-tool-compatibility.md`](references/ai-tool-compatibility.md) | 16-agent compatibility matrix |
| [`output-structure.md`](references/output-structure.md) | Root/scoped sections |
| [`git-hooks-setup.md`](references/git-hooks-setup.md) | Hook framework detection and setup |
| [`examples/`](references/examples/) | Complete examples |

## Templates

Root: `assets/root-thin.md` (default), `root-verbose.md`. Scoped: `assets/scoped/` -- `backend-go.md`, `backend-php.md`, `python-modern.md`, `typo3.md`, `symfony.md`, `skill-repo.md`, `cli.md`, `frontend-typescript.md`, `oro.md`.

## Supported Projects

Go, PHP (Composer/Laravel/Symfony/TYPO3/Oro), TypeScript (React/Next/Vue/Node), Python (pip/poetry/ruff/mypy), Skill repos, Hybrid (multi-stack with auto-scoping).

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

agent-rules

Directory Structure

SKILL.md

Report

Notice