프롬프트 도감 › No.112
AGENTS.md: AI 도우미용 프로젝트 안내서
AGENTS.md Template
agents.md 공식 사이트의 예시 구조예요. Codex·Jules·Copilot·Cursor 등 20여 개 AI 도우미가 이 파일 하나를 읽어요. 아래에 카파시 원칙(No.41)을 붙이면 완성이에요.
이럴 때 프로젝트 맨 위 폴더, 여러 패키지가 든 프로젝트의 각 폴더
도구 Codex · Claude Code · Cursor · Gemini CLI
프롬프트
# AGENTS.md ## Dev environment tips - Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`. - Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint and TypeScript can see it. - Check the `name` field inside each package's package.json to confirm the right name. ## Testing instructions - Find the CI plan in the .github/workflows folder. - Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package. - From the package root you can just call `pnpm test`. The commit should pass all tests before you merge. - Fix any test or type errors until the whole suite is green. - Add or update tests for the code you change, even if nobody asked. ## PR instructions - Title format: [<project_name>] <Title> - Always run `pnpm lint` and `pnpm test` before committing.
팁
- 명령어는 꼭 우리 프로젝트 것으로 바꾸세요.
- CLAUDE.md와 내용을 같게 두거나, 한쪽을 다른 쪽의 바로가기(symlink)로 만드세요.
출처
권리: agents.md 공식 예시 구조를 옮김 (명령어는 예시).