@devport-kr/portki 0.1.1 → 0.2.2

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 (5) hide show
  1. package/AGENTS.md +14 -14
  2. package/CLAUDE.md +14 -14
  3. package/README.md +79 -89
  4. package/dist/cli.js +696 -95
  5. package/package.json +1 -1
package/AGENTS.md CHANGED
@@ -11,7 +11,7 @@ Do not call external LLM APIs. Do not add OpenAI or Anthropic API usage.
11
11
  - This branch is the public version.
12
12
  - There is no DB, no embeddings, no PostgreSQL, and no OpenAI API dependency.
13
13
  - It should work without `.env` setup.
14
- - Final output lives under `devport-output/wiki/{owner}/{repo}/` as Markdown files.
14
+ - Final output lives under `portki-output/wiki/{owner}/{repo}/` as Markdown files.
15
15
  - `persist-section` means local validation plus session registration only.
16
16
  - `finalize` assembles the full Markdown wiki bundle.
17
17
  - `package` is the monolithic path that exports Markdown directly from a full accepted output.
@@ -56,20 +56,20 @@ Monolithic alternative for small repos:
56
56
 
57
57
  ## Workspace Naming Rule
58
58
 
59
- If multiple repos are processed in parallel, all agent-authored intermediate files must be stored in `devport-output/workspace/` and prefixed with the repo slug.
59
+ If multiple repos are processed in parallel, all agent-authored intermediate files must be stored in `portki-output/workspace/` and prefixed with the repo slug.
60
60
 
61
61
  Examples:
62
62
 
63
- - `devport-output/workspace/ollama-artifact.json`
64
- - `devport-output/workspace/ollama-section-plan.json`
65
- - `devport-output/workspace/ollama-section-1-output.json`
63
+ - `portki-output/workspace/ollama-artifact.json`
64
+ - `portki-output/workspace/ollama-section-plan.json`
65
+ - `portki-output/workspace/ollama-section-1-output.json`
66
66
 
67
67
  ## Commands
68
68
 
69
69
  ### `ingest`
70
70
 
71
71
  ```bash
72
- npx tsx src/agent.ts ingest --repo owner/repo --out devport-output/workspace/{repo-slug}-artifact.json
72
+ npx tsx src/agent.ts ingest --repo owner/repo --out portki-output/workspace/{repo-slug}-artifact.json
73
73
  ```
74
74
 
75
75
  The agent must read these fields:
@@ -97,7 +97,7 @@ Interpret the status as:
97
97
  ### `plan-sections`
98
98
 
99
99
  ```bash
100
- npx tsx src/agent.ts plan-sections --artifact devport-output/workspace/{repo-slug}-artifact.json --out devport-output/workspace/{repo-slug}-plan-context.json
100
+ npx tsx src/agent.ts plan-sections --artifact portki-output/workspace/{repo-slug}-artifact.json --out portki-output/workspace/{repo-slug}-plan-context.json
101
101
  ```
102
102
 
103
103
  The output includes:
@@ -111,13 +111,13 @@ The output includes:
111
111
  ### `validate-plan`
112
112
 
113
113
  ```bash
114
- npx tsx src/agent.ts validate-plan --input devport-output/workspace/{repo-slug}-section-plan.json --context devport-output/workspace/{repo-slug}-plan-context.json --out devport-output/workspace/{repo-slug}-section-plan.json
114
+ npx tsx src/agent.ts validate-plan --input portki-output/workspace/{repo-slug}-section-plan.json --context portki-output/workspace/{repo-slug}-plan-context.json --out portki-output/workspace/{repo-slug}-section-plan.json
115
115
  ```
116
116
 
117
117
  ### `persist-section`
118
118
 
119
119
  ```bash
120
- npx tsx src/agent.ts persist-section --plan devport-output/workspace/{repo-slug}-section-plan.json --section sec-1 --input devport-output/workspace/{repo-slug}-section-1-output.json
120
+ npx tsx src/agent.ts persist-section --plan portki-output/workspace/{repo-slug}-section-plan.json --section sec-1 --input portki-output/workspace/{repo-slug}-section-1-output.json
121
121
  ```
