Skip to content
cccskills
FreePublished on GitHub

agent-rules

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.

The English summary is being prepared. Showing the original description.

See how to install

Files included (154)

  • SKILL.md4.5 KB
  • AGENTS.md3.9 KB
  • assets/example-workflows/validate-agents.yml2.7 KB
  • assets/root-thin.md5.7 KB
  • assets/root-verbose.md5.5 KB
  • assets/scoped/backend-go.md3.6 KB
  • assets/scoped/backend-php.md3.0 KB
  • assets/scoped/backend-python.md2.6 KB
  • assets/scoped/backend-typescript.md2.8 KB
  • assets/scoped/claude-code-skill.md3.4 KB
  • assets/scoped/cli.md2.7 KB
  • assets/scoped/concourse.md5.2 KB
  • assets/scoped/ddev.md2.4 KB
  • assets/scoped/docker.md5.3 KB
  • assets/scoped/documentation.md3.5 KB
  • assets/scoped/examples.md3.4 KB
  • assets/scoped/frontend-typescript.md2.7 KB
  • assets/scoped/github-actions.md5.2 KB
  • assets/scoped/gitlab-ci.md4.6 KB
  • assets/scoped/oro-bundle.md6.5 KB
  • assets/scoped/oro-project.md5.5 KB
  • assets/scoped/python-modern.md6.1 KB
  • assets/scoped/resources.md3.5 KB
  • assets/scoped/skill-repo.md5.4 KB
  • assets/scoped/symfony.md5.3 KB
  • assets/scoped/testing.md3.0 KB
  • assets/scoped/typo3-docs.md3.6 KB
  • assets/scoped/typo3-extension.md5.1 KB
  • assets/scoped/typo3-project.md4.7 KB
  • assets/scoped/typo3-testing.md3.0 KB
  • checkpoints.yaml9.0 KB
  • evals/evals.json20.7 KB
  • references/ai-contribution-guidelines.md2.5 KB
  • references/ai-tool-compatibility.md7.9 KB
  • references/analysis.md10.8 KB
  • references/directory-coverage.md2.4 KB
  • references/examples/coding-agent-cli/AGENTS.md2.5 KB
  • references/examples/coding-agent-cli/go.mod45 B
  • references/examples/coding-agent-cli/scripts-AGENTS.md10.1 KB
  • references/examples/express-api-ts/.env.example232 B
  • references/examples/express-api-ts/AGENTS.md3.1 KB
  • references/examples/express-api-ts/package.json757 B
  • references/examples/express-api-ts/pnpm-lock.yaml101 B
  • references/examples/express-api-ts/src/AGENTS.md3.1 KB
  • references/examples/express-api-ts/src/config.ts917 B
  • references/examples/express-api-ts/src/controllers/userController.ts2.1 KB
  • references/examples/express-api-ts/src/index.ts671 B
  • references/examples/express-api-ts/src/middleware/errorHandler.ts1.0 KB
  • references/examples/express-api-ts/src/middleware/requestLogger.ts471 B
  • references/examples/express-api-ts/src/routes/health.ts428 B
  • references/examples/express-api-ts/src/routes/users.ts397 B
  • references/examples/express-api-ts/src/utils/errors.ts1.2 KB
  • references/examples/express-api-ts/src/utils/logger.ts441 B
  • references/examples/express-api-ts/tsconfig.json630 B
  • references/examples/fastapi-app/.env.example348 B
  • references/examples/fastapi-app/AGENTS.md3.2 KB
  • references/examples/fastapi-app/pyproject.toml1.8 KB
  • references/examples/fastapi-app/src/__init__.py58 B
  • references/examples/fastapi-app/src/AGENTS.md2.9 KB
  • references/examples/fastapi-app/src/config.py1.1 KB
  • references/examples/fastapi-app/src/main.py1.7 KB
  • references/examples/fastapi-app/src/models/__init__.py278 B
  • references/examples/fastapi-app/src/models/item.py1.0 KB
  • references/examples/fastapi-app/src/models/user.py922 B
  • references/examples/fastapi-app/src/routes/__init__.py110 B
  • references/examples/fastapi-app/src/routes/health.py470 B
  • references/examples/fastapi-app/src/routes/items.py1.9 KB
  • references/examples/fastapi-app/src/routes/users.py1.7 KB
  • references/examples/fastapi-app/src/services/__init__.py174 B
  • references/examples/fastapi-app/src/services/item_service.py2.5 KB
  • references/examples/fastapi-app/src/services/user_service.py2.1 KB
  • references/examples/fastapi-app/uv.lock136 B
  • references/examples/go-api-with-react-admin/.scopes93 B
  • references/examples/go-api-with-react-admin/admin/package.json422 B
  • references/examples/go-api-with-react-admin/admin/src/App.tsx101 B
  • references/examples/go-api-with-react-admin/AGENTS.md3.0 KB
  • references/examples/go-api-with-react-admin/cmd/api/main.go75 B
  • references/examples/go-api-with-react-admin/go.mod31 B
  • references/examples/go-api-with-react-admin/main.go71 B
  • references/examples/go-with-internal-web-tsx/.scopes102 B
  • references/examples/go-with-internal-web-tsx/AGENTS.md3.1 KB
  • references/examples/go-with-internal-web-tsx/go.mod34 B
  • references/examples/go-with-internal-web-tsx/internal/web/AGENTS.md3.1 KB
  • references/examples/go-with-internal-web-tsx/internal/web/package.json328 B
  • references/examples/go-with-internal-web-tsx/internal/web/src/App.tsx57 B
  • references/examples/go-with-internal-web-tsx/internal/web/src/Button.tsx63 B
  • references/examples/go-with-internal-web-tsx/internal/web/src/Footer.tsx63 B
  • references/examples/go-with-internal-web-tsx/internal/web/src/Header.tsx63 B
  • references/examples/go-with-internal-web-tsx/internal/web/src/Sidebar.tsx65 B
  • references/examples/go-with-internal-web-tsx/main.go85 B
  • references/examples/go-with-internal-web-tsx/package-lock.json0 B
  • references/examples/go-with-internal-web-tsx/package.json220 B
  • references/examples/ldap-selfservice/AGENTS.md2.5 KB
  • references/examples/ldap-selfservice/go.mod45 B
  • references/examples/ldap-selfservice/internal-AGENTS.md10.0 KB
  • references/examples/ldap-selfservice/internal-web-AGENTS.md12.1 KB
  • references/examples/php-with-frontend/.scopes89 B
  • references/examples/php-with-frontend/AGENTS.md3.1 KB
  • references/examples/php-with-frontend/composer.json185 B
  • references/examples/php-with-frontend/package.json306 B
  • references/examples/php-with-frontend/pnpm-lock.yaml0 B
  • references/examples/php-with-frontend/src/Controller.php41 B
  • references/examples/php-with-frontend/web/AGENTS.md3.1 KB
  • references/examples/php-with-frontend/web/package.json514 B
  • references/examples/php-with-frontend/web/src/App.tsx63 B
  • references/examples/php-with-frontend/web/src/Button.tsx215 B
  • references/examples/php-with-frontend/web/src/Footer.tsx125 B
  • references/examples/php-with-frontend/web/src/Header.tsx122 B
  • references/examples/php-with-frontend/web/src/main.tsx68 B
  • references/examples/php-with-frontend/web/tsconfig.json280 B
  • references/examples/pnpm-workspace/AGENTS.md2.6 KB
  • references/examples/pnpm-workspace/package.json105 B
  • references/examples/pnpm-workspace/packages/web/package.json187 B
  • references/examples/pnpm-workspace/packages/web/src/index.ts258 B
  • references/examples/pnpm-workspace/pnpm-lock.yaml920 B
  • references/examples/pnpm-workspace/pnpm-workspace.yaml27 B
  • references/examples/simple-ldap-go/AGENTS.md2.5 KB
  • references/examples/simple-ldap-go/examples-AGENTS.md1.8 KB
  • references/examples/simple-ldap-go/go.mod43 B
  • references/examples/t3x-rte-ckeditor-image/AGENTS.md2.5 KB
  • references/examples/t3x-rte-ckeditor-image/Classes-AGENTS.md12.0 KB
  • references/examples/t3x-rte-ckeditor-image/composer.json174 B
  • references/feedback-memory-schema.md7.2 KB
  • references/git-hooks-setup.md2.4 KB
  • references/output-structure.md4.9 KB
  • references/scripts-guide.md4.9 KB
  • references/verification-guide.md5.5 KB
  • scripts/analyze-git-history.sh9.8 KB
  • scripts/check-freshness.sh6.3 KB
  • scripts/detect-golden-samples.sh5.3 KB
  • scripts/detect-heuristics.sh3.2 KB
  • scripts/detect-project.sh19.3 KB
  • scripts/detect-scopes.sh12.1 KB
  • scripts/detect-utilities.sh4.3 KB
  • scripts/extract-adrs.sh6.6 KB
  • scripts/extract-agent-configs.sh9.2 KB
  • scripts/extract-architecture-rules.sh19.9 KB
  • scripts/extract-ci-commands.sh12.5 KB
  • scripts/extract-ci-rules.sh15.4 KB
  • scripts/extract-commands.sh11.0 KB
  • scripts/extract-documentation.sh7.7 KB
  • scripts/extract-github-rulesets.sh3.5 KB
  • scripts/extract-github-settings.sh3.3 KB
  • scripts/extract-ide-settings.sh7.0 KB
  • scripts/extract-platform-files.sh7.9 KB
  • scripts/extract-quality-configs.sh14.8 KB
  • scripts/generate-agents.sh113.6 KB
  • scripts/generate-file-map.sh4.4 KB
  • scripts/lib/config-root.sh5.8 KB
  • scripts/lib/summary.sh10.7 KB
  • scripts/lib/template.sh13.1 KB
  • scripts/validate-structure.sh8.6 KB
  • scripts/verify-commands.sh22.0 KB
  • scripts/verify-content.sh9.5 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

