lostvibe 0.0.0-stage → 0.8.0

package/README.md

@@ -1,3 +1,73 @@
-# Temporary Holding Version
+# lostvibe
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Lost Vibe Society](https://lostvibesociety.com)에 내 프로젝트를 심는 CLI.
+AI 코딩 도구(Claude Code, Codex 등)의 로컬 로그와 git에서 **날짜별 합계 숫자**만 읽어 올린다.
+
+## 보내는 것과 안 보내는 것
+
+- 보낸다: 날짜·도구·모델별 토큰 합계, 커밋 수, 프로젝트 이름과 설명(사이트에서 직접 쓴 것).
+- 안 보낸다: 소스 코드, 대화 내용, 응답별 기록, 비밀값.
+- 받는 곳은 `https://lostvibesociety.com` 하나뿐이다.
+- 공개 여부와 공개 항목은 사이트에서 사람이 직접 고른다. CLI는 공개를 바꿀 수 없다.
+
+## 쓰는 법
+
+사이트 You 탭에서 **AI로 가져오기**를 누르면 AI에게 붙여 넣을 지시문이 복사된다.
+AI가 아래 명령을 대신 실행한다.
+
+```
+npx -y lostvibe@0.8.0 setup --token <사이트에서 받은 토큰>
+npx -y lostvibe@0.8.0 draft --file .lostvibe/project.json
+npx -y lostvibe@0.8.0 sync
+```
+
+여러 프로젝트를 한 번에 가져올 때:
+
+```
+lostvibe scan --all --json                    # 목록(JSON)만 출력. 고를 때 쓴다
+lostvibe setup                                # setup:"folder" 인 프로젝트: 그 폴더에서 (git 없어도 된다)
+lostvibe setup --source <id>                  # setup:"source" 인 프로젝트: 로그만 남은 것, 어느 폴더에서나
+lostvibe setup --merge <id>[,<id>]            # 같은 프로젝트의 다른 폴더 기록을 합친다 (주 프로젝트 폴더에서)
+lostvibe draft --file .lostvibe/project.json --of <N>          # N: 이번에 가져오는 프로젝트 수 (1~200)
+lostvibe draft --file project.json --project <프로젝트 id> --of <N>   # 폴더 없는 프로젝트
+```
+
+`scan --all --json` 출력: `{"projects":[{"n","id","name","tokens","last","path","exists","git","setup","url"}]}`.
+경로가 들어간 전체 목록은 `~/.lostvibe/scan-all.json`(권한 600)에만 저장되고 보내지 않는다.
+
+토큰은 비밀이다. 화면·코드·저장소 어디에도 남기지 않는다.
+
+## 자동 갱신 훅
+
+`hooks install`은 Claude Code와 Codex에 `Stop`, `SessionEnd` 훅을 넣는다. 다른 훅은 건드리지 않고,
+예전 버전이 넣은 Lost Vibe 훅은 찾아서 바꾼다. 훅은 항상 `~/.lostvibe/runtime/current`를 실행하므로
+버전을 올려도 명령이 같아서 Codex를 다시 승인할 필요가 없다. `Stop`은 프로젝트마다 10분에 한 번만 동기화한다.
+
+`hooks status`는 클라이언트마다 `미설치` / `설치됨·승인 전` / `승인됨·실행 기록 없음` / `실행됨`을 보여 준다.
+Claude Code는 승인이 필요 없다. Codex는 Codex CLI에서 `/hooks`를 열고 Lost Vibe 항목 2개를 Trust 해야 한다.
+
+## 명령
+
+```
+lostvibe scan [폴더]             폴더 하나를 읽어 그 폴더에 lostvibe.json 저장
+lostvibe scan --all [--json]     로그 전체에서 내 프로젝트를 전부 찾아 표(또는 JSON)로 출력
+lostvibe setup [--no-hooks]      현재 폴더의 프로젝트만 비공개로 등록하고 이 컴퓨터와 연결
+lostvibe setup --source ID       폴더 없이 로그만 남은 프로젝트를 등록
+lostvibe setup --merge ID[,ID]   scan --all 의 다른 프로젝트를 이 프로젝트에 합친다
+lostvibe draft --file F [--of N] [--project ID]
+                                 AI가 만든 JSON을 검토할 초안으로 보낸다
+lostvibe sync                    등록한 프로젝트의 바뀐 기록만 올린다
+lostvibe hooks install           기존 훅을 보존하며 자동 갱신 연결
+lostvibe hooks status            설치·승인·실행 상태 확인
+lostvibe hooks remove            Lostvibe가 추가한 항목만 제거
+lostvibe collector add --project ID --slot result --command-json '[...]' [--cwd 폴더]
+                                 성과 조회 명령 등록 (--cwd 는 프로젝트 폴더 안)
+lostvibe collector test --command-json '[...]' [--cwd 폴더]
+                                 보내지 않고 실행만 해서 "값: N (날짜)" 또는 실패 종류를 보여 준다
+lostvibe collect                 연결한 성과를 읽어 갱신
+```
+
+`collector test` 실패 종류: 환경 변수 없음 / 모듈을 찾지 못함 / 테이블 없음 / DB 연결 실패 / JSON 형식 오류 / 시간 초과 / 알 수 없는 오류.
+명령의 출력과 오류 내용은 화면에 내보내지 않는다.
+
+Node 22.15 이상. MIT.