122
122
 
123
123
  This command only does the following:
@@ -131,21 +131,21 @@ It does not write to a database, generate embeddings, or call external APIs.
131
131
  ### `finalize`
132
132
 
133
133
  ```bash
134
- npx tsx src/agent.ts finalize --plan devport-output/workspace/{repo-slug}-section-plan.json --advance_baseline
134
+ npx tsx src/agent.ts finalize --plan portki-output/workspace/{repo-slug}-section-plan.json --advance_baseline
135
135
  ```
136
136
 
137
137
  This command:
138
138
 
139
139
  - validates cross-section repetition
140
140
  - assembles persisted sections from the local session
141
- - writes `devport-output/wiki/{owner}/{repo}/README.md`
142
- - writes section Markdown files such as `devport-output/wiki/{owner}/{repo}/01-sec-1.md`
141
+ - writes `portki-output/wiki/{owner}/{repo}/README.md`
142
+ - writes section Markdown files such as `portki-output/wiki/{owner}/{repo}/01-sec-1.md`
143
143
  - optionally advances the freshness baseline
144
144
 
145
145
  ### `package`
146
146
 
147
147
  ```bash
148
- npx tsx src/agent.ts package --input devport-output/workspace/{repo-slug}-accepted-output.json --advance_baseline
148
+ npx tsx src/agent.ts package --input portki-output/workspace/{repo-slug}-accepted-output.json --advance_baseline
149
149
  ```
150
150
 
151
151
  This validates a monolithic accepted output and writes the same Markdown wiki bundle.
@@ -196,7 +196,7 @@ The final result is Markdown, not a delivery JSON artifact.
196
196
  ## Output Paths
197
197
 
198
198
  ```text
199
- devport-output/
199
+ portki-output/
200
200
  workspace/
201
201
  snapshots/{owner}/{repo}/
202
202
  chunked/{owner}/{repo}/session.json
package/CLAUDE.md CHANGED
@@ -11,7 +11,7 @@ Do not call external LLM APIs. Do not add OpenAI or Anthropic API usage.
11
11
  - This branch is the public version.
12
12
  - There is no DB, no embeddings, no PostgreSQL, and no OpenAI API dependency.
13
13
  - It should work without `.env` setup.
14
- - Final output lives under `devport-output/wiki/{owner}/{repo}/` as Markdown files.
14
+ - Final output lives under `portki-output/wiki/{owner}/{repo}/` as Markdown files.
15
15
  - `persist-section` means local validation plus session registration only.
16
16
  - `finalize` assembles the full Markdown wiki bundle.
17
17
  - `package` is the monolithic path that exports Markdown directly from a full accepted output.
@@ -54,20 +54,20 @@ Monolithic alternative for small repos:
54
54
 
55
55
  ## Workspace Naming Rule
56
56
 
57
- All agent-authored intermediate files must be written to `devport-output/workspace/` and prefixed with the repo slug.
57
+ All agent-authored intermediate files must be written to `portki-output/workspace/` and prefixed with the repo slug.
58
58
 
59
59
  Examples:
60
60
 
61
- - `devport-output/workspace/redis-artifact.json`
62
- - `devport-output/workspace/redis-section-plan.json`
63
- - `devport-output/workspace/redis-section-2-output.json`
61
+ - `portki-output/workspace/redis-artifact.json`
62
+ - `portki-output/workspace/redis-section-plan.json`
63
+ - `portki-output/workspace/redis-section-2-output.json`
64
64
 
65
65
  ## Commands
66
66
 
67
67
  ### `ingest`
68
68
 
69
69
  ```bash
