Skip to content

Add AGENTS.md with instructions for AI coding agents - #427

Merged
lyrixx merged 1 commit into
mainfrom
AGENTS-md
Aug 26, 2026
Merged

lyrixx merged 1 commit into
mainfrom
AGENTS-md

Conversation

@lyrixx

@lyrixx lyrixx commented Aug 26, 2026

Copy link
Copy Markdown
Member

Summary

Add an AGENTS.md file at the repository root with concise instructions for AI coding agents (Claude Code, Codex, Cursor, opencode, ...):

  • Fundamental rule: never run PHP/Node/Composer on the host, everything goes through the builder container via Castor
  • Essential Castor commands (start, stop, DB tasks, workers, ...)
  • Castor contexts, especially --context=test for tests and anything touching the database
  • QA tooling to run before considering a task done (castor qa:cs, qa:phpstan, ...)
  • Conventions: use docker_compose() helpers instead of raw docker compose, no hardcoded ports/project names because of git worktree isolation

The file is written from the perspective of a project after castor init (i.e. a real application based on this template), so it can be kept as-is when initializing new projects.

Comment thread AGENTS.md Outdated
@lyrixx
lyrixx force-pushed the AGENTS-md branch 2 times, most recently from 10f226f to 5812d48 Compare August 26, 2026 08:11
@lyrixx

lyrixx commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

okayyyy, everything should be fine!

@lyrixx
lyrixx merged commit 5a99bb9 into main Aug 26, 2026
4 checks passed
@lyrixx
lyrixx deleted the AGENTS-md branch August 26, 2026 08:40
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