AGENTS.md Generator Skill

Generate and maintain AGENTS.md files following the agents.md convention. 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

ScriptPurpose
scripts/generate-agents.sh PATHGenerate AGENTS.md files
scripts/validate-structure.sh PATHValidate structure compliance
scripts/check-freshness.sh PATHCheck if files are outdated
scripts/verify-content.sh PATHVerify documented files/commands match codebase
scripts/verify-commands.sh PATHVerify documented commands execute
scripts/detect-project.sh PATHDetect language, version, build tools
scripts/detect-scopes.sh PATHIdentify directories needing scoped files
scripts/extract-commands.sh PATHExtract commands from build configs
scripts/extract-ci-rules.sh PATHExtract CI quality gates and version matrix
scripts/extract-architecture-rules.sh PATHExtract module boundaries
scripts/extract-adrs.sh PATHExtract architectural decision records
scripts/extract-github-rulesets.sh PATHExtract 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

FileContents
verification-guide.mdVerification steps, design principles
scripts-guide.mdScript options, validation checklist
ai-tool-compatibility.md16-agent compatibility matrix
output-structure.mdRoot/scoped sections
git-hooks-setup.mdHook framework detection and setup
examples/Complete examples
ai-contribution-guidelines.md"3 Cs" framework for AI contributions (Comprehension, Context, Continuity)
directory-coverage.mdFull coverage rationale for scoped AGENTS.md files

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).