70
- npx tsx src/agent.ts ingest --repo owner/repo --out devport-output/workspace/{repo-slug}-artifact.json
70
+ npx tsx src/agent.ts ingest --repo owner/repo --out portki-output/workspace/{repo-slug}-artifact.json
71
71
  ```
72
72
 
73
73
  Read these fields from the artifact:
@@ -93,19 +93,19 @@ npx tsx src/agent.ts detect --repo owner/repo
93
93
  ### `plan-sections`
94
94
 
95
95
  ```bash
96
- npx tsx src/agent.ts plan-sections --artifact devport-output/workspace/{repo-slug}-artifact.json --out devport-output/workspace/{repo-slug}-plan-context.json
96
+ npx tsx src/agent.ts plan-sections --artifact portki-output/workspace/{repo-slug}-artifact.json --out portki-output/workspace/{repo-slug}-plan-context.json
97
97
  ```
98
98
 
99
99
  ### `validate-plan`
100
100
 
101
101
  ```bash
102
- npx tsx src/agent.ts validate-plan --input devport-output/workspace/{repo-slug}-section-plan.json --context devport-output/workspace/{repo-slug}-plan-context.json --out devport-output/workspace/{repo-slug}-section-plan.json
102
+ npx tsx src/agent.ts validate-plan --input portki-output/workspace/{repo-slug}-section-plan.json --context portki-output/workspace/{repo-slug}-plan-context.json --out portki-output/workspace/{repo-slug}-section-plan.json
103
103
  ```
104
104
 
105
105
  ### `persist-section`
106
106
 
107
107
  ```bash
108
- npx tsx src/agent.ts persist-section --plan devport-output/workspace/{repo-slug}-section-plan.json --section sec-1 --input devport-output/workspace/{repo-slug}-section-1-output.json
108
+ npx tsx src/agent.ts persist-section --plan portki-output/workspace/{repo-slug}-section-plan.json --section sec-1 --input portki-output/workspace/{repo-slug}-section-1-output.json
109
109
  ```
110
110
 
111
111
  What it does:
@@ -123,19 +123,19 @@ What it does not do:
123
123
  ### `finalize`
124
124
 
125
125
  ```bash
126
- npx tsx src/agent.ts finalize --plan devport-output/workspace/{repo-slug}-section-plan.json --advance_baseline
126
+ npx tsx src/agent.ts finalize --plan portki-output/workspace/{repo-slug}-section-plan.json --advance_baseline
127
127
  ```
128
128
 
129
129
  Outputs:
130
130
 
131
- - `devport-output/wiki/{owner}/{repo}/README.md`
132
- - `devport-output/wiki/{owner}/{repo}/01-sec-1.md`
131
+ - `portki-output/wiki/{owner}/{repo}/README.md`
132
+ - `portki-output/wiki/{owner}/{repo}/01-sec-1.md`
133
133
  - additional section Markdown files
134
134
 
135
135
  ### `package`
136
136
 
137
137
  ```bash
138
- npx tsx src/agent.ts package --input devport-output/workspace/{repo-slug}-accepted-output.json --advance_baseline
138
+ npx tsx src/agent.ts package --input portki-output/workspace/{repo-slug}-accepted-output.json --advance_baseline
139
139
  ```
140
140
 
141
141
  This validates a monolithic accepted output and writes the same Markdown result.
@@ -165,7 +165,7 @@ Code call-flow analysis should begin in `sub-1-2` or later.
165
165
  ## Output Paths
166
166
 
167
167
  ```text
168
- devport-output/
168
+ portki-output/
169
169
  workspace/
170
170
  snapshots/{owner}/{repo}/
171
171
  chunked/{owner}/{repo}/session.json
package/README.md CHANGED
@@ -10,135 +10,125 @@
10
10
  - **청크 기반 생성 (Chunked Generation)**: 저장소의 규모가 클 경우, 문서를 여러 섹션으로 나누고 각 섹션 단위로 상세한 문서를 생성 및 검증한 뒤 로컬 세션 상태에 반영합니다.
