Frontmatter 스키마
YAML frontmatter 블록 구조, 클래스별 필수 키, 그리고 제품 클래스 전반의 검증기 시행 규칙에 대한 참조 가이드.
모든 제품 클래스의 YAML frontmatter에 대한 정규 참조.
CLAUDE.md규약의 요약은 인라인 선언입니다.schemas/의 클래스별 JSON Schema는 기계 판독 가능한 계약입니다. 이 페이지는 하류 기여자가 인용하는 독립 참조입니다.
1. Frontmatter 블록 구조
각 제품은 머리에 YAML frontmatter를 가지며 --- 줄로 구분됩니다. site/content/docs/reference/authorship-header.mdx에 따른 정규 작성자 헤더 배너는 Markdown 계열 파일에서 frontmatter 위에 위치하며, frontmatter는 그 바로 다음에 옵니다.
키는 kebab-case를 사용합니다. 스칼라 값은 그대로 쓰거나 큰따옴표로 묶습니다. 콜론, 해시 기호, 기타 YAML에서 의미 있는 문자를 포함하는 문자열 값은 따옴표로 묶습니다.
2. 클래스별 필수 필드
필수 키 집합은 제품 클래스에 따라 다릅니다. 권위 있는 구조는 scripts/dev/validate_ecosystem.py와 schemas/ 디렉터리 아래의 클래스별 JSON Schema(제품 클래스당 하나의 스키마 파일)에 의해 시행됩니다.
schemas/agent.schema.json
schemas/skill.schema.json
schemas/command.schema.json
schemas/output-style.schema.json
schemas/plan.schema.json| 클래스 | 필수 키 |
|---|---|
CLAUDE.md(루트 구성) | name, version, updated, description, scope, portability |
규칙(src/apothem/rules/*.md) | name, description, pathFilter, alwaysApply |
명령(src/apothem/commands/*.md) | name, version, updated, description, argument-hint, disable-model-invocation |
| 어시스턴트(아래 표시된 정규 디렉터리) | name, version, updated, description, tools, disallowedTools, maxTurns, effort |
스킬(src/apothem/skills/*/SKILL.md) | name, description, archetype, userInvocable |
schemas/의 클래스별 스키마는 타입, 형식, enum, 패턴 제약을 포함한 전체 제약 집합을 담습니다.
3. 검증기
scripts/dev/validate_ecosystem.py는 제품 트리를 순회하며 위의 필수 키 집합을 적용하고, 필수 필드가 누락된 모든 제품에 대해 [FAIL]을 보고합니다. src/apothem/conformity/frontmatter_grep.py의 쓰기별 frontmatter-grep은 PreToolUse Write/Edit 훅 경계에서 동일한 구조를 시행합니다.