@litfamily/litcodex 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/README-Ko-KR.md +207 -0
  2. package/README.md +155 -576
  3. package/dist/install/doctor-render.js +1 -0
  4. package/dist/install/doctor.js +8 -0
  5. package/dist/install/generated-skill-payload-hashes.d.ts +2 -2
  6. package/dist/install/generated-skill-payload-hashes.js +2 -2
  7. package/dist/install/types.d.ts +3 -0
  8. package/marketplace/plugins/litcodex/.codex-plugin/plugin.json +1 -1
  9. package/marketplace/plugins/litcodex/components/auto-update/package.json +1 -1
  10. package/marketplace/plugins/litcodex/components/comment-checker/package.json +1 -1
  11. package/marketplace/plugins/litcodex/components/git-bash/package.json +1 -1
  12. package/marketplace/plugins/litcodex/components/lit-loop/dist/hook-cli.d.ts +8 -1
  13. package/marketplace/plugins/litcodex/components/lit-loop/dist/hook-cli.js +36 -4
  14. package/marketplace/plugins/litcodex/components/lit-loop/dist/jev-hint.d.ts +123 -0
  15. package/marketplace/plugins/litcodex/components/lit-loop/dist/jev-hint.js +553 -0
  16. package/marketplace/plugins/litcodex/components/lit-loop/package.json +1 -1
  17. package/marketplace/plugins/litcodex/components/lsp/package.json +1 -1
  18. package/marketplace/plugins/litcodex/components/rules/package.json +1 -1
  19. package/marketplace/plugins/litcodex/components/start-work-continuation/package.json +1 -1
  20. package/marketplace/plugins/litcodex/components/telemetry/package.json +1 -1
  21. package/marketplace/plugins/litcodex/components/wikify-knowledge/package.json +1 -1
  22. package/marketplace/plugins/litcodex/skills/lit-pptx/scripts/office-run.mjs +7 -1
  23. package/marketplace/plugins/litcodex/skills/lit-typographic-motion/engine/runtime.mjs +5 -1
  24. package/node_modules/@litcodex/lit-loop/dist/hook-cli.d.ts +8 -1
  25. package/node_modules/@litcodex/lit-loop/dist/hook-cli.js +36 -4
  26. package/node_modules/@litcodex/lit-loop/dist/jev-hint.d.ts +123 -0
  27. package/node_modules/@litcodex/lit-loop/dist/jev-hint.js +553 -0
  28. package/node_modules/@litcodex/lit-loop/package.json +1 -1
  29. package/package.json +4 -3
  30. package/readme-assets/badge-version.svg +1 -1