11
11
  - **순수 Markdown 출력**: 최종 위키를 데이터베이스가 아니라 `README.md`와 섹션별 `.md` 파일로 출력합니다.
12
12
  - **증분 업데이트 (Incremental Update)**: 전체 코드를 매번 다시 분석하지 않고, 마지막 위키 생성 커밋 이후 변경된 파일과 영향을 받는 섹션만 추적하여 위키를 효율적으로 갱신합니다.
13
+ - **AI 에이전트 원클릭 통합**: Claude Code, Codex, Gemini CLI에서 한 줄의 명령으로 위키를 생성할 수 있습니다.
13
14
 
14
- ## 설치
15
+ ---
15
16
 
16
- Node.js 환경이 필요합니다.
17
+ ## 📦 설치 (Installation)
17
18
 
18
- ```bash
19
- npm install
20
- ```
21
-
22
- 공개 버전에서는 `.env`를 만들 필요가 없습니다.
23
-
24
- 출시 후에는 로컬 clone 없이도 사용할 수 있습니다.
19
+ **Node.js 20 이상**이 필요합니다.
25
20
 
26
21
  ```bash
27
- npx @devport-kr/portki help
22
+ npm install -g @devport-kr/portki
23
+ portki help
28
24
  ```
29
25
 
30
- 또는 전역 설치:
31
-
26
+ **환경 점검:** 현재 시스템 환경이 portki를 실행하기에 적합한지 확인하려면 아래 명령어를 사용하세요.
32
27
  ```bash
33
- npm install -g @devport-kr/portki
34
- portki help
28
+ portki doctor
35
29
  ```
36
30
 
37
- ## GitHub Releases
31
+ ---
38
32
 
39
- `public` 브랜치에서는 GitHub Release를 만들 수 있습니다.
33
+ ## 🚀 빠른 시작 (Quick Start)
40
34
 
41
- - `v*` 태그를 `public` 브랜치 커밋에 push하면 Release가 자동으로 생성됩니다.
42
- - Actions의 수동 실행(`workflow_dispatch`)으로도 Release를 만들 수 있습니다.
43
- - Release에는 자동 생성된 노트와 함께 소스 아카이브(`.tar.gz`, `.zip`), npm 패키지 tarball(`devport-kr-portki-<version>.tgz`), SHA256 체크섬 파일이 첨부됩니다.
44
- - npm publish workflow를 함께 켜두면 같은 `v*` 태그에서 npm 패키지도 배포할 수 있습니다.
35
+ portki는 주요 3사의 Coding CLI들과 완벽하게 연동됩니다. 한 번의 어댑터 설치로 에이전트 내에서 직접 명령어를 실행할 수 있습니다.
45
36
 
46
- 기본 절차:
37
+ > 💡 **안내:** 아래 명령어들에 사용된 `devport-kr/portki`는 예시 저장소입니다. 실제로 위키를 생성하고자 하는 대상 GitHub 저장소(예: `facebook/react`, `owner/repo`)로 변경하여 실행해 주세요.
38
+
39
+ ### 1. Claude Code
40
+ 프로젝트 루트에서 어댑터를 설치한 후, Claude Code 내에서 슬래시 명령어로 실행합니다.
47
41
 
48
42
  ```bash
49
- git checkout public
50
- git pull origin public
43
+ # 어댑터 설치 (최초 1회)
44
+ portki install --agent claude
51
45
 
52
- # package.json version과 태그는 일치해야 합니다.
53
- git tag v0.1.1
54
- git push origin public --follow-tags
46
+ # Claude Code에서 실행
47
+ /portki devport-kr/portki
55
48
  ```
49
+ *참고: 어댑터를 설치하지 않은 경우 터미널에서 `portki devport-kr/portki`를 실행한 뒤, 출력되는 `handoff.md`의 경로를 Claude에게 직접 전달해도 됩니다.*
56
50
 
