name	create-agents-md
description	Create AGENTS.md files for project-specific inline rules. Use when adding small, project-specific instructions that should be committed in repos.

Create AGENTS.md

Guide for creating AGENTS.md files for project-specific inline rules.

When to Use AGENTS.md

Small, project-specific instructions that should be committed in the repo
Folder-scoped rules for specific directories
Package-specific instructions in monorepos
Test-specific guidance in test directories

When NOT to Use AGENTS.md

Reusable knowledge across projects → Use skills
Large documentation → Use skills with references
Complex workflows → Use skills with scripts

AGENTS.md Structure

AGENTS.md is a simple markdown file without metadata:

# Project Instructions

## Code Style

- Use TypeScript for all new files
- Prefer functional components in React
- Use snake_case for database columns

## Architecture

- Follow the repository pattern
- Keep business logic in service layers

Location

Project root: AGENTS.md – Primary, inline instructions and references for the whole project (commands, tech stack, testing, code style, architecture, safety boundaries).
Subdirectories: subdirectory/AGENTS.md – Folder- or package-scoped instructions when local behavior meaningfully diverges from the root (e.g., a specific package, service, or test tree).
Nested support: Agents typically combine instructions from the closest AGENTS.md with parent ones; keep root general and use nested AGENTS.md only where you truly need more specific rules.

Best Practices

Keep AGENTS.md files small and focused
Use for project-specific conventions
Prefer short, concrete references over long prose:
- Link to project docs, specs, and runbooks
- Point to example files or directories (e.g., see src/api/users.ts for canonical pattern)
- Include the most important commands with exact CLI invocations
Reference existing code examples when possible
Update as project evolves

References

For detailed best practices, see references/best-practices.md.

Mehr aus diesem Repository

gleiches Repository

semantic-git

siviter-xyz/dot-agent

Manage Git commits using conventional commit format with atomic staging. Always generate plain git commands before running them and offer to let the user run them manually.

2026-02-0519

media-processing

siviter-xyz/dot-agent

Media processing utilities for images, audio, and video using FFmpeg and ImageMagick. Use when working with media conversion, optimization, or batch processing tasks.

2026-02-0519

software-engineer

siviter-xyz/dot-agent

Core software engineering principles for code style, documentation, and development workflow. Applies when editing code, working in software repositories, or performing software development tasks.

2026-02-0519

python

siviter-xyz/dot-agent

Python development guidelines and best practices. Use when working with Python code.

2026-01-1919

backend-engineer

siviter-xyz/dot-agent

Build robust backend systems with modern technologies (Node.js, Python, Go, Rust), frameworks (NestJS, FastAPI, Django), databases (PostgreSQL, MongoDB, Redis), APIs (REST, GraphQL, gRPC), authentication (OAuth 2.1, JWT), testing strategies, security best practices (OWASP Top 10), performance optimization, scalability patterns (microservices, caching, sharding), DevOps practices (Docker, Kubernetes, CI/CD), and monitoring. Use when designing APIs, implementing authentication, optimizing database queries, setting up CI/CD pipelines, handling security vulnerabilities, building microservices, or developing production-ready backend systems.

2026-01-1819

cli-building

siviter-xyz/dot-agent

Build command-line interfaces with async-first design, composable commands, and proper output formatting. Use when creating CLI tools, commands, or interactive terminal applications.

2026-01-1819

Create AGENTS.md

Guide for creating AGENTS.md files for project-specific inline rules.

When to Use AGENTS.md

Small, project-specific instructions that should be committed in the repo

Folder-scoped rules for specific directories

Package-specific instructions in monorepos

Test-specific guidance in test directories

When NOT to Use AGENTS.md

Reusable knowledge across projects → Use skills

Large documentation → Use skills with references

Complex workflows → Use skills with scripts

AGENTS.md Structure

AGENTS.md is a simple markdown file without metadata:

# Project Instructions ## Code Style - Use TypeScript for all new files - Prefer functional components in React - Use snake_case for database columns ## Architecture - Follow the repository pattern - Keep business logic in service layers

Location

Project root: AGENTS.md – Primary, inline instructions and references for the whole project (commands, tech stack, testing, code style, architecture, safety boundaries).

Subdirectories: subdirectory/AGENTS.md – Folder- or package-scoped instructions when local behavior meaningfully diverges from the root (e.g., a specific package, service, or test tree).

Nested support: Agents typically combine instructions from the closest AGENTS.md with parent ones; keep root general and use nested AGENTS.md only where you truly need more specific rules.

Best Practices

Keep AGENTS.md files small and focused

Use for project-specific conventions

Prefer short, concrete references over long prose:

Link to project docs, specs, and runbooks
Point to example files or directories (e.g., see src/api/users.ts for canonical pattern)
Include the most important commands with exact CLI invocations

Reference existing code examples when possible

Update as project evolves

References

For detailed best practices, see references/best-practices.md.