프로젝트 소개
Edda는 MDX로 작성된 문서 사이트를 구축하고 게시하기 위한 명령줄 도구로, "에이전트를 위한 지식 문서"를 표방하며 병합 시 게시되는 git 네이티브 워크플로를 제공합니다. README는 이를 captain.blode.md를 포함해 자사 플랫폼의 모든 문서 사이트에 사용하는 것과 동일한 접근 방식이라고 소개합니다.
설치는 npm을 통한 전역 설치입니다: `npm install -g edda-docs`. 빠른 시작 흐름은 다음과 같습니다: `edda login`으로 브라우저에서 GitHub 인증(수동으로 관리할 API 키 없음), `edda new docs --template starter`로 디렉터리에 문서 사이트 스캐폴딩, `edda dev`로 localhost:3030에서 로컬 제공 및 편집 시 리로드, `edda push docs`로 배포. 배포된 사이트는 자체 blode.md 하위 도메인에서 라이브되며, 이름, 내비게이션, 테마는 `edda new`가 생성하는 docs.json 파일에서 가져옵니다.
명령 집합은 인증(`login`), 스캐폴딩(`new`, `minimal` 또는 `starter` 템플릿), 로컬 미리보기(`dev`), 설정 확인(`validate`), 배포(`push`), 계정 목록(`projects`), PostHog 분석 관리(`analytics`와 `get`, `set posthog <key>`, `unset posthog`)를 포함합니다.
에이전트 사용을 위해 README는 `npx skills add mblode/edda -g --all -y`를 통해 Claude Code 또는 skills.sh 호환 에이전트용 설치 가능한 슬래시 명령을 문서화하며, 이후 스캐폴딩과 배포를 자연어로 구동할 수 있습니다. 예: `/edda new my-project --template starter` 및 `/edda push docs/ --project my-project`.
CI 및 자동화 지원은 주목할 만한 초점입니다. 환경 변수로는 EDDA_API_KEY / BLODEMD_API_KEY(저장된 로그인 세션보다 우선 사용되어 CI에 대화형 로그인이 필요 없음), `--project`의 기본값인 EDDA_PROJECT / BLODEMD_PROJECT, API 오리진용 EDDA_API_URL / BLODEMD_API_URL이 있습니다. 종료 코드는 안정적이고 분기 가능하도록 문서화되어 있습니다: 0 성공, 1 오류, 2 취소(거부된 프롬프트 포함), 3 잘못된 입력 또는 설정, 4 인증 필요, 5 네트워크 실패. `--json` 사용 시 실패는 `{"error":true,"code":"AUTH_REQUIRED","message":"...","hint":"..."}` 형태의 단일 stdout 라인으로 출력되며, README는 사람을 위한 `message`가 아닌 안정적인 `code` 필드를 기준으로 분기할 것을 권장합니다.
추가 사항으로 Node.js 24가 필요하며, `push`, `validate`, `projects`가 `--json`을 받고, `push`는 비대화형 CI 배포를 위해 환경에서 프로젝트, API 키, 브랜치 값을 읽으며, 프로젝트 대시보드에서 GitHub App을 설치하면 브랜치에 푸시할 때마다 자동 배포가 가능하다고 명시되어 있습니다. 이 프로젝트는 MIT 라이선스이며 Matthew Blode가 작성했습니다.
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.