57
- npm 배포까지 하려면 저장소 Secrets에 `NPM_TOKEN`을 추가해야 합니다.
58
-
59
- ## 권장 실행 환경
60
- **(2026년 3월 7일 기준)**
61
- | 환경 | 권장 모델 | (Effort (Thinking) Level) | 설정 지침 |
62
- |------|-----------|--------------------------|------------------|
63
- | **Claude Code** | `Opus 4.6` | High | [`CLAUDE.md`](./CLAUDE.md)|
64
- | **Codex** | `GPT-5.4` | xHigh | [`AGENTS.md`](./AGENTS.md)|
65
- | **Gemini CLI** | `gemini 3.1-pro-preview` | High | [`AGENTS.md`](./AGENTS.md)|
66
-
67
- ## 명령어 (Commands)
68
-
69
- 모든 명령은 프로젝트 루트에서 실행합니다.
51
+ ### 2. Codex (OpenAI)
52
+ Codex 환경에 맞게 `AGENTS.md` 파일에 portki 사용법을 자동으로 추가합니다.
70
53
 
71
54
  ```bash
72
- npx tsx src/agent.ts <command> [flags]
55
+ # 어댑터 설치 (최초 1회)
56
+ portki install --agent codex
73
57
  ```
58
+ *Codex 사용 예시:* "portki devport-kr/portki 실행하고, handoff.md 지침을 따라서 위키를 만들어줘."
59
+
60
+ ### 3. Gemini CLI
61
+ Gemini CLI 환경을 위한 전용 슬래시 명령어를 설정합니다.
74
62
 
75
- | 명령 | 설명 |
76
- |------|------|
77
- | `ingest` | 저장소 스냅샷을 수집하고 분석용 메타데이터(`artifact.json`)를 생성합니다. |
78
- | `plan-sections` | 저장소 구조를 분석하여 섹션별 작성 계획을 위한 컨텍스트와 중점 분석 대상 파일 목록을 제공합니다. |
79
- | `validate-plan` | AI가 생성한 섹션 플랜의 정합성(스키마, 조건 등)을 검증합니다. |
80
- | `persist-section` | 생성된 단일 섹션의 품질을 검증하고, 허용되면 로컬 세션 상태에 반영합니다. |
81
- | `finalize` | 작성 완료된 모든 섹션 간의 교차 검증을 수행하고, 최종 Markdown 위키와 기준점을 업데이트합니다. |
82
- | `package` | 위키 결과물 규격을 검증하고 순수 Markdown 위키 번들로 출력합니다. |
83
- | `detect` | 마지막 배포 시점과 현재 저장소의 변경 사항을 비교하여 증분 업데이트 필요 여부와 대상 섹션을 파악합니다. |
63
+ ```bash
64
+ # 어댑터 설치 (최초 1회)
65
+ portki install --agent gemini
84
66
 
85
- ## 워크플로우
67
+ # Gemini CLI에서 실행
68
+ /portki devport-kr/portki
69
+ ```
86
70
 
87
- 이 도구는 AI 에이전트가 위키 문서를 더 정확하고 꼼꼼하게 작성하도록 **청크 단위 작업**을 권장합니다.
71
+ ---
88
72
 
89
- ### 1. 청크 단위 위키 생성 (권장)
73
+ ## ⚙️ 주요 명령어 (Commands)
90
74
 
91
- 저장소를 분석하여 여러 섹션으로 분리한 후 각 섹션별로 코드를 깊이 있게 확인하고 작성하는 방식입니다.
75
+ portki는 AI 에이전트의 원활한 작업을 위한 상위 명령어와, 디테일한 제어를 위한 하위 명령어를 제공합니다.
92
76
 
