AGENTS.md 사용자 정의 파일
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
GitLab Duo는 AI 코딩 어시스턴트에 컨텍스트와 지침을 제공하기 위한 새로운 표준인 AGENTS.md 사양을 지원합니다. AGENTS.md 파일을 사용하여 저장소 구조, 코딩 규칙, 스타일 가이드라인, 빌드 및 테스트 지침, 프로젝트 컨텍스트를 문서화합니다.
히스토리
GitLab Duo는 AI 코딩 어시스턴트에 컨텍스트와 지침을 제공하기 위한 새로운 표준인 AGENTS.md 사양을 지원합니다.
AGENTS.md 파일을 사용하여 저장소 구조, 코딩 규칙, 스타일 가이드라인, 빌드 및 테스트 지침, 프로젝트 컨텍스트를 문서화합니다. AGENTS.md 파일을 지정하면 이러한 세부 정보가 GitLab Duo Agent Platform과 사양을 지원하는 다른 AI 도구에서 사용할 수 있게 됩니다.
GitLab Duo가 사용할 AGENTS.md 파일을 지정합니다:
- GitLab UI 및 로컬 환경의 GitLab Duo Chat.
- Code Review Flow를 제외한 기본 및 사용자 정의 플로우.
GitLab Duo가 AGENTS.md 파일을 사용하는 방법#
GitLab Duo 사용 방식에 따라 여러 수준에서 AGENTS.md 파일을 만들 수 있습니다:
| 수준 | GitLab UI | 에디터 확장 | GitLab Duo CLI |
|---|---|---|---|
| 사용자 수준: 모든 프로젝트에 적용 | 아니오 | 가능 | 가능 |
| 프로젝트 수준: 특정 프로젝트에만 적용 | 가능 | 가능 | 가능 |
| 하위 디렉토리 수준: 모노리포 또는 뚜렷한 구성 요소가 있는 프로젝트의 특정 부분에만 적용 | 아니오 | 가능 | 가능 |
IDE에서 다중 루트 작업 공간을 사용하는 경우 작업 공간의 각 프로젝트에 대한 프로젝트 수준 AGENTS.md 파일을 만들 수 있습니다.
GitLab Duo는 모든 대화에 대해 사용자 수준 및 프로젝트 수준 AGENTS.md 파일의 지침을 결합합니다. 작업에 추가 AGENTS.md 파일이 포함된 디렉토리의 파일 작업이 필요한 경우 Chat은 해당 지침도 적용합니다.
GitLab Duo와 함께 AGENTS.md 사용#
AGENTS.md 파일을 추가하거나 업데이트한 후에 만들어진 새 대화와 플로우만 새 지침을 따릅니다. 이전에 존재하는 대화는 따르지 않습니다.
전제 조건#
-
Agent Platform 전제 조건을 충족합니다.
-
로컬 환경의 GitLab Duo Chat의 경우 다음 중 하나를 설치하고 구성합니다:
- GitLab for VS Code 6.60 이상.
- JetBrains IDEs용 GitLab Duo 플러그인 3.26.0 이상.
- GitLab Duo CLI 8.47.0 이상.
-
사용자 정의 플로우의 경우 실행기에서 전달된
user_rule컨텍스트에 액세스하도록 플로우의 구성 파일을 업데이트합니다:components: - name: "my_agent" type: AgentComponent prompt_id: "my_prompt" inputs: - from: "context:inputs.user_rule" as: "agents_dot_md" optional: trueoptional: true를 설정하면AGENTS.md파일이 없는 경우 플로우가 원활하게 처리됩니다. 에이전트는 추가 컨텍스트가 있거나 없어도 작동합니다.
사용자 수준 AGENTS.md 파일 만들기#
사용자 수준 AGENTS.md 파일은 모든 프로젝트에 적용됩니다.
-
홈 디렉토리에
AGENTS.md파일을 만듭니다:- Linux 또는 macOS에서는
~/.gitlab/duo/AGENTS.md에 파일을 만듭니다. - Windows에서는
%APPDATA%\GitLab\duo\AGENTS.md에 파일을 만듭니다.
- Linux 또는 macOS에서는
-
파일에 지침을 추가합니다. 예를 들어:
# My personal coding preferences - Always explain code changes in simple terms for beginners - Use descriptive variable names - Add comments for complex logic - Prefer functional programming patterns when appropriate# Team coding standards - Follow our company's style guide for all code - Use TypeScript strict mode - Write unit tests for all new functions - Document all public APIs with JSDoc# Monorepo context - This is a monorepo with multiple services - Frontend code is in /apps/web - Backend services are in /services - Shared libraries are in /packages - Follow the architecture decision records in /docs/adr# Security review guidelines - Always validate user input - Use parameterized queries for database operations - Implement proper authentication and authorization - Follow OWASP security best practices - Never log sensitive information- 파일을 저장합니다.
- 지침을 적용하려면 새 대화 또는 플로우를 시작합니다.
AGENTS.md파일을 변경할 때마다 이 작업을 수행해야 합니다.
특정 환경 변수를 설정한 경우 다른 위치에
AGENTS.md파일을 만들 수 있습니다:GLAB_CONFIG_DIR환경 변수를 설정한 경우$GLAB_CONFIG_DIR/AGENTS.md에 파일을 만듭니다.XDG_CONFIG_HOME환경 변수를 설정한 경우$XDG_CONFIG_HOME/gitlab/duo/AGENTS.md에 파일을 만듭니다.
프로젝트 수준
AGENTS.md파일 만들기#프로젝트 수준
AGENTS.md파일은 특정 프로젝트에만 적용됩니다.-
프로젝트 루트에
AGENTS.md파일을 만듭니다. -
파일에 지침을 추가합니다. 예를 들어:
# Project-specific guidelines - This project uses React with TypeScript - Follow the component structure in /src/components - Use our custom hooks from /src/hooks - State management uses Redux Toolkit -
파일을 저장합니다.
-
지침을 적용하려면 새 대화 또는 플로우를 시작합니다.
AGENTS.md파일을 변경할 때마다 이 작업을 수행해야 합니다.
모노리포 및 하위 디렉토리에
AGENTS.md파일 만들기#모노리포 또는 뚜렷한 구성 요소가 있는 프로젝트의 경우 하위 디렉토리에
AGENTS.md파일을 배치하여 코드베이스의 다른 부분에 대한 컨텍스트별 지침을 제공할 수 있습니다.GitLab Duo Chat이 하위 디렉토리에서 추가
AGENTS.md파일을 발견하면 해당 디렉토리의 파일을 편집하기 전에 관련 파일을 읽습니다. 예를 들어:/my-project AGENTS.md # 루트 지침 (모든 대화에 포함됨) /frontend AGENTS.md # 프론트엔드 특정 지침 /backend AGENTS.md # 백엔드 특정 지침이 예시에서:
- 루트
AGENTS.md는 항상 대화에 포함됩니다. - GitLab Duo가
/frontend의 파일을 편집하면 먼저/frontend/AGENTS.md를 읽습니다. - GitLab Duo가
/backend의 파일을 편집하면 먼저/backend/AGENTS.md를 읽습니다.
이 접근 방식은 GitLab Duo가 프로젝트의 각 부분에 적합한 규칙을 따르도록 합니다.
하위 디렉토리에서
AGENTS.md를 사용하려면:-
프로젝트의 하위 디렉토리에
AGENTS.md파일을 만듭니다. -
해당 디렉토리에 특정한 지침을 추가합니다. 예를 들어 백엔드 서비스의 경우:
# Backend service guidelines - This service uses Node.js with Express - Follow RESTful API conventions - Use async/await for asynchronous operations - Validate all inputs with Joi schemas -
파일을 저장합니다.
-
지침을 적용하려면 해당 디렉토리의 파일과 관련된 새 대화를 시작합니다.
AGENTS.md파일을 변경할 때마다 이 작업을 수행해야 합니다.
관련 주제#