See Also

  • agent-harness-skill — broader agent-readiness harness (CI verification, enforcement). Invokes this skill when AGENTS.md is missing.
  • skill-repo-skill — skill-repo structure (plugin.json, split licensing, release workflows).

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Prepares Go applications to work effectively with AI coding agents. Use when setting up a new Go project or retrofitting an existing one to ensure: structured JSON logging (slog/Zap/ZeroLog/Logrus), machine-readable command output, thorough golangci-lint configuration, non-interactive CLI design with --yes flags, structured error handling with meaningful exit codes, proper context.Context propagation, graceful shutdown, health check endpoints, and a standardized Makefile. Triggers when a user asks to make their Go app "agent-ready," "AI-friendly," wants to improve agent tooling/observability in a Go project, or needs to audit an existing Go project against agent-readiness best practices.

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

Use when designing new high-level system architecture, reviewing existing designs, or making architectural decisions. Invoke to create architecture diagrams, write Architecture Decision Records (ADRs), evaluate technology trade-offs, design component interactions, and plan for scalability. Use for system design, architecture review, microservices structuring, ADR authoring, scalability planning, and infrastructure pattern selection — distinct from code-level design patterns or database-only design tasks.

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

Use when building CLI tools, implementing argument parsing, or adding interactive prompts. Invoke for parsing flags and subcommands, displaying progress bars and spinners, generating bash/zsh/fish completion scripts, CLI design, shell completions, and cross-platform terminal applications using commander, click, typer, or cobra.

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

Convert an AWS CloudFormation stack or template to Pulumi. This skill MUST be loaded whenever a user requests migration or conversion of CloudFormation to Pulumi.

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

Analyzes code diffs and files to identify bugs, security vulnerabilities (SQL injection, XSS, insecure deserialization), code smells, N+1 queries, naming issues, and architectural concerns, then produces a structured review report with prioritized, actionable feedback. Use when reviewing pull requests, conducting code quality audits, identifying refactoring opportunities, or checking for security issues. Invoke for PR reviews, code quality checks, refactoring suggestions, review code, code quality. Complements specialized skills (security-reviewer, test-master) by providing broad-scope review across correctness, performance, maintainability, and test coverage in a single pass.

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

commit

Free

Atomic, semantic-boundary git commit workflow

The English summary is being prepared. Showing the original description.

dirien/yet-another-agent-harness20Updated May 31, 2026

See all skills by dirien

Report a problem with this skill