dzhokhov/markdown-agent-vault

markdown-agent-vault은(는) 무엇을 하나요?

에이전트 지원 마크다운 저장소를 위한 English-first 스타터 키트로, AGENTS.md, 템플릿, 로그 및 파일 안전 AI 워크플로우를 제공합니다.

개요

dzhokhov/markdown-agent-vault는 AI 에이전트(Claude Code, Cursor, Codex 등)가 마크다운 파일을 안전하게 읽고 쓸 수 있도록 설계된 저장소(vault) 구조를 제공합니다. 이 스타터 키트는 AGENTS.md 파일을 통해 에이전트의 역할과 제약 조건을 정의하고, templates/ 디렉토리로 작업 템플릿을, logs/ 디렉토리로 작업 기록을 관리합니다.

주요 기능

• AGENTS.md: 에이전트의 행동 규칙, 허용/금지 작업, 파일 처리 정책 정의
• Templates: 표준화된 작업 템플릿 (예: 작업 계획, 리뷰, 문서화)
• Logs: 에이전트 작업 로그를 구조화하여 추적 가능
• File-safe 워크플로우: 동시 쓰기 방지, 롤백 지원, 파일 무결성 검사

시작하기

# 저장소 복제
git clone https://github.com/dzhokhov/markdown-agent-vault.git
cd markdown-agent-vault

# 에이전트 초기화 (예: Claude Code)
claude code --init

디렉토리 구조

.
├── AGENTS.md          # 에이전트 설정 파일 (필수)
├── templates/         # 작업 템플릿
│   ├── task.md        # 기본 작업 템플릿
│   ├── review.md      # 리뷰 템플릿
│   └── log.md         # 로그 템플릿
├── logs/              # 에이전트 작업 로그
│   └── session-*.md   # 세션별 로그 파일
├── docs/              # 문서 저장소 (선택 사항)
└── README.md          # 프로젝트 설명

AGENTS.md 설정

AGENTS.md 파일은 에이전트에게 저장소의 규칙과 기대 사항을 알려줍니다. 예:

# 에이전트 규칙

- **파일 안전**: 동일 파일에 동시 쓰기 금지.
- **로깅**: 모든 수정 사항을 logs/ 디렉토리에 기록.
- **템플릿 사용**: 작업 생성 시 templates/에서 템플릿 참조.

사용 예시

1. 작업 계획: templates/task.md를 복사하여 새 작업 파일을 생성합니다.
2. 로그 기록: 작업 완료 후 logs/session-<날짜>.md에 요약을 저장합니다.
3. 에이전트 호출: Claude Code에서 @vault 명령어로 저장소 내용을 참조합니다.

지원 플랫폼

• Claude Code (claude code)
• Cursor (cursor)
• Codex (codex)
• 기타 마크다운 기반 AI 에이전트

라이선스

MIT

기여하기

버그 제보나 기능 제안은 GitHub Issues를 통해 해주세요.