@@ -0,0 +1,207 @@
1
+ <p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/cover-motion-still.webp" /><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/cover-motion.webp" width="100%" alt="LitFamily 모션 커버: 다섯 로봇 패널이 차례로 켜지고, LitCodex 로봇의 눈과 테두리가 빛난 뒤 LITFAMILY와 KEEP THE WORK LIT. 문구가 밝아지는 영상" /></picture></p>
2
+
3
+ <p align="center">
4
+ <a href="#설치"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/badge-version.svg" alt="1.0.9" /></a>
5
+ <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/badge-license.svg" alt="MIT license" /></a>
6
+ </p>
7
+
8
+ <p align="center">
9
+ <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage-Ko-KR.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/lucide-book-open.svg" width="16" alt="" /> 문서</a> &nbsp; <a href="#설치">설치</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/lucide-play.svg" width="16" alt="" /> Ignition</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.9/readme-assets/lucide-shield-check.svg" width="16" alt="" /> MIT</a>
10
+ </p>
11
+
12
+ # LitCodex
13
+
14
+ **Keep the work lit.**
15
+
16
+ LitCodex는 Codex CLI 플러그인입니다. 계획, 검토, 조사와 오래 이어지는 실행 루프를 더해서, 한 번 시작한
17
+ 작업이 대화가 끝난 뒤에도 이어지게 합니다. 요청에 `lit`을 붙이면 목표와 확인 기준, 결과가 프로젝트에 남고,
18
+ 다음 세션에 그 기록을 읽게 해서 이어갈 수 있습니다.
19
+
20
+ **[전체 안내, 스킬 갤러리, A/B 결과는 GitHub에서](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md)** · [English](https://github.com/wjgoarxiv/litcodex#readme)
21
+
22
+ ## 설치
23
+
24
+ Node.js 22 이상과 Codex CLI가 필요합니다.
25
+
26
+ ```sh
27
+ npm exec --yes --package @litfamily/litcodex@1.0.9 -- litcodex install
28
+ ```
29
+
30
+ 설치기는 플러그인·훅·에이전트를 등록하고 `~/.codex/config.toml`에서 자신이 관리하는 항목만 갱신합니다.
31
+ 설치 중에 리드 모델, 헬퍼 모델, 출력 스타일을 묻고, 새로 설치하면 리드는 `gpt-6-astra`/`xhigh`, 헬퍼는
32
+ `gpt-6-luna`/`max`가 기본값입니다. 미리 보려면
33
+ `npm exec --yes --package @litfamily/litcodex@1.0.9 -- litcodex --dry-run install`을 실행하고, 묻는 단계 없이
34
+ 설치하려면 `install` 뒤에 `--yes`를 붙이세요.
35
+
36
+ 전역 명령으로 쓰려면 다음을 실행합니다.
37
+
38
+ ```sh
39
+ npm install -g @litfamily/litcodex
40
+ litcodex install
41
+ ```
42
+
43
+ 전역 설치는 postinstall 스크립트를 실행합니다. `CI`가 설정되지 않았으면 짧은 환영 문구를 보여 준 뒤
44
+ `lit-typographic-motion`용 런타임을 `${XDG_CACHE_HOME:-~/.cache}/litcodex/motion-runtime/`에 미리 준비해
45
+ 봅니다. 이 과정은 네트워크를 씁니다. 고정된 npm 패키지는 레지스트리에서, 고정된 글꼴·라이선스 파일은
46
+ GitHub와 apache.org에서 받고, 브라우저는 내려받지 않습니다. 끝나지 않아도 패키지는 설치된 채로 남으며
47
+ `litcodex motion-runtime install`로 다시 시도할 수 있습니다. 건너뛰려면 `--ignore-scripts`를 붙이거나
48
+ `CI=1`을 설정하세요. `litcodex install`도 같은 준비 과정을 실행하며, 이를 끄는 옵션은 없습니다.
49
+
50
+ > 전역 설치가 없다면 `npm exec --yes --package @litfamily/litcodex@1.0.9 -- litcodex <command>` 형식을 사용하세요.
51
+
52
+ 기존 설정과 떼어 놓고 써 보려면
53
+ [격리된 체험 안내](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md#isolated-local-trial)를
54
+ 따르세요. `CODEX_HOME`만 바꿔서는 부족합니다. Windows에서도 설치기와 CLI shim은 동작하지만, POSIX가 필요한 Python
55
+ 경로는 `BLOCKED_UNSUPPORTED_PYTHON_POSIX_RUNTIME`으로 멈춥니다.
56
+
57
+ ## 첫 작업
58
+
59
+ 프로젝트에서 Codex를 열고, 시작 검토에서 LitCodex 훅을 승인한 뒤 다음을 입력하세요.
60
+
61
+ ```text
62
+ lit 회원가입 폼에 입력 검증을 추가해줘
63
+ ```
64
+
65
+ 답변은 `🔥 **LIT IGNITED · <discipline>** 🔥` 한 줄로 시작합니다. 이 표시는 요청이 제 경로로 들어갔다는
66
+ 뜻일 뿐입니다. 목표는 성공 기준을 모두 통과해야 완료되고, 기록은 프로젝트의 `.litcodex/lit-loop/` 아래에 남습니다.
67
+
68
+ 직접 판단할 수 있는 첫 작업이 필요하다면 빈 폴더에서 이렇게 시작해 보세요.
69
+
70
+ ```text
71
+ lit 현재 폴더에 HTML 파일 하나로 할 일 목록을 만들어줘. 외부 의존성은 설치하지 마.
72
+ 할 일 추가와 완료 처리를 확인하고, 확인하지 못한 부분은 따로 남겨줘.
73
+ ```
74
+
75
+ 끝나면 결과물, 실제로 돌린 확인, 아직 남은 일을 살펴보세요. `lit recap`은 기록된 상태를 다시 읽어 주고,
76
+ 세션을 마치기 전에 `handoff`만 따로 보내 두면 다음 세션이 거기서 시작할 수 있습니다.
77
+
78
+ ## 자주 쓰는 경로
79
+
80
+ | 입력 | 하는 일 |
81
+ | --- | --- |
82
+ | `lit` | 프로젝트에 목표와 확인 기준을 남기며 범위가 정해진 작업을 시작합니다. |
83
+ | `handoff` 또는 `/lit-handoff` | 확인한 결과와 다음 할 일을 다음 세션으로 넘깁니다. |
84
+ | `lit-plan` | 무엇이든 고치기 전에 계획과 성공 기준부터 씁니다. |
85
+ | `lit start work <승인된 계획>` | 승인한 계획을 실행합니다. |
86
+ | `review-work` | 변경과 그 근거를 검토합니다. |
87
+ | `litresearch` | 출처를 달아 조사하고, 아직 불확실한 부분을 따로 적어 둡니다. |
88
+
89
+ 다른 문구 없이 `handoff`만 보내면 인수인계 문서를 만듭니다. `lit-scientific-visualization`만 단독으로 입력하면
90
+ 훅이 시각화 어댑터를 불러오며, Python 의존성을 설치하지는 않습니다.
91
+
92
+ ## 패키지에 들어 있는 스킬
93
+
94
+ 아래 스킬은 Codex skill picker에서 고를 수 있고, `$litcodex:lit-humanizer`, `$litcodex:lit-fetch`,
95
+ `$litcodex:lit-handoff`, `$litcodex:lit-scientific-visualization`처럼 `$litcodex:` 접두어를 붙인 이름으로 불러도 됩니다. 스킬마다 그림을
96
+ 곁들인 설명은 GitHub에 있습니다.
97
+
98
+ **작업을 계획하고 실행하기**
99
+
100
+ - `lit-loop`(`lit`): 오래 이어지는 루프 안에서 일하고, 확인하지 못한 것은 그대로 기록합니다.
101
+ - `litwork`: 처음부터 끝까지 꼼꼼한 구현이나 수정입니다. 실패하는 테스트 먼저, 그다음 실제 화면에서 증명합니다.
102
+ - `lit-plan`: `.litcodex/plans/`에 번호 붙은 승인 계획을 만듭니다. 계획만 세웁니다.
103
+ - Start Work(`lit start work <승인된 계획>`): 승인된 계획을 다섯 관문으로 실행합니다.
104
+ - `litgoal`: 관찰 가능한 기준을 붙인 목표 하나를 루프에 묶습니다.
105
+ - `deep-interview`: 만들 수 있을 만큼 분명해질 때까지 한 번에 한 질문씩 묻습니다.
106
+ - `lit-crucible`: 계획 전에 요구사항을 반박해 보고, 반박을 견딘 위험만 계획으로 넘깁니다.
107
+ - `lit-team`: 여러 작업자에게 겹치지 않는 몫을 나누고, 각자 증거와 함께 보고하게 합니다.
108
+ - `lit-recap`, `lit-handoff`: 지금 상태를 읽기 전용으로 요약하고, 다음 세션이 이어받을 파일을 만듭니다.
109
+
110
+ **검토, 조사, 지식**
111
+
112
+ - `review-work`: 막는 힘이 있는 리뷰 다섯 갈래입니다. 하나라도 실패하면 승인되지 않습니다.
113
+ - `litresearch`: 조사를 요청할 때만 움직이며, 여러 갈래로 증거를 모아 출처와 함께 종합합니다.
114
+ - `autoresearch`: 승인된 예산 안에서 실험을 반복합니다.
115
+ - `autoconference`: 예산을 정해 두고 연구 회의를 엽니다.
116
+ - `lit-fetch`: 보통 방법으로 부족할 때 주소·DNS·본문 안전 검사를 거쳐 공개 페이지를 읽습니다.
117
+ - `wikify`: 검토를 거친 프로젝트 지식을 디스크에 두고, 나중 질문에 출처와 함께 답합니다.
118
+ - `coding-session-audit`: 지난 Codex 세션을 기록으로 읽고 어디서 멈췄는지 보여 줍니다.
119
+ - `lit-comprehend`: 에이전트가 쓴 작업을 이해하도록 돕는 설명 페이지를 만들고, 짧은 퀴즈로 마무리합니다.
120
+
121
+ **문서, 그림, 화면**
122
+
123
+ - `lit-docx`, `lit-pptx`: 서식을 갖춘 Word 파일이나 편집 가능한 PowerPoint 파일을 원고 Markdown과 함께 만듭니다.
124
+ - `lit-diagram-drawer`: 편집 가능한 다이어그램을 그리고 검사한 뒤 PNG와 Office용 SVG로 내보냅니다.
125
+ - `lit-scientific-visualization`: 학술지 규격 그림을 벡터와 600 DPI로 내보냅니다.
126
+ - `lit-typographic-motion`: 트리트먼트부터 쓰고 짧은 영상을 만듭니다.
127
+ - `lit-humanizer`: 딱딱한 AI 문장을 한국어나 영어로 다시 씁니다. 사실과 단서는 남깁니다.
128
+ - `readme-studio`: 사실에 맞는 README와 움직이는 커버를 만듭니다.
129
+ - `frontend-ui-ux`, `visual-qa`, `browser-drive`: 화면을 만들고, 실제 화면을 폭별로 확인하고, 브라우저
130
+ 드라이버를 확인한 뒤 실제 페이지를 조작합니다.
131
+
132
+ **코드**
133
+
134
+ - `debugging`: 버그를 재현하고, 가설을 세 개 이상 세워 확인한 뒤, 확인된 원인만 고칩니다.
135
+ - `refactor`: 동작을 테스트로 고정한 채 코드 구조를 바꿉니다.
136
+ - `lit-code`: 테스트 먼저, 경계에서 타입 확인 같은 엄격한 구현 규칙입니다.
137
+ - `lit-commit`: 변경을 저장소 스타일에 맞는 작은 커밋으로 나눕니다.
138
+ - `lit-burnoff`, `lit-burnoff-file`: 변경분 전체나 파일 하나에서 AI식 군더더기를 걷어냅니다.
139
+ - `structural-search`: 문법 구조로 코드를 찾고, 바꾸기 전에 결과를 미리 보여 줍니다.
140
+ - `lsp-setup`, `lit-init`: 언어 서버 설정을 확인하고, 필요한 곳에만 짧은 AGENTS.md 안내를 만듭니다.
141
+
142
+ **LitCodex 관리**
143
+
144
+ - `litcodex-doctor`, `litcodex-report-bug`, `litcodex-contribute-bug-fix`: 설치 상태 점검, 출처를 단 버그 보고서,
145
+ 테스트가 붙은 수정 PR입니다.
146
+ - `rules`, `lsp`, `comment-checker`는 알아서 돌아갑니다. 프롬프트마다 프로젝트 규칙을 넣고, 수정 뒤에는 LSP와
147
+ 주석을 확인합니다.
148
+
149
+ ## A/B 결과
150
+
151
+ 기본 Codex와 비교한 한 줄짜리 A/B 작업 열 개에서 최종 판정은 LitCodex 기준 8승 1무 1패(S7은 메인테이너 미검토),
152
+ 블라인드 심사 판정은 3승 2무 5패였습니다. 작업마다 한 번씩, 배포 전 로컬 빌드로 실행한 결과입니다. 작업별 내용과 두 판정, 화면은
153
+ [GitHub의 A/B 절](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md#ab-기본-codex와-lit-비교)에 있습니다.
154
+
155
+ ## 설치하면 달라지는 것
156
+
157
+ Codex가 플러그인을 불러오고 훅을 실행합니다. 훅은 요청이 어떤 모드에 속하는지 가리고, 스킬은 에이전트의 작업
158
+ 절차를 안내하며, 루프 CLI는 프로젝트 기록을 관리합니다. 패키지가 Codex의 native goal 도구를 직접 호출하지는
159
+ 않습니다. 도구가 있으면 에이전트가 씁니다. paused 또는 blocked인 목표는 아래 복구 절차를 따르세요.
160
+
161
+ - Codex에 플러그인·훅·에이전트가 등록되고 `~/.codex/config.toml`의 관리 항목이 갱신됩니다. 관련 없는 Codex
162
+ 설정은 그대로 둡니다. `--reconfigure` 전에는 바뀔 내용을 먼저 확인하세요.
163
+ - 모델 경로는 설정값일 뿐, 그 모델을 쓸 수 있다거나 실제로 실행된다는 보장은 아닙니다.
164
+ - 프로젝트마다 `.litcodex/lit-loop/` 아래에 로컬 기록이 생기며, Git과 패키지에서는 제외됩니다.
165
+ - 진단 자체는 Codex 설정, 설치 상태, 플러그인 상태를 바꾸지 않습니다. 조건에 맞는 대화형 doctor 실행에서는
166
+ 캐시해 둔 안내를 보여 줄 수 있고, 백그라운드 작업은 정해진 레지스트리만 조회해 `~/.litcodex/update-check.json`을
167
+ 새로 고칠 뿐 패키지를 설치하지 않습니다. 이와 별개로, 조건에 맞는 대화형 관리 명령 뒤에는 업데이트 실행기가
168
+ 새 전역 패키지를 설치할 수 있습니다. `LITCODEX_NO_UPDATE_CHECK=1`로 둘 다 끌 수 있고, 실패했거나
169
+ `--json`·`--dry-run`·비TTY·CI·opt-out인 doctor 실행은 부수 효과가 없습니다.
170
+ - 테스트, 픽스처, 테스트 헬퍼, Vitest 설정은 저장소에만 있습니다. npm 패키지와 설치된 마켓플레이스 플러그인에는
171
+ 들어가지 않습니다.
172
+
173
+ 선택 기능인 Jev 스킬 힌트는 기본값이 꺼짐입니다. 켜면(`LITCODEX_JEV=1`과 본인의 `TYPESAFE_API_KEY`) 조건에 맞는
174
+ 프롬프트가 매번 TypeSafe(typesafe.ai)로 전송됩니다. 2,000자로 자르고 홈 경로, 이메일 주소, 토큰 형태의 문자열을
175
+ 가리고, 프롬프트의 나머지 내용은 그대로 보냅니다. 파일, 도구 출력, 대화 기록은 보내지 않습니다. 켜기 전에
176
+ [전체 설명](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md#jev-스킬-힌트-선택)과
177
+ [개인정보 안내](https://github.com/wjgoarxiv/litcodex/blob/main/docs/privacy.md#optional-jev-skill-hint)를 읽어 주세요.
178
+
179
+ ## 확인, 문제 해결, 제거
180
+
181
+ ```sh
182
+ npm exec --yes --package @litfamily/litcodex@1.0.9 -- litcodex doctor
183
+ ```
184
+
185
+ `litcodex doctor`는 등록·훅·설정·호스트 기능을, `litcodex loop doctor`는 현재 프로젝트의 루프 상태를 확인합니다.
186
+ 검사를 통과해도 인증된 모델 작업까지 확인한 것은 아닙니다.
187
+
188
+ - **`lit`을 입력해도 반응이 없다면.** `litcodex doctor`를 실행하고 Codex에서 훅을 승인했는지 확인하세요.
189
+ - **명령을 찾지 못한다면.** 위의 `npm exec` 형식을 쓰거나, npm 전역 bin 경로를 `PATH`에 넣으세요.
190
+ - **native goal이 paused 또는 blocked라면.** `/goal resume`으로 재개하고 활성 상태인지 확인한 뒤
191
+ `litcodex loop run --retry-failed`로 다시 시도하세요. 미완료 목표는 지우지 말고 남겨 두세요.
192
+ - **출력 없이 pane이 닫힌다면.** 열린 터미널에서 도움말, 설치, doctor를 하나씩 실행해 각 종료 코드를 남기고
193
+ [문제 해결](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md#문제-해결)을 참고하세요.
194
+
195
+ ```sh
196
+ npm exec --yes --package @litfamily/litcodex@1.0.9 -- litcodex uninstall
197
+ ```
198
+
199
+ 플러그인과 LitCodex가 관리하는 설정을 지우고, 관련 없는 설정은 그대로 둡니다.
200
+
201
+ ## 링크
202
+
203
+ [사용 참고서](https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage-Ko-KR.md) ·
204
+ [기존 설치 이전](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md) ·
205
+ [CHANGELOG.md](https://github.com/wjgoarxiv/litcodex/blob/main/CHANGELOG.md) ·
206
+ [개인정보](https://github.com/wjgoarxiv/litcodex/blob/main/docs/privacy.md) ·
207
+ [이슈](https://github.com/wjgoarxiv/litcodex/issues) · MIT 라이선스