codex-agent-view 0.4.2 → 0.4.4
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/.codex-plugin/plugin.json +3 -6
- package/README.ko.md +35 -27
- package/README.md +34 -26
- package/bin/codex-agent-view.mjs +63 -1
- package/package.json +1 -1
- package/public/app.js +630 -139
- package/public/index.html +62 -52
- package/public/styles.css +51 -16
- package/scripts/auto-start-monitor.mjs +10 -2
- package/skills/codex-agent-view/SKILL.md +36 -35
- package/skills/show-agents/SKILL.md +56 -18
- package/src/runtime/config.mjs +131 -0
- package/src/runtime/server.mjs +14 -5
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codex-agent-view",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.4",
|
|
4
4
|
"description": "Read-only Codex app task snapshots with a trusted-hook auto-prepared local live backend.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Junho Yoon",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"interface": {
|
|
14
14
|
"displayName": "Codex Agent View",
|
|
15
15
|
"shortDescription": "View active Codex tasks.",
|
|
16
|
-
"longDescription": "View privacy-minimized active task and subagent snapshots inside the official Codex app,
|
|
16
|
+
"longDescription": "View privacy-minimized active task and subagent snapshots inside the official Codex app. Select the plugin first, then explicitly invoke the bundled $show-agents skill when you want to open the live monitor; the plugin does not append or auto-run action text.",
|
|
17
17
|
"developerName": "Junho Yoon",
|
|
18
18
|
"category": "Productivity",
|
|
19
19
|
"brandColor": "#123F35",
|
|
@@ -25,9 +25,6 @@
|
|
|
25
25
|
],
|
|
26
26
|
"websiteURL": "https://github.com/JunhoYoon95/codex-agent-view",
|
|
27
27
|
"privacyPolicyURL": "https://github.com/JunhoYoon95/codex-agent-view/blob/main/docs/privacy.md",
|
|
28
|
-
"termsOfServiceURL": "https://github.com/JunhoYoon95/codex-agent-view/blob/main/docs/terms.md"
|
|
29
|
-
"defaultPrompt": [
|
|
30
|
-
"$show-agents"
|
|
31
|
-
]
|
|
28
|
+
"termsOfServiceURL": "https://github.com/JunhoYoon95/codex-agent-view/blob/main/docs/terms.md"
|
|
32
29
|
}
|
|
33
30
|
}
|
package/README.ko.md
CHANGED
|
@@ -10,10 +10,10 @@ Codex Agent View는 공식 Codex 앱 안에서 여러 workspace의 active task
|
|
|
10
10
|
|
|
11
11
|
### 빠른 시작: 설치 후에는 Codex 앱 안에서만 사용
|
|
12
12
|
|
|
13
|
-
이 README는 `codex-agent-view@0.4.
|
|
13
|
+
이 README는 `codex-agent-view@0.4.4` 사용법을 설명한다. **최초 설치만** 일반 터미널에서 아래 exact-version 명령으로 진행한다.
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install --global codex-agent-view@0.4.
|
|
16
|
+
npm install --global codex-agent-view@0.4.4
|
|
17
17
|
codex-agent-view install
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -25,20 +25,22 @@ codex-agent-view install
|
|
|
25
25
|
2. Codex 앱의 **Plugins** 화면에서 `Codex Agent View`가 설치·활성화됐는지 확인한다.
|
|
26
26
|
3. Hook 검토 화면이 표시되면 `hooks/hooks.json`과 `node "${PLUGIN_ROOT}/scripts/send-hook.mjs"` command를 확인하고 현재 definition을 직접 trust한다. 앱 버전이 hook 검토 UI를 제공하지 않을 때만 설치 과정의 일부로 interactive Codex CLI의 `/hooks`를 사용한다.
|
|
27
27
|
4. 활성화와 hook 검토를 마친 뒤 Codex 앱에서 **새 task**를 만든다. 설치 전에 시작된 task의 과거 event는 재생되지 않는다.
|
|
28
|
-
5. Plugin 카드의 **지금 사용해보기**를
|
|
29
|
-
6. Live 화면을 닫았다면
|
|
28
|
+
5. Plugin 카드의 **지금 사용해보기**를 눌러 새 Codex 앱 task에 `@codex-agent-view` plugin만 선택한다. Plugin 카드는 다음 사용법을 설명할 뿐 starter prompt를 덧붙이거나 평문을 skill 호출처럼 취급하지 않는다.
|
|
29
|
+
6. 그 task에서 bundled `$show-agents` skill을 명시적으로 선택해 호출한다. Live 화면을 닫았다면 `@codex-agent-view`가 선택된 task에서 `$show-agents`를 다시 명시 호출한다.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
**지금 사용해보기는 skill 호출이 아니다.** Codex plugin의 `interface.defaultPrompt`는 starter text이며, `$show-agents`처럼 보이는 text도 skill 선택으로 해석된다고 보장되지 않는다. 따라서 Codex Agent View는 plugin 카드 starter prompt를 정의하지 않는다. `@codex-agent-view`로 plugin을 선택한 다음 Codex 앱의 skill UI에서 `$show-agents`를 명시적으로 선택한다. 일반 사용에는 terminal command, 외부 browser 또는 localhost URL 관리가 필요 없다.
|
|
32
32
|
|
|
33
33
|
Trust된 첫 hook이 도착하면 plugin sender가 로컬 backend를 내부적으로 준비하고 같은 event 전달을 재시도한다. 사용자는 task ID를 등록하거나 `start`, `status`, `doctor`를 실행할 필요가 없다. **Show Agents**는 healthy backend를 재사용하고 Codex 앱 안에서 live 화면 열기를 시도한다. 앱이 필요한 Browser capability를 제공하지 않거나 permission이 허용되지 않으면 private URL을 노출하는 대신 화면을 열 수 없다고 안내한다. Tokenized localhost URL은 대화에 노출하지 않으며 외부 browser도 정상 사용 흐름에 포함되지 않는다.
|
|
34
34
|
|
|
35
|
-
공개 Codex plugin API에는 prompt 없이 앱 시작과 동시에 sidebar, panel 또는 Browser tab을 생성하는 기능이 없다. 따라서 live 화면을 열 때
|
|
35
|
+
공개 Codex plugin API에는 prompt 없이 앱 시작과 동시에 sidebar, panel 또는 Browser tab을 생성하는 기능이 없다. 따라서 live 화면을 열 때 Codex 앱 안에서 `$show-agents` skill을 한 번 명시 선택해야 한다. 이미 오른쪽에 열린 live tab은 2초마다 자동 갱신하고, backend가 같은 loopback origin으로 돌아오면 일시 연결 단절·monitor 재시작·package upgrade 뒤에도 자동 재연결한다. Live view를 호출한 task 자신은 앱이 제공한 `CODEX_THREAD_ID`로 제외하므로 viewer task가 목록 위에 반복 노출되지 않는다. Monitor가 재시작되면 live 관찰 window는 새로 시작하며 read-only viewer credential만 유지된다.
|
|
36
|
+
|
|
37
|
+
Live UI의 기본 언어는 영어이며 language selector에서 **English**, **한국어**, **Español**을 고를 수 있다. 활동과 기술 metadata는 refresh 때 접히는 disclosure toggle 없이 항상 보이고, 2초 polling 간격은 그대로 유지한다. 실제 확인한 `SubagentStart` payload는 `agent_id`, `agent_type`만 제공하며 전용 작업 설명 field가 없다. 따라서 monitor는 prompt나 tool input을 보존해 agent 할당 작업을 추론하거나 표시하지 않는다.
|
|
36
38
|
|
|
37
39
|
요약하면 설치는 터미널에서 한 번, 조회·상태 확인·live 화면 열기와 이후 사용은 Codex 앱 안에서 수행한다.
|
|
38
40
|
|
|
39
41
|
### 현재 상태
|
|
40
42
|
|
|
41
|
-
|
|
43
|
+
`0.4.4`에는 다음 구성이 포함되어 있다.
|
|
42
44
|
|
|
43
45
|
- 공식 Codex 앱의 내장 thread tools를 우선 사용하는 app-native active-task snapshot skill
|
|
44
46
|
- `.codex-plugin/plugin.json`, local marketplace catalog, genuine Codex skill
|
|
@@ -70,18 +72,23 @@ Maintainer npm 2FA는 `auth-and-writes` mode로 활성화됐고 `codex-agent-vie
|
|
|
70
72
|
|
|
71
73
|
공개 `0.4.0` release 당시 evidence: npm `latest`/version, Apache-2.0 license, executable mapping, registry signature, 25 files, package size `52614 B`, unpacked size `189181 B`, shasum `cc379e593f4cafa5dd56f32e6741eab5ba3f4497`와 exact SRI를 확인했다. Registry tarball은 release tarball과 byte-identical이다. Exact tarball publish로 npm metadata에 `gitHead`가 없으므로 그 field를 통한 source 일치는 주장하지 않는다. Annotated `v0.4.0` tag는 release commit `11f7b0511a39c5f5a61cb6da7b91fb3b8e915c6b`을 가리키고 [GitHub Release v0.4.0](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.0), main/tag CI가 공개·성공했다. 이 기기에 public exact `0.4.0`을 다시 설치해 CLI/plugin version 일치, installed/enabled, hook wiring 9종과 실제 sessions 7개 event 수신을 확인했다. Show Agents Browser request는 재설치 중 계속 열려 있던 app process에서 `queued`였고 tab을 관찰하지 못했으므로 앱 완전 재시작/new task 전까지 exact visual-panel E2E 완료는 주장하지 않는다.
|
|
72
74
|
|
|
73
|
-
`0.4.0` known issue: manifest의 `defaultPrompt: ["Show Agents"]`는 평문 plugin-level text starter였다. 이 text는 implicit invocation이 disabled된 `show-agents` skill을
|
|
75
|
+
`0.4.0` known issue: manifest의 `defaultPrompt: ["Show Agents"]`는 평문 plugin-level text starter였다. 이 text는 implicit invocation이 disabled된 `show-agents` skill을 호출하지 않으므로 plugin 카드나 **바로 사용하기** 동작 자체를 skill 실행으로 취급한 안내는 잘못이었다. `0.4.1`은 이를 `Open @ and select the bundled Show Agents skill.`이라는 instructional starter로 교체했지만, 이것도 호출이 아니라 안내였다. 현재 source는 plugin `interface.defaultPrompt`를 완전히 제거한다. **지금 사용해보기**는 `@codex-agent-view`만 선택하고 사용자가 Codex 앱에서 `$show-agents`를 명시 선택한다. 각 public release와 exact app E2E evidence는 별도로 검증해 기록한 범위에서만 주장한다.
|
|
74
76
|
|
|
75
77
|
공개 `0.4.1`: npm `latest`/version, Apache-2.0 license, executable mapping, registry signature, 25 files, package size `53650 B`, unpacked size `193424 B`, shasum `ee2ae0b8b36016f5c57bade067027202b1508d1d`, integrity `sha512-WC4f5MPmvpkXeKM+1BVAYqW4+hoaUrB4yQFoUYgc0pnjyY7hP1CdSR5NJ3QWmvJ6Ikmmb1d+58UL4hkKoyhm1Q==`를 확인했다. Release tarball과 registry tarball은 byte-identical이다. Exact tarball publish로 npm metadata에 `gitHead`가 없으므로 그 field를 통한 source 일치는 주장하지 않는다. Annotated `v0.4.1` tag는 commit `a1de67be5413fa38b8dd1b62f74353463f6e641e`을 가리키며 [GitHub Release v0.4.1](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.1), main CI run `30710490358`, tag CI run `30710848474`가 공개·성공했다. 이 기기의 CLI/plugin은 `0.4.1`로 일치하고 plugin installed/enabled 및 hook wiring 9종을 확인했다. Runtime은 install 교체 중 정상 종료돼 현재 `monitor_not_running`이고 persisted hook trust는 `unknown`이다. Codex 앱 process가 설치 전부터 열려 있었으므로 앱 완전 재시작/new task 전까지 direct **Show Agents** visual E2E는 미확인이다.
|
|
76
78
|
|
|
77
|
-
`0.4.2
|
|
79
|
+
공개 `0.4.2`는 plugin starter text를 `$show-agents`로 바꾸고 앱 내 재오픈 shortcut으로 의도했다. 후속 실제 앱 사용에서는 이 plugin-card starter가 bundled skill을 dispatch하지 않고 평문으로 남을 수 있음을 확인했으므로 이 문단은 더 이상 자동 skill 실행을 주장하지 않는다. Release commit `b4d923a`와 `3d8f46d`를 push했고 main CI run `30712375726`이 Node.js 18/20/22에서 통과했다. npm publish 뒤 `latest: 0.4.2`, Apache-2.0, 예상 executable mapping, 25 files, registry signature, shasum `fac95689395baa26f4ad9ff0cbefd0017d2ebd8d`, integrity `sha512-FRTPoYxjBuPC6Usb+ylSfZsZVJKlKcHnQPaAPljekg0maTPn9POsBkS+auOcHz5jspg0AXcP8R63PM0WfCn2LQ==`를 확인했다. Release/registry tarball은 byte-identical이고 annotated `v0.4.2` tag와 [GitHub Release v0.4.2](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.2)가 공개됐다. 이 기기의 exact global install, plugin installed/enabled, hook wiring 9종, installed artifact 일치와 공식 Codex in-app Browser visual E2E도 확인했다.
|
|
80
|
+
|
|
81
|
+
공개 `0.4.3`은 기존 앱 전용 사용 흐름을 유지하면서 live 화면 인증을 runtime 제어 권한에서 분리한다. 사용자 전용 private viewer credential은 설치 수명 동안 유지되고 `/api/state` 읽기만 허용한다. Hook event ingest와 shutdown에 사용하는 runtime/control token은 별도이며 monitor process와 함께 교체된다. `0.4.2`에서 upgrade할 때 viewer credential이 아직 없고 legacy runtime record가 유효하면 기존 token으로 viewer credential을 seed하되 값을 출력하지 않는다. 따라서 이미 열린 Codex live tab은 같은 loopback origin에서 backend가 다시 시작되면 재연결할 수 있다. 다만 task/event state는 계속 process-local bounded memory뿐이므로 monitor restart 뒤에는 빈 새 관찰 window가 시작된다.
|
|
82
|
+
|
|
83
|
+
Release commit `a7d938c`와 `e2b0543`을 push했고 main CI run `30713618590`이 Node.js 18/20/22에서 통과했다. npm `latest`/version `0.4.3`, Apache-2.0, 25 files, registry signature, shasum `2dee6bb0ae8c7b4bf505b72cf10d9ec42d5afbc7`, integrity `sha512-E0Ljs2nDuBBme9UTu66kaW66eCp8mW7BfunLaK5y3u0CVCSjRtCfC9MAJjQA91yQYpeZ1Wj2sKy7d2CW04ZOPw==`를 확인했고 local release/registry tarball은 byte-identical이다. 이 기기의 exact global `0.4.3`, plugin installed/enabled, installed artifact 일치, hook wiring 9종과 `doctor` event 수신도 확인했다. 공식 Codex in-app Browser migration E2E에서는 연결된 `0.4.2` legacy tab이 install 중 old monitor shutdown 동안 인증 오류 없이 재시도 상태를 유지했고, `0.4.3` hook sender가 monitor를 auto-start한 뒤 같은 tab이 재연결되어 workspace와 agent를 표시했다. Annotated `v0.4.3` tag는 `dea9f39890387ed509cfa0bb511c8167abe11148`을 가리키며 [GitHub Release v0.4.3](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.3)은 public, draft false, prerelease false다. Final main docs CI `30714110050`과 tag CI `30714144940`도 성공했다.
|
|
78
84
|
|
|
79
85
|
### 제품 경계
|
|
80
86
|
|
|
81
87
|
Codex Agent View는 historical audit이나 session replay 제품이 아니라 현재 활동을 보여주는 live companion이다. Bounded in-memory state와 monitor 재시작 시 reset은 privacy와 단순한 failure boundary를 위한 의도된 완성 설계다. SQLite/영구 history는 누락된 요구사항이 아니다. 실제 사용자 요구가 입증될 때에만 retention, migration, deletion, privacy 비용을 별도 검토하는 명시적 opt-in 기능 후보로 취급한다.
|
|
82
88
|
|
|
83
89
|
- 앱 안의 현재 task snapshot은 공식 Codex 앱이 제공하는 내장 thread tools의 explicit status와 `subAgentActivity`를 우선 사용한다.
|
|
84
|
-
- Hook event는 local monitor의 세부 lifecycle 상태에 대한 source of truth다. Monitor state는 bounded memory에만 있고 재시작하면 새 관찰 window가 시작된다.
|
|
90
|
+
- Hook event는 local monitor의 세부 lifecycle 상태에 대한 source of truth다. Monitor state는 bounded memory에만 있고 재시작하면 새 관찰 window가 시작된다. 별도 private viewer credential은 task history가 아니라 인증 metadata다.
|
|
91
|
+
- Read-only viewer credential은 한 설치 수명 동안 monitor 재시작과 upgrade를 넘어 유지되며, runtime/control token은 별도 process-scoped credential이다.
|
|
85
92
|
- 설치·trust·앱 재시작 뒤 첫 trusted hook이 backend를 자동 준비한다. 이는 monitor process 준비이며 Codex 화면이나 tab을 몰래 생성하는 기능이 아니다.
|
|
86
93
|
- 외부 telemetry, 원격 server, account, 필수 SQLite/영구 event store가 없다.
|
|
87
94
|
- prompt, transcript path, 전체 tool input/output, assistant message를 monitor 상태나 UI에 저장·표시하지 않는다.
|
|
@@ -93,10 +100,10 @@ Codex Agent View는 historical audit이나 session replay 제품이 아니라
|
|
|
93
100
|
|
|
94
101
|
### npm, Codex 앱 live view, Plugins Directory의 역할
|
|
95
102
|
|
|
96
|
-
- Plugin 카드의 **지금
|
|
103
|
+
- Plugin 카드의 **지금 사용해보기**는 `@codex-agent-view`만 선택한다. Starter text를 덧붙이거나 skill을 dispatch한다고 주장하지 않는다. Live view를 열거나 다시 열 때 Codex 앱에서 `$show-agents`를 명시 선택하며, 별도 monitor 실행이나 task ID 등록은 필요 없다.
|
|
97
104
|
- npm은 plugin bundle, 내부 hook sender/runtime과 static UI를 사용자 machine에 배포하는 최초 설치 경로다.
|
|
98
105
|
- Live view는 사용자가 앱 안에서 `$show-agents`를 명시 호출했을 때만 열린다. 외부 website나 telemetry dashboard가 아니다.
|
|
99
|
-
- 공개 plugin API는 앱 시작 시 no-prompt sidebar/panel/Browser tab 생성을 제공하지 않는다. 최초 live view 열기에는 앱 안 skill 선택이 한 번 필요하고, 열린 tab은 같은
|
|
106
|
+
- 공개 plugin API는 앱 시작 시 no-prompt sidebar/panel/Browser tab 생성을 제공하지 않는다. 최초 live view 열기에는 앱 안 skill 선택이 한 번 필요하고, 열린 tab은 같은 설치의 viewer credential과 loopback origin이 유지되는 동안 일시 단절·monitor 재시작·upgrade 뒤에도 자동 갱신·재연결한다.
|
|
100
107
|
- Universal Plugins Directory는 npm의 대체재가 아니다. 공개 directory의 in-app custom UI 경로는 public HTTPS MCP server와 domain verification이 필요해 local-only/no-external-server 원칙과 충돌한다. 현재는 별도의 listing/skills 제출 가능성만 검토하며, 심사·publish 전에는 Codex plugin 검색으로 설치할 수 있다고 안내하지 않는다.
|
|
101
108
|
|
|
102
109
|
Hook event가 누락·중복·역순으로 올 수 있으므로 UI의 `unknown`, `stopped_without_start`, 빈 상태는 그대로 해석해야 한다. 빈 session 목록은 “이 monitor가 event를 관찰하지 못함”이며 “실행 중인 task가 없음”의 증거가 아니다.
|
|
@@ -105,12 +112,13 @@ Hook event가 누락·중복·역순으로 올 수 있으므로 UI의 `unknown`,
|
|
|
105
112
|
|
|
106
113
|
이 절차는 위의 빠른 시작에서 설치와 활성화를 마친 뒤 **새 task**에서 수행한다. 별도 terminal이나 외부 browser는 사용하지 않는다.
|
|
107
114
|
|
|
108
|
-
1. Codex Agent View plugin 카드의 **지금 사용해보기**를 누른다.
|
|
109
|
-
2. Skill은 trusted hook이 자동 준비한 healthy backend를 재사용하고, 아직 준비되지 않았다면 내부적으로 준비한 뒤
|
|
110
|
-
3. Panel은 실행 중인 부모 task와 subagent를 먼저
|
|
111
|
-
4.
|
|
115
|
+
1. Codex Agent View plugin 카드의 **지금 사용해보기**를 누른다. 이 동작은 `@codex-agent-view`만 선택하며 prompt를 제출하거나 skill을 호출하지 않는다.
|
|
116
|
+
2. Codex 앱에서 bundled `$show-agents` skill을 명시 선택한다. Skill은 trusted hook이 자동 준비한 healthy backend를 재사용하고, 아직 준비되지 않았다면 내부적으로 준비한 뒤 앱에서 live 화면 열기를 시도한다.
|
|
117
|
+
3. Panel은 `CODEX_THREAD_ID`로 이 viewer 호출 task를 제외하고, 나머지 실행 중인 부모 task와 subagent를 먼저 배치하며 사람이 읽을 수 있는 workspace/task/agent label과 상태 문구를 표시한다. Raw session/agent ID와 기술 metadata는 2초 polling 때 접히는 toggle 없이 진단용 inline 정보로 항상 보인다. Prompt, preview, tool input/output과 full workspace path는 표시하지 않는다.
|
|
118
|
+
4. Language selector에서 **English**, **한국어**, **Español**을 선택한다. 기본값은 영어이고 언어 전환 뒤에도 2초 refresh는 유지된다.
|
|
119
|
+
5. 앱의 Browser capability 또는 permission을 사용할 수 없으면 private localhost URL을 노출하거나 외부 browser를 여는 대신 실패를 안내한다.
|
|
112
120
|
|
|
113
|
-
오른쪽 live 화면을 닫았다면 Codex 앱 task
|
|
121
|
+
오른쪽 live 화면을 닫았다면 Codex 앱 task에서 `@codex-agent-view`를 선택하고 `$show-agents`를 다시 명시 호출한다. 붙여 넣은 `@codex-agent-view $show-agents` 문자열이 skill 선택으로 재해석된다고 가정하지 않는다. 열린 tab은 일시 단절·monitor 재시작·upgrade 뒤에도 자동 재연결한다. 재시작된 monitor는 과거 event를 재생하지 않고 새 in-memory 관찰 window를 표시한다.
|
|
114
122
|
|
|
115
123
|
### 요구사항과 검증 범위
|
|
116
124
|
|
|
@@ -173,7 +181,7 @@ node bin/codex-agent-view.mjs install
|
|
|
173
181
|
|
|
174
182
|
### Maintainer·고급 진단 전용 CLI
|
|
175
183
|
|
|
176
|
-
이 절은 package 개발자와 문제 보고를 위한 진단 참고 자료이며 일반 사용자 사용법이 아니다. 설치가 끝난 사용자는 plugin
|
|
184
|
+
이 절은 package 개발자와 문제 보고를 위한 진단 참고 자료이며 일반 사용자 사용법이 아니다. 설치가 끝난 사용자는 plugin 카드 또는 앱 picker에서 `@codex-agent-view`를 선택한 뒤 Codex 앱 안에서 `$show-agents`를 명시 선택한다. 아래 명령과 localhost 주소를 정상 사용 순서에 넣거나 사용자에게 직접 관리하도록 요구하지 않는다.
|
|
177
185
|
|
|
178
186
|
Source checkout에서 local runtime을 별도로 검증해야 할 때만 다음처럼 실행할 수 있다.
|
|
179
187
|
|
|
@@ -203,24 +211,24 @@ Plugin enable/trust와 앱 재시작 뒤 생성되거나 재개되는 task는 tr
|
|
|
203
211
|
|
|
204
212
|
### npm 설치 명령 참고
|
|
205
213
|
|
|
206
|
-
아래 명령은 `0.4.
|
|
214
|
+
아래 명령은 `0.4.4`를 exact version으로 설치한다.
|
|
207
215
|
|
|
208
216
|
```bash
|
|
209
|
-
npm install --global codex-agent-view@0.4.
|
|
217
|
+
npm install --global codex-agent-view@0.4.4
|
|
210
218
|
codex-agent-view install
|
|
211
219
|
```
|
|
212
220
|
|
|
213
|
-
이 두 명령 뒤에는 Codex 앱을 완전히 다시 열고 Plugins 화면에서 설치·활성화와 hook trust를 확인한 다음 새 task를 만든다. 첫 trusted hook이 backend 준비와 event 전달을 내부 처리하므로 사용자가 monitor CLI를 실행하지 않는다. Plugin 카드의 **지금 사용해보기**로
|
|
221
|
+
이 두 명령 뒤에는 Codex 앱을 완전히 다시 열고 Plugins 화면에서 설치·활성화와 hook trust를 확인한 다음 새 task를 만든다. 첫 trusted hook이 backend 준비와 event 전달을 내부 처리하므로 사용자가 monitor CLI를 실행하지 않는다. Plugin 카드의 **지금 사용해보기**로 `@codex-agent-view`를 선택하고 앱에서 `$show-agents`를 명시 선택한다. Panel을 닫은 뒤에도 같은 방식으로 skill을 다시 선택한다.
|
|
214
222
|
|
|
215
|
-
`0.4.
|
|
223
|
+
`0.4.4` 설치 경로는 위의 global package 설치와 명시적인 `codex-agent-view install` command 조합이다. 이후 일반 사용은 Codex 앱 안에서 진행한다. 이전의 유효한 설치에서 upgrade하면 installation-owned read-only viewer credential을 유지하며, `0.4.3`에서 검증한 legacy `0.4.2` migration 동작도 그대로 보존한다. Token과 private URL은 출력하지 않는다.
|
|
216
224
|
|
|
217
|
-
|
|
225
|
+
Version별 npm, install, migration, CI, tag와 GitHub Release evidence는 [docs/distribution.md](docs/distribution.md)에 보존한다. 각 evidence는 실제 확인한 뒤에만 갱신한다.
|
|
218
226
|
|
|
219
227
|
npm install 자체는 Codex 설정을 자동 변경하지 않는다. `install` command는 사용자가 명시적으로 실행하며 hook trust도 사용자 검토로 남긴다. npm publish와 Universal Plugins Directory 제출은 서로 별도 절차다. 자세한 배포 경계는 [docs/distribution.md](docs/distribution.md), directory 제출 상태는 [docs/plugin-submission.md](docs/plugin-submission.md)를 참고한다.
|
|
220
228
|
|
|
221
229
|
### Privacy와 opt-in diagnostic capture
|
|
222
230
|
|
|
223
|
-
정상 hook 경로는 `scripts/send-hook.mjs`다. 이 sender는 allowlisted metadata만 값으로 남기고 나머지는 type/key/length summary로 바꾼 뒤 loopback으로 보낸다. 전체 `cwd` 대신 control character를 제거하고 120자로 제한한 basename `workspace_label`만 파생한다. Runtime reducer는 lifecycle field와 이 label을 bounded memory에만 유지한다.
|
|
231
|
+
정상 hook 경로는 `scripts/send-hook.mjs`다. 이 sender는 allowlisted metadata만 값으로 남기고 나머지는 type/key/length summary로 바꾼 뒤 loopback으로 보낸다. 전체 `cwd` 대신 control character를 제거하고 120자로 제한한 basename `workspace_label`만 파생한다. Runtime reducer는 lifecycle field와 이 label을 bounded memory에만 유지한다. 재연결용 private viewer credential에는 task나 hook event 상태가 들어가지 않는다.
|
|
224
232
|
|
|
225
233
|
정상 monitor는 event JSONL을 쓰지 않는다. `scripts/capture-hook.mjs`는 Phase 0 검증용 별도 diagnostic script이며 누군가 명시적으로 실행하거나 hook에 연결할 때만 `events.jsonl`을 만든다.
|
|
226
234
|
|
|
@@ -236,7 +244,7 @@ npm install 자체는 Codex 설정을 자동 변경하지 않는다. `install` c
|
|
|
236
244
|
codex-agent-view uninstall
|
|
237
245
|
```
|
|
238
246
|
|
|
239
|
-
`uninstall`은 runtime
|
|
247
|
+
`uninstall`은 runtime/control token으로 loopback endpoint를 인증하고 Codex Agent View 소유의 healthy monitor인지 확인한 뒤 internal shutdown을 요청한다. 종료가 확인돼야 plugin 등록, marketplace 등록과 copied marketplace bundle을 제거한다. 정상 owned viewer credential은 기본 uninstall과 `--purge` 모두에서 폐기되며 나중에 다시 설치하면 다른 credential을 만든다. Runtime directory의 관련 없는 나머지 data는 기본적으로 보존한다. Viewer credential이 malformed, changed, symbolic 또는 그 밖의 unrecognized 상태라면 임의로 삭제하지 않고 manual review용으로 보존했다는 경고를 출력한다. 인증된 소유 monitor를 안전하게 종료할 수 없거나 endpoint가 다른 service로 판별되면 plugin과 runtime files를 보존한 채 실패한다.
|
|
240
248
|
|
|
241
249
|
사용자가 configured runtime directory의 소유 data까지 제거하길 명시적으로 원할 때만 다음을 사용한다.
|
|
242
250
|
|
|
@@ -244,7 +252,7 @@ codex-agent-view uninstall
|
|
|
244
252
|
codex-agent-view uninstall --purge
|
|
245
253
|
```
|
|
246
254
|
|
|
247
|
-
`--purge`도 owned monitor를 같은 방식으로 먼저
|
|
255
|
+
`--purge`도 owned monitor를 같은 방식으로 먼저 종료하고 정상 viewer credential을 폐기한 뒤, owned stale runtime file과 비어 있는 runtime directory만 추가 제거한다. 형식을 알 수 없는 runtime file·viewer credential과 관련 없는 loopback service는 삭제하거나 종료하지 않는다. Unrecognized file은 경고와 함께 그대로 보존하며, unrelated endpoint가 확인되면 plugin과 runtime files를 모두 보존한 채 중단한다. Opt-in capture나 다른 file 때문에 directory가 비어 있지 않으면 directory 자체도 보존한다.
|
|
248
256
|
|
|
249
257
|
Source checkout을 직접 실행한 경우에만 같은 명령의 `node bin/codex-agent-view.mjs uninstall` 또는 `node bin/codex-agent-view.mjs uninstall --purge` 형식을 사용한다.
|
|
250
258
|
|
|
@@ -252,7 +260,7 @@ Source checkout을 직접 실행한 경우에만 같은 명령의 `node bin/code
|
|
|
252
260
|
|
|
253
261
|
### Maintainer troubleshooting
|
|
254
262
|
|
|
255
|
-
이 절의 CLI 확인은 명시적인 문제 조사용이다. 정상 사용자는 plugin
|
|
263
|
+
이 절의 CLI 확인은 명시적인 문제 조사용이다. 정상 사용자는 plugin 카드 또는 앱 picker에서 `@codex-agent-view`를 선택하고 `$show-agents`를 명시 선택한다.
|
|
256
264
|
|
|
257
265
|
#### `status`가 runtime file 또는 connection error를 출력함
|
|
258
266
|
|
package/README.md
CHANGED
|
@@ -8,12 +8,12 @@ Codex Agent View is a read-only companion plugin that shows privacy-minimized ac
|
|
|
8
8
|
|
|
9
9
|
## Quick start: install once, then stay inside the Codex app
|
|
10
10
|
|
|
11
|
-
This README documents
|
|
11
|
+
This README documents `codex-agent-view@0.4.4`. Use the exact-version command below for the one-time terminal installation.
|
|
12
12
|
|
|
13
13
|
Universal Plugins Directory search installation is not available yet, so use a regular terminal for the **initial installation only**:
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install --global codex-agent-view@0.4.
|
|
16
|
+
npm install --global codex-agent-view@0.4.4
|
|
17
17
|
codex-agent-view install
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -25,20 +25,22 @@ After installation:
|
|
|
25
25
|
2. In the Codex app's **Plugins** screen, confirm that `Codex Agent View` is installed and enabled.
|
|
26
26
|
3. If a hook-review screen is shown, inspect `hooks/hooks.json` and the `node "${PLUGIN_ROOT}/scripts/send-hook.mjs"` command, then explicitly trust the current definition. Use interactive Codex CLI `/hooks` only as part of installation when the app version does not expose hook review.
|
|
27
27
|
4. After enablement and hook review, create a **new task** in the Codex app. Events that occurred before installation are not replayed.
|
|
28
|
-
5. On the plugin card, select **Quick start
|
|
29
|
-
6. If you close the live view,
|
|
28
|
+
5. On the plugin card, select **Quick start** to add only the `@codex-agent-view` plugin mention to a new Codex app task. The plugin card explains the next step; it does not append a starter prompt or pretend that plain text can dispatch a skill.
|
|
29
|
+
6. In that task, explicitly select or invoke the bundled `$show-agents` skill. If you close the live view, invoke `$show-agents` again from a task that has the `@codex-agent-view` plugin selected.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
**Quick start is not a skill invocation.** Codex plugin `interface.defaultPrompt` values are starter text, and text that looks like `$show-agents` is not guaranteed to be interpreted as a skill selection. Codex Agent View therefore defines no plugin-card starter prompt. Select the plugin with `@codex-agent-view`, then explicitly select `$show-agents` using the Codex app's skill UI. Routine use still requires neither a terminal command, an external browser, nor a localhost URL.
|
|
32
32
|
|
|
33
33
|
When the first trusted hook arrives, the plugin sender internally prepares the local backend and retries delivery of that same event. Users do not register task IDs or run `start`, `status`, or `doctor`. **Show Agents** reuses the healthy backend and attempts to open the live view in the Codex app without exposing a tokenized localhost URL or using an external browser. If the app does not provide the required Browser capability or permission, the skill reports that it could not open the view instead of exposing a private URL.
|
|
34
34
|
|
|
35
|
-
The public Codex plugin API does not provide no-prompt app-start creation of a sidebar, panel, or Browser tab. Opening the live view therefore requires
|
|
35
|
+
The public Codex plugin API does not provide no-prompt app-start creation of a sidebar, panel, or Browser tab. Opening the live view therefore requires one explicit `$show-agents` skill selection inside the Codex app. Once the right-side live tab is open, it refreshes every two seconds and automatically reconnects after a temporary disconnect, monitor restart, or package upgrade when the backend returns on the same loopback origin. The task that invoked the live view is excluded using the app-provided `CODEX_THREAD_ID`, so the monitor does not keep promoting its own viewer task. The live observation window still resets when the monitor process restarts; only the read-only viewer credential survives.
|
|
36
|
+
|
|
37
|
+
The live UI defaults to English and offers **English**, **Korean**, and **Spanish** in its language selector. Activity and technical metadata are always visible rather than hidden behind refresh-sensitive disclosure toggles. The two-second polling interval is unchanged. Verified `SubagentStart` payloads provide only `agent_id` and `agent_type`; they do not provide a dedicated assignment description. The monitor therefore does not display or infer an agent's assigned task from prompt or tool input, because those values are intentionally not retained.
|
|
36
38
|
|
|
37
39
|
In short: install once in a terminal; perform snapshot queries, status checks, live-view opening, and all routine use inside the Codex app.
|
|
38
40
|
|
|
39
41
|
## Status
|
|
40
42
|
|
|
41
|
-
|
|
43
|
+
Version `0.4.4` includes an app-native snapshot skill that prioritizes the official Codex app's built-in thread tools, privacy-minimized hooks, a bounded in-memory reducer, a trusted-hook auto-prepared token-authenticated `127.0.0.1` live backend, and explicit install/remove plus maintainer-diagnostic CLI commands.
|
|
42
44
|
|
|
43
45
|
Plugin installation and lifecycle payloads were verified with Homebrew Codex CLI and the Codex executable embedded in the official app. However, a real-use attempt that installed and enabled `0.2.0` in an already-running official app process delivered zero events while two subagents ran. The monitor, registration, enablement, and installed bundle were healthy, while app logs showed no sender invocation. Evidence indicates that the same process retained a pre-install `hooks/list` snapshot; persisted exact-hook trust is not exposed through CLI JSON, so the precise skip boundary remains unconfirmed.
|
|
44
46
|
|
|
@@ -60,18 +62,23 @@ Public `0.3.2`: npm version/`latest` at release time `0.3.2`, `gitHead` `4f4f92d
|
|
|
60
62
|
|
|
61
63
|
Public `0.4.0` evidence at the time of that release: npm `latest`/version, Apache-2.0 license, executable mapping, registry signature, 25 files, package size `52614 B`, unpacked size `189181 B`, shasum `cc379e593f4cafa5dd56f32e6741eab5ba3f4497`, and exact SRI were verified. The registry tarball is byte-identical to the release tarball. npm metadata has no `gitHead` because the exact tarball was published, so source identity is not claimed through that field. The annotated `v0.4.0` tag points to release commit `11f7b0511a39c5f5a61cb6da7b91fb3b8e915c6b`; [GitHub Release v0.4.0](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.0) and both main/tag CI runs are public and successful. This machine was reinstalled from public exact `0.4.0`; CLI/plugin versions match, the plugin is installed/enabled, all nine hooks are wired, and the monitor reports real events across seven sessions. The Show Agents Browser request was queued in the app process that remained open during reinstall, but its tab was not observable, so exact visual-panel E2E is not claimed until a full app restart and new task.
|
|
62
64
|
|
|
63
|
-
Known `0.4.0` issue: manifest `defaultPrompt: ["Show Agents"]` created a plain plugin-level text starter. That text did not
|
|
65
|
+
Known `0.4.0` issue: manifest `defaultPrompt: ["Show Agents"]` created a plain plugin-level text starter. That text did not invoke the `show-agents` skill, whose implicit invocation was disabled, so treating the plugin card or its Quick start action as skill execution was incorrect. Version `0.4.1` replaced it with the instructional starter `Open @ and select the bundled Show Agents skill.`, but that starter was still guidance rather than invocation. The current source removes plugin `interface.defaultPrompt` entirely: Quick start selects only `@codex-agent-view`, and the user explicitly selects `$show-agents` in the Codex app. Public registry and exact app E2E evidence for each release are claimed only where separately verified and recorded.
|
|
64
66
|
|
|
65
67
|
Public `0.4.1`: npm `latest`/version, Apache-2.0 license, executable mapping, registry signature, 25 files, package size `53650 B`, unpacked size `193424 B`, shasum `ee2ae0b8b36016f5c57bade067027202b1508d1d`, and integrity `sha512-WC4f5MPmvpkXeKM+1BVAYqW4+hoaUrB4yQFoUYgc0pnjyY7hP1CdSR5NJ3QWmvJ6Ikmmb1d+58UL4hkKoyhm1Q==` were verified. The release tarball and registry tarball are byte-identical. npm metadata has no `gitHead` because the exact tarball was published, so source identity is not claimed through that field. The annotated `v0.4.1` tag points to commit `a1de67be5413fa38b8dd1b62f74353463f6e641e`; [GitHub Release v0.4.1](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.1), main CI run `30710490358`, and tag CI run `30710848474` are public and successful. This machine has matching CLI/plugin `0.4.1`, the plugin is installed/enabled, and all nine hooks are wired. The runtime was cleanly stopped while installation replaced it, so it currently reports `monitor_not_running`; persisted hook trust remains `unknown`. Because the Codex app process predates installation, direct **Show Agents** visual E2E remains unverified until a full app restart and a new task.
|
|
66
68
|
|
|
67
|
-
|
|
69
|
+
Public `0.4.2` changed the plugin starter text to `$show-agents` and intended it as an in-app reopen shortcut. Real app use later showed that this plugin-card starter could remain plain text rather than dispatching the bundled skill; this paragraph no longer claims otherwise. Release commits `b4d923a` and `3d8f46d` were pushed, main CI run `30712375726` passed on Node.js 18/20/22, and npm publication was verified with `latest: 0.4.2`, Apache-2.0 licensing, the expected executable mapping, 25 files, registry signature, shasum `fac95689395baa26f4ad9ff0cbefd0017d2ebd8d`, and integrity `sha512-FRTPoYxjBuPC6Usb+ylSfZsZVJKlKcHnQPaAPljekg0maTPn9POsBkS+auOcHz5jspg0AXcP8R63PM0WfCn2LQ==`. The release and registry tarballs are byte-identical; annotated tag `v0.4.2` and [GitHub Release v0.4.2](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.2) are public. This machine's exact global install, plugin installed/enabled state, all nine hook declarations, installed artifact match, and official Codex in-app Browser visual E2E were also verified.
|
|
70
|
+
|
|
71
|
+
Public `0.4.3` preserves that app-only workflow and adds restart-safe live-view authentication. A user-only private viewer credential is separate from the runtime/control token and persists for the installed plugin's lifetime. The viewer credential can read `/api/state` but cannot ingest hook events or request shutdown; the runtime/control token rotates with the monitor process. Installing `0.4.3` over `0.4.2` seeds a missing viewer credential from the valid legacy runtime token without printing it, so an already-open Codex live tab can reconnect after the backend restarts on the same loopback origin. This credential continuity does not persist task state: restart still begins an empty bounded in-memory observation window.
|
|
72
|
+
|
|
73
|
+
Release commits `a7d938c` and `e2b0543` were pushed, and main CI run `30713618590` passed on Node.js 18/20/22. npm `latest`/version `0.4.3`, Apache-2.0 licensing, 25 files, registry signature, shasum `2dee6bb0ae8c7b4bf505b72cf10d9ec42d5afbc7`, and integrity `sha512-E0Ljs2nDuBBme9UTu66kaW66eCp8mW7BfunLaK5y3u0CVCSjRtCfC9MAJjQA91yQYpeZ1Wj2sKy7d2CW04ZOPw==` were verified. The local release and registry tarballs are byte-identical. This machine's exact global `0.4.3` install, installed/enabled plugin, copied artifact match, all nine hooks, and `doctor` event observation were verified. In the official Codex in-app Browser migration E2E, an open `0.4.2` legacy tab stayed in retrying state without an authentication error during shutdown, then reconnected to the hook-auto-started `0.4.3` monitor and rendered the workspace and agent. Annotated tag `v0.4.3` points to `dea9f39890387ed509cfa0bb511c8167abe11148`; [GitHub Release v0.4.3](https://github.com/JunhoYoon95/codex-agent-view/releases/tag/v0.4.3) is public, non-draft, and non-prerelease. Final main docs CI run `30714110050` and tag CI run `30714144940` succeeded.
|
|
68
74
|
|
|
69
75
|
## Boundaries
|
|
70
76
|
|
|
71
77
|
Codex Agent View is a live companion, not a historical audit or session-replay product. Bounded in-memory state and reset-on-restart semantics are intentional: they keep privacy and failure boundaries small. SQLite or persistent history is not a missing requirement. Consider it only as a separate explicit opt-in feature if demonstrated user demand justifies retention, migration, deletion, and privacy costs.
|
|
72
78
|
|
|
73
79
|
- The app-native current-task snapshot prioritizes explicit status and `subAgentActivity` from the official Codex app's built-in thread tools.
|
|
74
|
-
- Hooks remain the source of truth for detailed lifecycle state in the trusted-hook auto-prepared local live backend. Its operational state exists only in bounded process memory; restart begins a new observation window.
|
|
80
|
+
- Hooks remain the source of truth for detailed lifecycle state in the trusted-hook auto-prepared local live backend. Its operational state exists only in bounded process memory; restart begins a new observation window. The separate private viewer credential is authentication metadata, not stored task history.
|
|
81
|
+
- The viewer credential is read-only and remains stable across monitor restarts and package upgrades during one installation. The runtime/control token remains separate and process-scoped.
|
|
75
82
|
- After installation, hook trust, and an app restart, the first trusted hook automatically prepares the backend. This prepares a local process; it does not create app UI without a user action.
|
|
76
83
|
- There is no external telemetry, remote server, account, required SQLite/persistent event store, or remote control.
|
|
77
84
|
- Prompt text, transcript paths, full tool input/output, and assistant messages are not retained or displayed by the monitor.
|
|
@@ -83,22 +90,23 @@ A separately launched Codex `0.146` App Server `thread/list` fallback was also t
|
|
|
83
90
|
|
|
84
91
|
## The roles of npm, the Codex app live view, and the Plugins Directory
|
|
85
92
|
|
|
86
|
-
- The plugin card's **Quick start** action
|
|
93
|
+
- The plugin card's **Quick start** action selects `@codex-agent-view` only. It does not append starter text or claim to dispatch a skill. Explicitly select `$show-agents` in the Codex app to open or reopen the live view; this requires neither starting a monitor nor registering task IDs.
|
|
87
94
|
- npm is the initial installation path that distributes the plugin bundle, its internal hook sender/runtime, and static UI to the user's machine.
|
|
88
95
|
- The live view opens in the Codex app only after an explicit `$show-agents` skill invocation; it is not an external website or telemetry dashboard.
|
|
89
|
-
- The public plugin API cannot create a sidebar, panel, or Browser tab without a prompt at app startup. The first live view needs one in-app skill selection; an already-open tab refreshes and reconnects
|
|
96
|
+
- The public plugin API cannot create a sidebar, panel, or Browser tab without a prompt at app startup. The first live view needs one in-app skill selection; an already-open tab refreshes and reconnects across temporary disconnects, monitor restarts, and upgrades while the same installation-owned viewer credential and loopback origin remain available.
|
|
90
97
|
- The Universal Plugins Directory does not replace npm. A public in-app custom UI path requires a public HTTPS MCP server and domain verification, which conflicts with this project's local-only, no-external-server boundary. Only a separate listing/skills submission remains under consideration; do not expect Directory search installation until review and publication actually finish.
|
|
91
98
|
|
|
92
99
|
## Use in the official Codex app — recommended
|
|
93
100
|
|
|
94
101
|
Use this flow in a **new task** after completing installation and enablement in the quick start. It requires neither another terminal nor an external browser.
|
|
95
102
|
|
|
96
|
-
1. Select **Quick start** on the Codex Agent View plugin card.
|
|
97
|
-
2. The skill reuses the backend prepared by trusted hooks, or prepares it internally when still absent, then attempts to open the live view in the
|
|
98
|
-
3. The panel puts running parents and subagents first and uses human-readable workspace/task/agent labels and status text. Raw session/agent IDs
|
|
99
|
-
4.
|
|
103
|
+
1. Select **Quick start** on the Codex Agent View plugin card. This selects only `@codex-agent-view`; it does not submit a prompt or invoke a skill.
|
|
104
|
+
2. Explicitly select the bundled `$show-agents` skill in the Codex app. The skill reuses the backend prepared by trusted hooks, or prepares it internally when still absent, then attempts to open the live view in the app.
|
|
105
|
+
3. The panel excludes this invoking viewer task using `CODEX_THREAD_ID`, puts the remaining running parents and subagents first, and uses human-readable workspace/task/agent labels and status text. Raw session/agent IDs and technical metadata remain visible inline for diagnosis, without disclosure toggles that reset during polling. Prompts, previews, tool input/output, and full workspace paths remain hidden.
|
|
106
|
+
4. Choose **English**, **Korean**, or **Spanish** from the language selector. English is the default, and changing language does not stop the two-second refresh.
|
|
107
|
+
5. If the app's Browser capability or permission is unavailable, the skill reports the failure without exposing a private localhost URL or opening an external browser.
|
|
100
108
|
|
|
101
|
-
If you close the right-side live view,
|
|
109
|
+
If you close the right-side live view, select `@codex-agent-view` and explicitly invoke `$show-agents` again in a Codex app task. Do not rely on a pasted `@codex-agent-view $show-agents` string being reparsed as a skill selection. An open tab refreshes and reconnects automatically after temporary disconnects, monitor restarts, and upgrades. A restarted monitor presents a new in-memory observation window rather than replaying earlier activity.
|
|
102
110
|
|
|
103
111
|
## Requirements and tested versions
|
|
104
112
|
|
|
@@ -132,7 +140,7 @@ Review the installed plugin and `hooks/hooks.json`, inspect the `node "${PLUGIN_
|
|
|
132
140
|
|
|
133
141
|
## Maintainer and advanced diagnostics CLI
|
|
134
142
|
|
|
135
|
-
This section is reference material for package maintainers and explicit troubleshooting. It is not the normal user workflow. After installation, users
|
|
143
|
+
This section is reference material for package maintainers and explicit troubleshooting. It is not the normal user workflow. After installation, users select `@codex-agent-view` from the plugin card or app picker, then explicitly select `$show-agents` inside the Codex app; do not make them manage these commands or localhost URLs.
|
|
136
144
|
|
|
137
145
|
Only when validating the local runtime from a source checkout, a maintainer can start it without opening an operating-system browser:
|
|
138
146
|
|
|
@@ -155,18 +163,18 @@ After plugin enablement/trust and an app restart, the first trusted hook interna
|
|
|
155
163
|
|
|
156
164
|
## Install from npm
|
|
157
165
|
|
|
158
|
-
The commands below
|
|
166
|
+
The commands below install `0.4.4` by exact version.
|
|
159
167
|
|
|
160
168
|
```bash
|
|
161
|
-
npm install --global codex-agent-view@0.4.
|
|
169
|
+
npm install --global codex-agent-view@0.4.4
|
|
162
170
|
codex-agent-view install
|
|
163
171
|
```
|
|
164
172
|
|
|
165
|
-
After these two commands, fully reopen the Codex app, verify installation, enablement, and hook trust, then create a new task. The first trusted hook prepares the backend and delivers its event internally, so users do not run monitor CLI commands. Use the plugin card's **Quick start** action to
|
|
173
|
+
After these two commands, fully reopen the Codex app, verify installation, enablement, and hook trust, then create a new task. The first trusted hook prepares the backend and delivers its event internally, so users do not run monitor CLI commands. Use the plugin card's **Quick start** action to select `@codex-agent-view`, then explicitly select `$show-agents` in the app. Repeat that explicit skill selection after closing the panel.
|
|
166
174
|
|
|
167
|
-
The
|
|
175
|
+
The `0.4.4` installation path is the global package install followed by the explicit `codex-agent-view install` command above. Routine use remains inside the Codex app afterward. When upgrading an older valid installation, `install` preserves the installation-owned read-only viewer credential; the legacy `0.4.2` migration behavior remains as documented for `0.4.3`. Neither token nor the private URL is printed.
|
|
168
176
|
|
|
169
|
-
|
|
177
|
+
Version-specific npm, install, migration, CI, tag, and GitHub Release evidence is preserved in [Distribution](docs/distribution.md). That evidence is updated only after each item is actually verified.
|
|
170
178
|
|
|
171
179
|
npm installation does not modify Codex settings automatically. The explicit `install` command performs local plugin registration and leaves hook trust to the user. npm publication and Universal Plugins Directory submission are separate. See [Distribution](docs/distribution.md) and [Plugin submission](docs/plugin-submission.md).
|
|
172
180
|
|
|
@@ -182,7 +190,7 @@ If events are still absent, report the Codex app/CLI version, plugin version, ap
|
|
|
182
190
|
|
|
183
191
|
## Privacy
|
|
184
192
|
|
|
185
|
-
The normal hook path uses `scripts/send-hook.mjs`. It derives only a sanitized, 120-character-bounded workspace basename as `workspace_label`; the full `cwd` is not sent or stored as content. The reducer keeps this label and narrower lifecycle state only in bounded memory. The normal monitor does not write an event JSONL history.
|
|
193
|
+
The normal hook path uses `scripts/send-hook.mjs`. It derives only a sanitized, 120-character-bounded workspace basename as `workspace_label`; the full `cwd` is not sent or stored as content. The reducer keeps this label and narrower lifecycle state only in bounded memory. The normal monitor does not write an event JSONL history. The private viewer credential stored for reconnect continuity contains no task or hook-event state.
|
|
186
194
|
|
|
187
195
|
`scripts/capture-hook.mjs` is a separate, explicitly invoked Phase 0 diagnostic tool. Setting `CODEX_AGENT_VIEW_CAPTURE_FULL=1` for that script can write raw prompts, tool data, credentials, and other secrets. Normal install/start and the bundled skill never enable it automatically. Do not commit or publicly attach captures or runtime tokens.
|
|
188
196
|
|
|
@@ -196,7 +204,7 @@ Uninstall is an explicit terminal lifecycle action, like initial installation. R
|
|
|
196
204
|
codex-agent-view uninstall
|
|
197
205
|
```
|
|
198
206
|
|
|
199
|
-
`uninstall` authenticates to the loopback endpoint with the runtime
|
|
207
|
+
`uninstall` authenticates to the loopback endpoint with the runtime/control token, verifies that it is a healthy owned Codex Agent View monitor, and requests internal shutdown. Only after shutdown is confirmed does it remove plugin/marketplace registration and the copied bundle. A valid owned viewer credential is revoked during both normal uninstall and `--purge`; reinstalling later creates a different credential. Remaining unrelated runtime-directory data is preserved by default. If the viewer credential is malformed, changed, symbolic, or otherwise unrecognized, it is preserved for manual review and the command prints a warning rather than deleting uncertain data. If the owned monitor cannot be stopped safely or the endpoint is identified as another service, plugin and runtime files are preserved and the command fails.
|
|
200
208
|
|
|
201
209
|
Use the following only after explicitly deciding to remove owned data from the configured runtime directory:
|
|
202
210
|
|
|
@@ -204,7 +212,7 @@ Use the following only after explicitly deciding to remove owned data from the c
|
|
|
204
212
|
codex-agent-view uninstall --purge
|
|
205
213
|
```
|
|
206
214
|
|
|
207
|
-
`--purge` performs the same authenticated shutdown first, then additionally removes only an owned stale runtime file and an empty runtime directory. It does not delete or stop an unrecognized runtime file or an unrelated loopback service.
|
|
215
|
+
`--purge` performs the same authenticated shutdown and valid viewer-credential revocation first, then additionally removes only an owned stale runtime file and an empty runtime directory. It does not delete or stop an unrecognized runtime file, an unrecognized viewer credential, or an unrelated loopback service. Unrecognized files are preserved with a warning; an unrelated endpoint aborts removal while preserving plugin and runtime files. A non-empty directory containing opt-in captures or other files is also preserved.
|
|
208
216
|
|
|
209
217
|
For a source checkout only, use the equivalent `node bin/codex-agent-view.mjs uninstall` or `node bin/codex-agent-view.mjs uninstall --purge` form. Opt-in captures outside that directory require separate, exact cleanup.
|
|
210
218
|
|
package/bin/codex-agent-view.mjs
CHANGED
|
@@ -17,10 +17,14 @@ import { fileURLToPath } from "node:url";
|
|
|
17
17
|
import { startMonitorServer } from "../src/runtime/server.mjs";
|
|
18
18
|
import {
|
|
19
19
|
DEFAULT_PORT,
|
|
20
|
+
ensureViewerToken,
|
|
20
21
|
readRuntimeInfo,
|
|
22
|
+
readViewerToken,
|
|
21
23
|
removeRuntimeInfo,
|
|
24
|
+
removeViewerToken,
|
|
22
25
|
runtimeDirectory,
|
|
23
26
|
runtimeFile,
|
|
27
|
+
viewerCredentialFile,
|
|
24
28
|
} from "../src/runtime/config.mjs";
|
|
25
29
|
|
|
26
30
|
const PACKAGE_ROOT = resolve(fileURLToPath(new URL("../", import.meta.url)));
|
|
@@ -167,7 +171,11 @@ async function start(args) {
|
|
|
167
171
|
throw new Error("a Codex Agent View monitor is already running; stop it before starting another");
|
|
168
172
|
}
|
|
169
173
|
|
|
170
|
-
const
|
|
174
|
+
const viewerToken = await ensureViewerToken();
|
|
175
|
+
const monitor = await startMonitorServer({
|
|
176
|
+
port: options.port,
|
|
177
|
+
viewerToken,
|
|
178
|
+
});
|
|
171
179
|
let stopping = false;
|
|
172
180
|
const stop = async () => {
|
|
173
181
|
if (stopping) return;
|
|
@@ -442,6 +450,39 @@ async function inspectRuntime() {
|
|
|
442
450
|
}
|
|
443
451
|
}
|
|
444
452
|
|
|
453
|
+
async function inspectViewerCredential() {
|
|
454
|
+
const path = viewerCredentialFile();
|
|
455
|
+
const stats = await pathExists(path);
|
|
456
|
+
if (!stats) {
|
|
457
|
+
return { kind: "absent", path };
|
|
458
|
+
}
|
|
459
|
+
if (!stats.isFile() || stats.isSymbolicLink()) {
|
|
460
|
+
return { kind: "unknown", path };
|
|
461
|
+
}
|
|
462
|
+
try {
|
|
463
|
+
return { kind: "valid", path, token: await readViewerToken() };
|
|
464
|
+
} catch {
|
|
465
|
+
return { kind: "unknown", path };
|
|
466
|
+
}
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
async function revokeViewerCredential(preflight) {
|
|
470
|
+
if (preflight.kind === "absent") {
|
|
471
|
+
return { preserved: false, removed: false };
|
|
472
|
+
}
|
|
473
|
+
if (preflight.kind === "unknown") {
|
|
474
|
+
return { preserved: true, removed: false };
|
|
475
|
+
}
|
|
476
|
+
if (await removeViewerToken(preflight.token)) {
|
|
477
|
+
return { preserved: false, removed: true };
|
|
478
|
+
}
|
|
479
|
+
const current = await inspectViewerCredential();
|
|
480
|
+
return {
|
|
481
|
+
preserved: current.kind !== "absent",
|
|
482
|
+
removed: current.kind === "absent",
|
|
483
|
+
};
|
|
484
|
+
}
|
|
485
|
+
|
|
445
486
|
async function runtimeEndpointState(runtime) {
|
|
446
487
|
try {
|
|
447
488
|
const response = await fetch(`http://${runtime.host}:${runtime.port}/api/state`, {
|
|
@@ -620,6 +661,15 @@ async function install() {
|
|
|
620
661
|
`marketplace ${MARKETPLACE_NAME} already points to ${existing.root}; remove it explicitly before installing this npm bundle`,
|
|
621
662
|
);
|
|
622
663
|
}
|
|
664
|
+
const bundle = await inspectPluginBundle(destination);
|
|
665
|
+
if (bundle.kind === "unmanaged") {
|
|
666
|
+
throw unmanagedBundleError(destination);
|
|
667
|
+
}
|
|
668
|
+
const runtime = await inspectRuntime();
|
|
669
|
+
const seedToken = runtime.kind === "valid"
|
|
670
|
+
? runtime.info.viewer_token || runtime.info.token
|
|
671
|
+
: undefined;
|
|
672
|
+
await ensureViewerToken(process.env, { seedToken });
|
|
623
673
|
await copyPluginBundle(destination);
|
|
624
674
|
if (!existing) {
|
|
625
675
|
await run("codex", ["plugin", "marketplace", "add", destination, "--json"]);
|
|
@@ -739,6 +789,7 @@ async function uninstall(args) {
|
|
|
739
789
|
}
|
|
740
790
|
|
|
741
791
|
const runtimePreflight = await inspectRuntime();
|
|
792
|
+
const viewerPreflight = await inspectViewerCredential();
|
|
742
793
|
const stoppedMonitor = await stopRunningRuntime(runtimePreflight);
|
|
743
794
|
|
|
744
795
|
await run("codex", ["plugin", "remove", PLUGIN_ID, "--json"], { allowFailure: true });
|
|
@@ -746,6 +797,7 @@ async function uninstall(args) {
|
|
|
746
797
|
allowFailure: true,
|
|
747
798
|
});
|
|
748
799
|
await removeManagedPluginBundle(bundle);
|
|
800
|
+
const viewerCredential = await revokeViewerCredential(viewerPreflight);
|
|
749
801
|
if (purge) {
|
|
750
802
|
const preservedRuntimeFile = await purgeStaleRuntime(runtimePreflight);
|
|
751
803
|
const removedRoot = await removeRuntimeRootIfEmpty(root);
|
|
@@ -761,12 +813,22 @@ async function uninstall(args) {
|
|
|
761
813
|
`The unrecognized runtime file at ${runtimeFile()} was preserved.\n`,
|
|
762
814
|
);
|
|
763
815
|
}
|
|
816
|
+
if (viewerCredential.preserved) {
|
|
817
|
+
process.stdout.write(
|
|
818
|
+
"The unrecognized or changed viewer credential was preserved for manual review.\n",
|
|
819
|
+
);
|
|
820
|
+
}
|
|
764
821
|
} else {
|
|
765
822
|
process.stdout.write(
|
|
766
823
|
stoppedMonitor
|
|
767
824
|
? "Stopped the owned monitor and removed the plugin and marketplace bundle.\n"
|
|
768
825
|
: "Removed plugin and marketplace bundle. Runtime data was preserved.\n",
|
|
769
826
|
);
|
|
827
|
+
if (viewerCredential.preserved) {
|
|
828
|
+
process.stdout.write(
|
|
829
|
+
"The unrecognized or changed viewer credential was preserved for manual review.\n",
|
|
830
|
+
);
|
|
831
|
+
}
|
|
770
832
|
}
|
|
771
833
|
}
|
|
772
834
|
|