93
- ```bash
94
- # 1. 저장소 스냅샷 수집
95
- npx tsx src/agent.ts ingest --repo owner/repo --out devport-output/workspace/{repo-slug}-artifact.json
77
+ | 분류 | 명령어 | 설명 |
78
+ |---|---|---|
79
+ | **기본 실행** | `portki owner/repo` | 저장소를 분석하고 AI 에이전트용 작업 지침서(`handoff.md`)를 생성합니다. |
80
+ | **상태 관리** | `portki status owner/repo` | 현재 진행 중인 파이프라인의 작업 상태를 확인합니다. |
81
+ | | `portki resume owner/repo` | 중단된 작업을 마지막으로 완료된 단계부터 이어서 진행합니다. |
82
+ | **환경 설정** | `portki doctor` | 시스템 실행 환경 및 의존성 상태를 점검합니다. |
83
+ | | `portki install --agent <name>` | 특정 AI 에이전트(`claude`, `codex`, `gemini`)용 어댑터를 설치합니다. |
96
84
 
97
- # 2. 분석 및 섹션 계획 수립 준비 (컨텍스트 생성)
98
- npx tsx src/agent.ts plan-sections --artifact devport-output/workspace/{repo-slug}-artifact.json --out devport-output/workspace/{repo-slug}-plan-context.json
85
+ *(수동 작업 및 세밀한 파이프라인 제어가 필요한 경우 `ingest`, `plan-sections`, `validate-plan`, `persist-section`, `finalize`, `detect` 등의 하위 명령어를 지원합니다.)*
99
86
 
100
- # (AI 작업: plan-context.json과 주요 코드를 바탕으로 {repo-slug}-section-plan.json 생성)
87
+ ---
101
88
 
102
- # 3. 플랜 검증
103
- npx tsx src/agent.ts validate-plan --input devport-output/workspace/{repo-slug}-section-plan.json --context devport-output/workspace/{repo-slug}-plan-context.json --out devport-output/workspace/{repo-slug}-section-plan.json
89
+ ## 🔄 워크플로우 (Workflows)
104
90
 
105
- # 4. 각 섹션별 작성 및 세션 반영 (전체 섹션 완료 시까지 반복)
106
- # (AI 작업: 해당 섹션의 코드를 분석하고 {repo-slug}-section-1-output.json 생성)
107
- npx tsx src/agent.ts persist-section --plan devport-output/workspace/{repo-slug}-section-plan.json --section sec-1 --input devport-output/workspace/{repo-slug}-section-1-output.json
91
+ portki는 코드베이스 규모에 구애받지 않고 고품질의 위키를 생성하기 위해 **청크 단위 작업(Chunked Generation)**을 수행합니다.
108
92
 
109
- # 5. 최종 완성 및 증분 베이스라인 갱신
110
- npx tsx src/agent.ts finalize --plan devport-output/workspace/{repo-slug}-section-plan.json --advance_baseline
111
- ```
93
+ ### 1. AI 에이전트 자동 워크플로우 (권장)
94
+ 가장 쉽고 권장하는 방식입니다. portki가 분석 파이프라인을 구축하면, 에이전트가 이를 따라 문서를 완성합니다.
112
95
 
113
- `finalize`가 완료되면 `devport-output/wiki/{owner}/{repo}/README.md`와 섹션별 Markdown 파일이 생성됩니다.
96
+ 1. `portki owner/repo` 실행하여 저장소 스냅샷 수집 및 `handoff.md` 생성.
97
+ 2. AI 에이전트가 `handoff.md` 지침에 따라 섹션별 계획 수립 및 검증(`validate-plan`).
98
+ 3. 섹션 단위로 문서를 작성하고 로컬 세션에 반영(`persist-section`).
99
+ 4. 모든 섹션 작성이 끝나면 최종 Markdown 파일로 조립(`finalize`).
114
100
 
115
101
  ### 2. 증분 업데이트 (Incremental Update)
102
+ 기존에 생성된 위키가 있다면, 변경된 코드만 추적하여 효율적으로 문서를 갱신할 수 있습니다.
116
103
 
