Getting Started5분 Quickstart

5분 Quickstart

이 가이드는 lore init 부터 첫 .lore/flows/<카테고리>.md 가 생성되는 시점까지를 다룹니다. 평균 60~90초.

CLI 설치

npm i -g lore-ai

프로젝트 초기화

cd my-project
lore init

생성되는 것:

  • lore.config.yaml — 프로젝트·도메인 정의
  • .lore/flows/ — L2 카테고리 마크다운이 들어갈 자리
  • .lore/DOMAIN_MAP.md — L1 도메인 지도
💡

서버와 앱이 별도 저장소로 분리되어 있다면, lore init 을 어느 쪽에 할지 / 두 번 할지가 셋업의 핵심입니다. → Multi-repo 가이드

도메인 부트스트랩

코드베이스에서 evidence 를 자동 수집하고, AI 로 도메인 맵 초안을 만듭니다.

lore bootstrap | pbcopy   # macOS — 프롬프트가 클립보드로
# 또는
lore bootstrap > prompt.md

생성된 프롬프트를 Claude Code / Cursor 에 붙여넣으면 두 파일의 수정안 (diff) 을 응답으로 돌려줍니다:

  • lore.config.yaml 의 domains: 블록 (영문 key + 한국어 label)
  • .lore/DOMAIN_MAP.md (도메인 한 줄 설명 + subdomain 목록)
⚠️

AI 응답은 제안일 뿐입니다. 프롬프트가 자동으로 파일을 고치지 않습니다. Claude Code 라면 응답 받은 직후 “위 diff 를 실제로 두 파일에 적용해줘” 라고 한 번 더 시켜서 AI 가 직접 파일을 수정 하도록 하세요. Cursor 도 동일.

완료 후 반드시 두 파일의 변경 사항을 육안으로 확인:

git diff lore.config.yaml .lore/DOMAIN_MAP.md
cat lore.config.yaml | head -30          # domains: 블록이 채워졌는지
cat .lore/DOMAIN_MAP.md                  # 카테고리 한 줄 설명이 들어왔는지

그 다음 lore check 가 ✓ 로 떨어지는지로 1차 검증.

자세한 옵션 (--heuristic-only, --out, --apply 예정) 과 동작 원리 → CLI: bootstrap.

💡

AI 없이 빠른 초안만 원하면 lore bootstrap --heuristic-only 로 폴더 구조에서 도메인 후보를 정적 추출. 한국어 label 과 subdomain 정제는 사람이.

코드에 주석 작성

class Subscription(models.Model):
    """
    @Domain: subscription/master
    @BusinessLogic: valid_until 지나면 is_active=False
    @History:
      - 2024-03-15: trial 7일 → 14일
    """

검증

lore check                           # 전체 스캔 (모든 configured projects)
# 또는 특정 파일만:
# lore check apps/auth/views.py

precommit 훅은 변경된 파일만 검증하도록 lore check $(git diff --cached --name-only) 형태로 사용. hooks 가이드 참조.

Sync

lore sync

.lore/draft/auth.md, subscription.md (raw L3 사실) + .lore/flows/INDEX.md (카테고리 진입점) 이 생성됩니다.

Synthesize → Review

lore synthesize             # L3 → L2 보고서 (.lore/flows/<cat>.md)
lore review auth            # 보고서 깊이 보강 (선택)

synthesize 는 9섹션 보고서를 만들고, review 는 코드 발췌·WHY 사유·forensics 를 보강합니다 → 3-layer 구조.

다음

설치첫 sync 결과 읽기