@ps-neko/nekowork 0.1.0-alpha.8 → 0.1.0-alpha.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.
- package/CLAUDE.md +1 -1
- package/README.ko.md +217 -0
- package/README.md +419 -394
- package/agent.yaml +1 -1
- package/docs/AGENTIC-PATTERNS.md +115 -0
- package/docs/ARCHITECTURE.md +2 -2
- package/docs/AUDIT.md +122 -121
- package/docs/AUTONOMY.md +6 -0
- package/docs/CATALOG-PACKS.md +36 -34
- package/docs/CHANGELOG.md +12 -0
- package/docs/CLI-UX-PHASE1A-PLAN.md +1293 -0
- package/docs/CLI-UX-REDESIGN.md +220 -0
- package/docs/CODEMAPS/scripts.md +11 -1
- package/docs/CODEMAPS/tests.md +15 -1
- package/docs/DEMO-REPORT.md +6 -0
- package/docs/DEMO.md +1 -1
- package/docs/EXAMPLE-PROJECT.md +1 -1
- package/docs/EXTERNAL-RUN.md +82 -0
- package/docs/FEEDBACK-TRIAGE.md +5 -0
- package/docs/PARALLEL-CANDIDATES.md +39 -2
- package/docs/PORTING.md +1 -1
- package/docs/PR-PREP.md +1 -1
- package/docs/PUBLISH-ALPHA.md +15 -15
- package/docs/QUICKSTART.md +8 -17
- package/docs/RELEASE-READINESS.md +197 -182
- package/docs/ROADMAP.md +19 -14
- package/docs/SAFETY-GUARANTEES.md +1 -1
- package/docs/SETUP.md +1 -1
- package/docs/WHY-NEKOWORK.md +15 -19
- package/docs/assets/demo-terminal.svg +1 -1
- package/docs/case-studies/DIARY-LOCAL-APP.md +117 -0
- package/docs/case-studies/README.md +1 -0
- package/examples/parallel-candidates-canonical/README.md +32 -0
- package/examples/parallel-candidates-canonical/case-study/CANONICAL_VERIFY.md +23 -0
- package/examples/parallel-candidates-canonical/case-study/PARALLEL_CANDIDATES.md +38 -0
- package/examples/parallel-candidates-canonical/case-study/REPORT.md +48 -0
- package/examples/parallel-candidates-canonical/case-study/SHIP_READY.md +11 -0
- package/examples/parallel-candidates-canonical/case-study/TASK.md +25 -0
- package/examples/parallel-candidates-canonical/package.json +9 -0
- package/examples/parallel-candidates-canonical/scripts/check.mjs +31 -0
- package/examples/parallel-candidates-canonical/src/parser.js +7 -0
- package/package.json +1 -1
- package/scripts/cli/commands/auto-command.js +12 -1
- package/scripts/cli.js +212 -28
- package/scripts/lib/flag-normalize.js +55 -0
- package/scripts/lib/parallel-candidates.js +602 -0
- package/scripts/lib/session-id.js +27 -0
- package/scripts/lib/session-resolver.js +28 -14
- package/scripts/lib/ui-errors.js +29 -0
- package/scripts/lib/ui-format.js +39 -0
- package/scripts/orchestrators/auto.js +125 -3
- package/scripts/orchestrators/report.js +137 -7
- package/scripts/orchestrators/review.js +2 -1
- package/scripts/orchestrators/work.js +2 -1
package/CLAUDE.md
CHANGED
package/README.ko.md
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
# NEKOWORK
|
|
2
|
+
|
|
3
|
+
[English](README.md) | [한국어](README.ko.md)
|
|
4
|
+
|
|
5
|
+
AI 코드 변경을 위한 검증 기반 오토파일럿입니다.
|
|
6
|
+
|
|
7
|
+
[](https://github.com/Ps-Neko/NEKOWORK/actions/workflows/harness-validate.yml)
|
|
8
|
+
|
|
9
|
+
AI가 만들고, Codex가 검증하고, 사람은 최종 적용 경계를 승인합니다.
|
|
10
|
+
|
|
11
|
+
NEKOWORK는 AI가 계획, 수정, 검증, 제한된 재수정, 리포트 생성을 수행하도록 돕습니다. 하지만 최종 `apply`는 항상 사람이 명시적으로 실행해야 합니다.
|
|
12
|
+
|
|
13
|
+
> 이 문서는 한국어 요약본입니다. 전체 상세 설명과 모든 고급 옵션은 [English README](README.md)를 참고하세요.
|
|
14
|
+
|
|
15
|
+
여기서 "검증됨"은 정답을 수학적으로 보증한다는 뜻이 아닙니다. 독립 리뷰, 테스트 evidence, 위험 정책, Human Gate, 명시적 apply 경계를 기록했다는 뜻입니다.
|
|
16
|
+
|
|
17
|
+
## 용어
|
|
18
|
+
|
|
19
|
+
- evidence: 실행과 검증 결과로 남는 증거 파일입니다.
|
|
20
|
+
- Human Gate: 사람이 최종 적용 여부를 승인하거나 차단하는 단계입니다.
|
|
21
|
+
- executor: 실제 변경 후보를 만드는 단일 작업자입니다.
|
|
22
|
+
- session: 한 번의 NEKOWORK 실행에서 생성되는 작업 기록 묶음입니다.
|
|
23
|
+
- apply: 검증된 ship-ready diff를 사람이 명시적으로 반영하는 명령입니다.
|
|
24
|
+
|
|
25
|
+
## 핵심 원칙
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
NEKOWORK = 검증 기반 오토파일럿 -> Codex 검증 -> Human Gate -> 명시적 apply
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
apply 전까지는 자율적으로.
|
|
33
|
+
ship 전에는 독립 검증.
|
|
34
|
+
경계에서는 사람이 통제.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
NEKOWORK는 자동으로 commit, push, publish, deploy, apply를 하지 않습니다.
|
|
38
|
+
|
|
39
|
+
## 요구 사항
|
|
40
|
+
|
|
41
|
+
- Node.js 22+
|
|
42
|
+
- npm
|
|
43
|
+
- git
|
|
44
|
+
|
|
45
|
+
## 안전한 기본값
|
|
46
|
+
|
|
47
|
+
NEKOWORK는 기본 흐름을 mock provider 모드로 확인할 수 있습니다. API key나 유료 provider 호출 없이 `check`, `auto --dry-run`, report 생성 흐름을 먼저 검증할 수 있습니다.
|
|
48
|
+
|
|
49
|
+
실제 provider를 사용할 때는 Claude, Codex, Gemini 같은 로컬 CLI 인증을 우선 사용합니다. 장기 provider API key fallback 경로는 기본적으로 차단하고, 사람이 명시적으로 선택한 경우에만 다룹니다.
|
|
50
|
+
|
|
51
|
+
## 30초 실행
|
|
52
|
+
|
|
53
|
+
현재 npm alpha를 바로 실행할 수 있습니다.
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx -y @ps-neko/nekowork@alpha check
|
|
57
|
+
npx -y @ps-neko/nekowork@alpha auto "fix failing tests safely" --session first-auto
|
|
58
|
+
npx -y @ps-neko/nekowork@alpha report --session latest
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
먼저 실행 경로만 보고 싶다면:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx -y @ps-neko/nekowork@alpha auto "fix failing tests safely" --dry-run
|
|
65
|
+
npx -y @ps-neko/nekowork@alpha auto "refactor this safely" --parallel-candidates 2 --dry-run
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 한 명령. 하나의 차단된 위험.
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npx -y @ps-neko/nekowork@alpha auto "add OPENAI_API_KEY fallback for Codex auth"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
예시 출력:
|
|
75
|
+
|
|
76
|
+
```text
|
|
77
|
+
Risk: provider-auth / long-lived-secret
|
|
78
|
+
Codex verdict: request_changes
|
|
79
|
+
Human Gate: required
|
|
80
|
+
Ship ready: false
|
|
81
|
+
Applied: false
|
|
82
|
+
|
|
83
|
+
Blocked because NEKOWORK defaults to delegated CLI auth and rejects long-lived provider API key paths unless the human explicitly opts in.
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
설명: NEKOWORK는 delegated CLI auth를 기본값으로 두고, 장기 provider API key 경로는 사람이 명시적으로 선택하지 않는 한 거부합니다.
|
|
87
|
+
|
|
88
|
+
이것이 NEKOWORK의 핵심입니다. 오토파일럿은 경계 전까지 계속 일할 수 있지만, 위험한 ship/apply 결정은 evidence와 사람의 승인 아래에 둡니다.
|
|
89
|
+
|
|
90
|
+
## 왜 필요한가
|
|
91
|
+
|
|
92
|
+
AI coding 도구는 점점 더 빠르게 코드를 만듭니다. 하지만 마지막 질문은 그대로 남습니다.
|
|
93
|
+
|
|
94
|
+
```text
|
|
95
|
+
이 변경을 믿고 내 프로젝트에 반영해도 되는가?
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
NEKOWORK는 이 질문에 답하기 위한 로컬 우선 런타임입니다.
|
|
99
|
+
|
|
100
|
+
- AI 작업을 session evidence로 남깁니다.
|
|
101
|
+
- 한 executor만 실제 변경 후보를 만듭니다.
|
|
102
|
+
- Codex가 별도 관점에서 검증합니다.
|
|
103
|
+
- 위험하면 Human Gate를 엽니다.
|
|
104
|
+
- `apply`는 검증된 ship-ready diff에만 명시적으로 실행됩니다.
|
|
105
|
+
|
|
106
|
+
## 실행 흐름
|
|
107
|
+
|
|
108
|
+
대부분은 이 흐름으로 시작하면 됩니다.
|
|
109
|
+
|
|
110
|
+
```text
|
|
111
|
+
check -> auto -> report -> gate
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
단계별 제어가 필요하면:
|
|
115
|
+
|
|
116
|
+
```text
|
|
117
|
+
ask -> plan -> team -> work -> verify -> gate -> ship -> report -> apply
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
`team`은 read-only handoff를 만들고, 파일 수정은 single executor가 담당합니다.
|
|
121
|
+
|
|
122
|
+
## Starter Packs
|
|
123
|
+
|
|
124
|
+
처음에는 아래 5개만 보면 됩니다. 전체 catalog는 [docs/CATALOG-PACKS.md](docs/CATALOG-PACKS.md)에 있습니다.
|
|
125
|
+
|
|
126
|
+
| Pack | 역할 | 언제 쓰나 |
|
|
127
|
+
|---|---|---|
|
|
128
|
+
| `core` | 최소 검증 런타임 | 첫 설치, repo smoke |
|
|
129
|
+
| `builder` | safe build mode 진입점 | 한 명령으로 build + 검증 + gate |
|
|
130
|
+
| `productivity` | 계획, TDD, 디버깅, finish 루틴 | 일상적인 AI 개발 |
|
|
131
|
+
| `security` | auth, secrets, deploy 위험 프롬프트 | 민감한 변경 |
|
|
132
|
+
| `release` | ship/no-ship evidence | 릴리즈 전 점검 |
|
|
133
|
+
|
|
134
|
+
## Report가 제품의 얼굴입니다
|
|
135
|
+
|
|
136
|
+
`report`는 session evidence를 사람이 읽을 수 있는 `REPORT.md`로 정리합니다.
|
|
137
|
+
|
|
138
|
+
```text
|
|
139
|
+
Verdict: approve_with_fixes
|
|
140
|
+
Ship ready: false
|
|
141
|
+
Human gate: required
|
|
142
|
+
Applied: false
|
|
143
|
+
Profile: quality
|
|
144
|
+
Strict quality: enabled
|
|
145
|
+
Acceptance coverage: 4/5
|
|
146
|
+
Quality warnings: 2
|
|
147
|
+
|
|
148
|
+
Evidence:
|
|
149
|
+
- work-summary.json
|
|
150
|
+
- verify-summary.json
|
|
151
|
+
- ship-summary.json
|
|
152
|
+
- gate-summary.json
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
전체 예시는 [docs/DEMO-REPORT.md](docs/DEMO-REPORT.md)를 보세요.
|
|
156
|
+
|
|
157
|
+
## 12가지 에이전틱 하네스 패턴
|
|
158
|
+
|
|
159
|
+
NEKOWORK는 하나의 거대한 agent 묶음이 아니라, 일을 나누고 검증하고 승인하는 패턴을 조합합니다.
|
|
160
|
+
|
|
161
|
+
이미 강하게 적용된 패턴:
|
|
162
|
+
|
|
163
|
+
- 계획-실행: `ask`, `plan`, Build Intelligence mini plan
|
|
164
|
+
- 생성-검토: `work -> verify`, Codex review
|
|
165
|
+
- 라우터: Build Intelligence와 risk classifier
|
|
166
|
+
- 전문가 팀: read-only `team` handoff
|
|
167
|
+
- 순차 파이프라인: `ask -> plan -> team -> work -> verify -> gate -> ship -> report -> apply`
|
|
168
|
+
- 사람 승인: Human Gate
|
|
169
|
+
- 도구 게이트: provider auth, git mutation guard, explicit `apply`
|
|
170
|
+
|
|
171
|
+
아직 의도적으로 partial인 패턴:
|
|
172
|
+
|
|
173
|
+
- 병렬 처리: `auto --parallel-candidates N` preview는 isolated candidate evidence, candidate verification, arbiter 선택, final Codex verification, ship readiness까지 연결합니다. `apply`는 여전히 명시적으로만 실행됩니다.
|
|
174
|
+
- 메모리 루프: `instincts`, `wait`, `ralph`가 기반이지만 자동 승격은 하지 않습니다.
|
|
175
|
+
- 진화 루프: 관찰은 자동화하되 채택은 사람이 검토합니다.
|
|
176
|
+
|
|
177
|
+
자세한 매핑은 [docs/AGENTIC-PATTERNS.md](docs/AGENTIC-PATTERNS.md)를 보세요.
|
|
178
|
+
|
|
179
|
+
## NEKOWORK가 최적화하는 것
|
|
180
|
+
|
|
181
|
+
| 질문 | NEKOWORK evidence |
|
|
182
|
+
|---|---|
|
|
183
|
+
| 왜 ship이 막혔는가? | `NO_SHIP`, `REPORT.md`, `gate-summary.json` |
|
|
184
|
+
| apply가 사람 통제 아래 있는가? | `auto`는 `--apply`를 거부하고, `apply`는 별도 명령입니다 |
|
|
185
|
+
| 구현자와 검증자가 분리되는가? | `work -> verify`와 Codex review evidence |
|
|
186
|
+
| 위험한 fast downgrade를 막는가? | manifest-backed build mode safety order |
|
|
187
|
+
| 장기 provider API key를 기본값으로 피하는가? | delegated CLI auth와 API-key override guard |
|
|
188
|
+
|
|
189
|
+
## 현재 alpha 상태
|
|
190
|
+
|
|
191
|
+
- Package: `@ps-neko/nekowork`
|
|
192
|
+
- Current alpha: `0.1.0-alpha.9`
|
|
193
|
+
- CLI: `nekowork`
|
|
194
|
+
- Legacy/internal alias: `harness`
|
|
195
|
+
- Tests: 345 pass
|
|
196
|
+
- npm audit: 0 moderate+ issues
|
|
197
|
+
- Fresh `npx @alpha` smoke: pass
|
|
198
|
+
|
|
199
|
+
## 외부 real run 공유
|
|
200
|
+
|
|
201
|
+
NEKOWORK는 실제 외부 run evidence가 중요합니다. 아래 문서를 따라 transcript, report trust card, quote를 공유할 수 있습니다.
|
|
202
|
+
|
|
203
|
+
- [docs/EXTERNAL-RUN.md](docs/EXTERNAL-RUN.md)
|
|
204
|
+
- [External run issue template](https://github.com/Ps-Neko/NEKOWORK/issues/new?template=external-run.yml)
|
|
205
|
+
|
|
206
|
+
비밀키, private path, proprietary source code는 반드시 제거하고 공유하세요.
|
|
207
|
+
|
|
208
|
+
## 문서
|
|
209
|
+
|
|
210
|
+
- [Quickstart](docs/QUICKSTART.md)
|
|
211
|
+
- [Build modes](docs/BUILD.md)
|
|
212
|
+
- [Bounded autonomy](docs/AUTONOMY.md)
|
|
213
|
+
- [Safety guarantees](docs/SAFETY-GUARANTEES.md)
|
|
214
|
+
- [Trust model](docs/TRUST-MODEL.md)
|
|
215
|
+
- [Why NEKOWORK](docs/WHY-NEKOWORK.md)
|
|
216
|
+
- [12 agentic harness patterns](docs/AGENTIC-PATTERNS.md)
|
|
217
|
+
- [External run kit](docs/EXTERNAL-RUN.md)
|