117
- 이전에 작성 완료된 위키를 바탕으로 변경된 파일들만 식별하여 최신화합니다.
104
+ 1. **변경 사항 감지**: `portki detect --repo owner/repo`
105
+ - 변경이 없으면 건너뜀 (`noop`)
106
+ - 일부 변경 시 연관된 섹션만 업데이트 (`incremental`)
107
+ - 대규모 구조 변경 시 전체 재작성 (`full-rebuild`)
108
+ 2. 변경된 스냅샷 수집 후 필요한 섹션만 재생성 및 병합 진행.
118
109
 
119
- ```bash
120
- # 1. 변경사항 감지
121
- npx tsx src/agent.ts detect --repo owner/repo
122
- # 반환된 JSON의 status에 따라 분기:
123
- # - noop: 변경점 없음 (수정 불필요)
124
- # - incremental: 변경된 코드와 영향을 받는 섹션(impacted_section_ids)만 재생성
125
- # - full-rebuild: 너무 많은 변화로 인해 전체 위키 재작성 필요
110
+ ---
111
+
112
+ ## 📂 출력 디렉토리 구조 (Output Directory)
126
113
 
127
- # 2. 재생성 필요 시 최신 코드로 스냅샷 다시 수집
128
- npx tsx src/agent.ts ingest --repo owner/repo --out devport-output/workspace/{repo-slug}-artifact.json
114
+ 모든 작업 내역과 최종 결과물은 프로젝트 루트를 오염시키지 않도록 `portki-output/` 폴더에 안전하게 저장됩니다. (기본적으로 `.gitignore`에 포함됩니다.)
129
115
 
130
- # (이후 영향을 받는 섹션만 다시 작성하여 persist-section 후 finalize 수행)
116
+ ```text
117
+ portki-output/
118
+ ├── workspace/ # AI 에이전트용 중간 작업 파일 (*.json)
119
+ ├── snapshots/owner/repo/ # 원본 코드 스냅샷 (직접 수정 금지)
120
+ ├── chunked/owner/repo/ # 섹션별 작업 내역 및 세션 상태
121
+ ├── freshness/state.json # 증분 업데이트를 위한 베이스라인 상태값
122
+ └── wiki/owner/repo/ # ✨ 완성된 최종 Markdown 위키
131
123
  ```
132
124
 
133
- ## 출력 경로 (File Layout)
125
+ ---
134
126
 
135
- 작업 중에 AI가 생성한 임시 파일과 파이프라인이 생성한 모든 데이터는 프로젝트 루트를 오염시키지 않도록 `devport-output/` 내부에 기록됩니다. (이 디렉터리는 `.gitignore`에 포함되어 있습니다.)
127
+ ## 💻 권장 실행 환경
128
+ 안정적인 위키 생성을 위해 높은 수준의 추론 능력을 가진 모델 사용을 권장합니다. *(2026년 3월 7일 기준)*
136
129
 
137
- ```text
138
- devport-output/
139
- workspace/ # AI 에이전트가 중간에 생성하고 읽는 작업 파일 ({repo-slug}-*.json)
140
- snapshots/{owner}/{repo}/ # 다운로드된 코드 스냅샷 원본 (절대 직접 수정 금지)
141
- wiki/{owner}/{repo}/ # 최종 Markdown 위키 출력
142
- chunked/{owner}/{repo}/ # 진행 중인 섹션별 작업 및 세션 상태 보관 파일
143
- freshness/state.json # 증분 업데이트 감지 시 사용하는 마지막 베이스라인 상태 파일
144
- ```
130
+ | 환경 | 권장 모델 | 추론(Thinking) 레벨 | 설정 파일 |
131
+ |---|---|---|---|
132
+ | **Claude Code** | `Opus 4.6` | High | [`CLAUDE.md`](./CLAUDE.md) |
133
+ | **Codex** | `GPT-5.4` | xHigh | [`AGENTS.md`](./AGENTS.md) |
134
+ | **Gemini CLI** | `gemini 3.1-pro-preview` | High | [`AGENTS.md`](./AGENTS.md) |