codex-webapp 0.1.0-beta.3 → 0.1.1

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 (9) hide show
  1. package/README.ja.md +12 -13
  2. package/README.md +12 -13
  3. package/docs/assets/codex-webapp-overview.svg +1 -1
  4. package/docs/i18n/README.ko.md +11 -11
  5. package/docs/i18n/README.zh-CN.md +11 -11
  6. package/docs/ja-quickstart.md +5 -5
  7. package/package.json +1 -1
  8. package/src/codexWeb.js +2 -0
  9. package/src/commands.js +8 -1
package/README.ja.md CHANGED
@@ -2,7 +2,6 @@
2
2
 
3
3
  [![CI](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml/badge.svg)](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml)
4
4
  [![npm version](https://img.shields.io/npm/v/codex-webapp?label=npm)](https://www.npmjs.com/package/codex-webapp)
5
- [![npm beta](https://img.shields.io/npm/v/codex-webapp/beta?label=beta)](https://www.npmjs.com/package/codex-webapp)
6
5
  [![License](https://img.shields.io/npm/l/codex-webapp)](./LICENSE.md)
7
6
 
8
7
  [English](./README.md) / 日本語 / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
@@ -35,7 +34,7 @@ Codex App を使っている場合は、次の指示をそのまま貼ってく
35
34
  Please set up Codex WebApp on this machine.
36
35
 
37
36
  Use this npm package:
38
- codex-webapp@beta
37
+ codex-webapp
39
38
 
40
39
  Please:
41
40
  1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
@@ -51,9 +50,9 @@ Keep any raw Codex browser server on localhost unless I have a trusted access bo
51
50
  実際には、おおむね次のようなコマンドが実行されます。
52
51
 
53
52
  ```bash
54
- npx -y codex-webapp@beta doctor
55
- npx -y codex-webapp@beta start --dry-run
56
- npx -y codex-webapp@beta start
53
+ npx -y codex-webapp doctor
54
+ npx -y codex-webapp start --dry-run
55
+ npx -y codex-webapp start
57
56
  ```
58
57
 
59
58
  `npx` は、npm に公開されている package を一時的に実行する仕組みです。試すだけなら、この repository を clone したり、手元で新しい project を作ったりする必要はありません。
@@ -63,9 +62,9 @@ npx -y codex-webapp@beta start
63
62
  自分でコマンドを実行したい場合は、次の順番で進めてください。Codex WebApp には **Node.js 20 以上** と **Codex CLI 0.130.0 以上** が必要です。
64
63
 
65
64
  ```bash
66
- npx -y codex-webapp@beta doctor
67
- npx -y codex-webapp@beta start --dry-run
68
- npx -y codex-webapp@beta start
65
+ npx -y codex-webapp doctor
66
+ npx -y codex-webapp start --dry-run
67
+ npx -y codex-webapp start
69
68
  ```
70
69
 
71
70
  デフォルトでは、ローカルマシン上の次のURLでブラウザUIが開きます。
@@ -77,13 +76,13 @@ http://127.0.0.1:8214/
77
76
  UIが起動したら、URLに到達できるかを確認します。
78
77
 
79
78
  ```bash
80
- npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
79
+ npx -y codex-webapp smoke --url http://127.0.0.1:8214/
81
80
  ```
82
81
 
83
82
  issue や検証用にブラウザの証跡が必要な場合は、screenshot 付きの smoke test を実行できます。
84
83
 
85
84
  ```bash
86
- npx -y codex-webapp@beta smoke \
85
+ npx -y codex-webapp smoke \
87
86
  --browser \
88
87
  --url http://127.0.0.1:8214/ \
89
88
  --screenshot artifacts/codex-webapp.png
@@ -128,7 +127,7 @@ Codex WebApp は telemetry、analytics、browser extension、project-operated ph
128
127
  | Codex CLI | `codex remote-control` を使うため、`0.130.0` 以上が必要です。 |
129
128
  | Node.js | `20` 以上が必要です。 |
130
129
  | network binding | デフォルトは `127.0.0.1`。非 loopback host は明示的な opt-in が必要です。 |
131
- | package channel | beta 中は `codex-webapp@beta` を使ってください。 |
130
+ | package channel | npm の `latest` channel から `codex-webapp` を使ってください。現在の release は `0.1.1` です。 |
132
131
 
133
132
  Codex が入っていない、または古い場合は、先に更新してください。
134
133
 
@@ -146,8 +145,8 @@ codex remote-control --help
146
145
  | --- | --- | --- |
147
146
  | `Codex CLI was not found` と出る | `codex --version` | Codex CLI を install または update してください。 |
148
147
  | `remote-control` が使えない | `codex remote-control --help` | Codex CLI `0.130.0` 以上へ更新してください。 |
149
- | UI が開かない | `npx -y codex-webapp@beta start --dry-run` | port の衝突や起動コマンドを確認してください。 |
150
- | smoke test が失敗する | `npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/` | server が起動中か、URL が正しいかを確認してください。 |
148
+ | UI が開かない | `npx -y codex-webapp start --dry-run` | port の衝突や起動コマンドを確認してください。 |
149
+ | smoke test が失敗する | `npx -y codex-webapp smoke --url http://127.0.0.1:8214/` | server が起動中か、URL が正しいかを確認してください。 |
151
150
  | debug 用の証跡が欲しい | `smoke --browser --screenshot artifacts/codex-webapp.png` | screenshot と redact 済み log を issue に添付してください。 |
152
151
 
153
152
  ## Development
package/README.md CHANGED
@@ -2,7 +2,6 @@
2
2
 
3
3
  [![CI](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml/badge.svg)](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml)
4
4
  [![npm version](https://img.shields.io/npm/v/codex-webapp?label=npm)](https://www.npmjs.com/package/codex-webapp)
5
- [![npm beta](https://img.shields.io/npm/v/codex-webapp/beta?label=beta)](https://www.npmjs.com/package/codex-webapp)
6
5
  [![License](https://img.shields.io/npm/l/codex-webapp)](./LICENSE.md)
7
6
 
8
7
  [English](./README.md) / [日本語](./README.ja.md) / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
@@ -35,7 +34,7 @@ If you are using Codex App, paste the following instruction. Codex should perfor
35
34
  Please set up Codex WebApp on this machine.
36
35
 
37
36
  Use this npm package:
38
- codex-webapp@beta
37
+ codex-webapp
39
38
 
40
39
  Please:
41
40
  1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
@@ -51,9 +50,9 @@ Keep any raw Codex browser server on localhost unless I have a trusted access bo
51
50
  Codex will normally run commands like the following.
52
51
 
53
52
  ```bash
54
- npx -y codex-webapp@beta doctor
55
- npx -y codex-webapp@beta start --dry-run
56
- npx -y codex-webapp@beta start
53
+ npx -y codex-webapp doctor
54
+ npx -y codex-webapp start --dry-run
55
+ npx -y codex-webapp start
57
56
  ```
58
57
 
59
58
  `npx` runs the published npm package temporarily. You do not need to create a project, clone this repository, or install Codex WebApp by hand just to try it.
@@ -63,9 +62,9 @@ npx -y codex-webapp@beta start
63
62
  Use this route if you prefer to control the commands yourself. Codex WebApp requires **Node.js 20 or newer** and **Codex CLI 0.130.0 or newer**.
64
63
 
65
64
  ```bash
66
- npx -y codex-webapp@beta doctor
67
- npx -y codex-webapp@beta start --dry-run
68
- npx -y codex-webapp@beta start
65
+ npx -y codex-webapp doctor
66
+ npx -y codex-webapp start --dry-run
67
+ npx -y codex-webapp start
69
68
  ```
70
69
 
71
70
  By default, the browser UI opens on the local machine at the following URL.
@@ -77,13 +76,13 @@ http://127.0.0.1:8214/
77
76
  When the page is running, confirm that the browser surface is reachable.
78
77
 
79
78
  ```bash
80
- npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
79
+ npx -y codex-webapp smoke --url http://127.0.0.1:8214/
81
80
  ```
82
81
 
83
82
  If you need browser evidence for a report or issue, run the browser-backed smoke test and save a screenshot.
84
83
 
85
84
  ```bash
86
- npx -y codex-webapp@beta smoke \
85
+ npx -y codex-webapp smoke \
87
86
  --browser \
88
87
  --url http://127.0.0.1:8214/ \
89
88
  --screenshot artifacts/codex-webapp.png
@@ -128,7 +127,7 @@ Codex WebApp does not include telemetry, analytics, a browser extension, or a pr
128
127
  | Codex CLI | `0.130.0` or newer, because `codex remote-control` is required. |
129
128
  | Node.js | `20` or newer. |
130
129
  | Network binding | `127.0.0.1` by default. Non-loopback hosts require explicit opt-in. |
131
- | Package channel | `codex-webapp@beta` while the package is in beta. |
130
+ | Package channel | `codex-webapp` from the npm `latest` channel. Current release: `0.1.1`. |
132
131
 
133
132
  If Codex is missing or too old, update it first.
134
133
 
@@ -146,8 +145,8 @@ Most setup failures fall into a small number of categories. Run the commands in
146
145
  | --- | --- | --- |
147
146
  | `Codex CLI was not found` | `codex --version` | Install or update Codex CLI. |
148
147
  | `remote-control` is unavailable | `codex remote-control --help` | Upgrade to Codex CLI `0.130.0` or newer. |
149
- | The UI does not open | `npx -y codex-webapp@beta start --dry-run` | Check whether the port is available and whether the launch command is correct. |
150
- | The smoke test fails | `npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/` | Confirm the server is still running and that you are using the printed URL. |
148
+ | The UI does not open | `npx -y codex-webapp start --dry-run` | Check whether the port is available and whether the launch command is correct. |
149
+ | The smoke test fails | `npx -y codex-webapp smoke --url http://127.0.0.1:8214/` | Confirm the server is still running and that you are using the printed URL. |
151
150
  | You need proof for debugging | `smoke --browser --screenshot artifacts/codex-webapp.png` | Attach the screenshot and redacted logs to an issue. |
152
151
 
153
152
  ## Development
package/docs/assets/codex-webapp-overview.svg CHANGED
@@ -1,6 +1,6 @@
1
1
  <svg xmlns="http://www.w3.org/2000/svg" width="1280" height="720" viewBox="0 0 1280 720" role="img" aria-labelledby="title desc">
2
2
  <title id="title">Codex WebApp overview</title>
3
- <desc id="desc">A public-safe overview showing Codex App prompt, npm beta package, local browser UI, smoke evidence, and trusted access boundary.</desc>
3
+ <desc id="desc">A public-safe overview showing Codex App prompt, npm package, local browser UI, smoke evidence, and trusted access boundary.</desc>
4
4
  <defs>
5
5
  <linearGradient id="bg" x1="0" x2="1" y1="0" y2="1">
6
6
  <stop offset="0%" stop-color="#111111"/>
package/docs/i18n/README.ko.md CHANGED
@@ -26,7 +26,7 @@ Korean documentation has been translated for setup convenience.
26
26
  Please set up Codex WebApp on this machine.
27
27
 
28
28
  Use this npm package:
29
- codex-webapp@beta
29
+ codex-webapp
30
30
 
31
31
  Please:
32
32
  1. Check my Codex version.
@@ -44,9 +44,9 @@ Do not print tokens, cookies, private repo contents, customer data, or internal
44
44
  Codex는 내부적으로 다음과 같은 명령을 실행합니다.
45
45
 
46
46
  ```bash
47
- npx -y codex-webapp@beta doctor
48
- npx -y codex-webapp@beta start --dry-run
49
- npx -y codex-webapp@beta start
47
+ npx -y codex-webapp doctor
48
+ npx -y codex-webapp start --dry-run
49
+ npx -y codex-webapp start
50
50
  ```
51
51
 
52
52
  `npx`는 npm에 공개된 패키지를 임시로 실행하는 도구입니다. 사용자가 직접 프로젝트를 만들거나 의존성을 관리할 필요를 줄여 줍니다.
@@ -56,9 +56,9 @@ npx -y codex-webapp@beta start
56
56
  ```bash
57
57
  codex --version
58
58
  codex remote-control --help
59
- npx -y codex-webapp@beta doctor
60
- npx -y codex-webapp@beta start --dry-run
61
- npx -y codex-webapp@beta start
59
+ npx -y codex-webapp doctor
60
+ npx -y codex-webapp start --dry-run
61
+ npx -y codex-webapp start
62
62
  ```
63
63
 
64
64
  기본 로컬 URL:
@@ -70,17 +70,17 @@ http://127.0.0.1:8214/
70
70
  ## Smoke Test
71
71
 
72
72
  ```bash
73
- npx -y codex-webapp@beta smoke \
73
+ npx -y codex-webapp smoke \
74
74
  --url http://127.0.0.1:8214/
75
75
  ```
76
76
 
77
77
  공개 이슈나 스크린샷에는 토큰, 쿠키, private repository, 고객 데이터, 내부 URL을 넣지 마세요.
78
78
 
79
- ## 현재 beta의 범위
79
+ ## 현재 범위
80
80
 
81
81
  이 패키지는 Codex App native marketplace plugin, browser extension, one-click installer, managed hosting service가 아닙니다. Codex App에 프롬프트를 붙여 넣고, Codex가 `npx`로 npm 패키지를 실행하는 방식입니다.
82
82
 
83
- 현재 beta는 experimental이며 compatibility-first입니다. 현재 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda`를 참조하는 Codex 스타일 browser runtime을 실행하고, 그 주변에 설치, 안전, 문서, 검증 evidence 계층을 더합니다.
83
+ 현재 release는 `0.1.1`이며 early, compatibility-first입니다. 현재 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda`를 참조하는 Codex 스타일 browser runtime을 실행하고, 그 주변에 설치, 안전, 문서, 검증 evidence 계층을 더합니다.
84
84
 
85
85
  ## Security And Privacy
86
86
 
@@ -90,6 +90,6 @@ npx -y codex-webapp@beta smoke \
90
90
 
91
91
  ## Acknowledgements
92
92
 
93
- 현재 beta는 Codex 스타일 브라우저 화면을 제공하는 public project `0xcaff/codex-web`의 접근 방식을 사용하고 참조합니다. 이 프로젝트는 그 주변에 배포, doctor, 안전 경계, 문서, 검증 evidence 계층을 추가합니다.
93
+ 현재 release는 Codex 스타일 브라우저 화면을 제공하는 public project `0xcaff/codex-web`의 접근 방식을 사용하고 참조합니다. 이 프로젝트는 그 주변에 배포, doctor, 안전 경계, 문서, 검증 evidence 계층을 추가합니다.
94
94
 
95
95
  License: [Apache-2.0](../../LICENSE.md)
package/docs/i18n/README.zh-CN.md CHANGED
@@ -26,7 +26,7 @@ Simplified Chinese documentation has been translated for setup convenience.
26
26
  Please set up Codex WebApp on this machine.
27
27
 
28
28
  Use this npm package:
29
- codex-webapp@beta
29
+ codex-webapp
30
30
 
31
31
  Please:
32
32
  1. Check my Codex version.
@@ -44,9 +44,9 @@ Do not print tokens, cookies, private repo contents, customer data, or internal
44
44
  Codex 通常会为你执行类似命令：
45
45
 
46
46
  ```bash
47
- npx -y codex-webapp@beta doctor
48
- npx -y codex-webapp@beta start --dry-run
49
- npx -y codex-webapp@beta start
47
+ npx -y codex-webapp doctor
48
+ npx -y codex-webapp start --dry-run
49
+ npx -y codex-webapp start
50
50
  ```
51
51
 
52
52
  `npx` 的简单解释：它会临时运行一个已经发布到 npm 的包，减少手动安装和管理项目依赖的麻烦。
@@ -56,9 +56,9 @@ npx -y codex-webapp@beta start
56
56
  ```bash
57
57
  codex --version
58
58
  codex remote-control --help
59
- npx -y codex-webapp@beta doctor
60
- npx -y codex-webapp@beta start --dry-run
61
- npx -y codex-webapp@beta start
59
+ npx -y codex-webapp doctor
60
+ npx -y codex-webapp start --dry-run
61
+ npx -y codex-webapp start
62
62
  ```
63
63
 
64
64
  默认本地地址：
@@ -70,17 +70,17 @@ http://127.0.0.1:8214/
70
70
  ## Smoke Test
71
71
 
72
72
  ```bash
73
- npx -y codex-webapp@beta smoke \
73
+ npx -y codex-webapp smoke \
74
74
  --url http://127.0.0.1:8214/
75
75
  ```
76
76
 
77
77
  公开 issue 或截图时，请不要包含 token、cookie、私有仓库、客户数据或内部 URL。
78
78
 
79
- ## 当前 beta 的范围
79
+ ## 当前范围
80
80
 
81
81
  这不是 Codex App native marketplace plugin、browser extension、one-click installer 或 managed hosting service。它的使用方式是：把提示词粘贴到 Codex App，让 Codex 通过 `npx` 执行 npm 包。
82
82
 
83
- 当前 beta 是 experimental，并采用 compatibility-first 方针。它目前运行一个引用 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda` 的 Codex 风格 browser runtime，并在其周围增加安装、安全、文档和验证证据层。
83
+ 当前 release 为 `0.1.1`，仍处于 early 阶段，并采用 compatibility-first 方针。它目前运行一个引用 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda` 的 Codex 风格 browser runtime，并在其周围增加安装、安全、文档和验证证据层。
84
84
 
85
85
  ## Security And Privacy
86
86
 
@@ -90,6 +90,6 @@ npx -y codex-webapp@beta smoke \
90
90
 
91
91
  ## Acknowledgements
92
92
 
93
- 当前 beta 使用并感谢 public project `0xcaff/codex-web` 提供的 Codex 风格浏览器界面思路。本项目在此基础上增加分发、doctor、安全边界、文档和验证证据层。
93
+ 当前 release 使用并感谢 public project `0xcaff/codex-web` 提供的 Codex 风格浏览器界面思路。本项目在此基础上增加分发、doctor、安全边界、文档和验证证据层。
94
94
 
95
95
  License: [Apache-2.0](../../LICENSE.md)
package/docs/ja-quickstart.md CHANGED
@@ -24,7 +24,7 @@ codex remote-control --help
24
24
  ## 3. friendly doctor を実行
25
25
 
26
26
  ```bash
27
- npx codex-webapp@beta doctor
27
+ npx codex-webapp doctor
28
28
  ```
29
29
 
30
30
  Codexが古い、または `remote-control` が見つからない場合は、次に打つべきコマンドを表示します。
@@ -32,13 +32,13 @@ Codexが古い、または `remote-control` が見つからない場合は、次
32
32
  ## 4. Codex-style Web UI を起動
33
33
 
34
34
  ```bash
35
- npx codex-webapp@beta start
35
+ npx codex-webapp start
36
36
  ```
37
37
 
38
38
  このコマンドは起動前に確認プロンプトを出します。自動化された信頼済み環境だけで `--yes` を使ってください。
39
39
 
40
40
  ```bash
41
- npx codex-webapp@beta start --yes
41
+ npx codex-webapp start --yes
42
42
  ```
43
43
 
44
44
  ## 5. ブラウザで表示できるか確認
@@ -46,7 +46,7 @@ npx codex-webapp@beta start --yes
46
46
  UIサーバーが起動している状態で、実ブラウザ疎通を確認します。
47
47
 
48
48
  ```bash
49
- npx codex-webapp@beta smoke \
49
+ npx codex-webapp smoke \
50
50
  --url http://127.0.0.1:8214/
51
51
  ```
52
52
 
@@ -55,7 +55,7 @@ npx codex-webapp@beta smoke \
55
55
  スクリーンショットも残したい場合は、Playwrightを使うdeep smokeを実行します。
56
56
 
57
57
  ```bash
58
- npx codex-webapp@beta smoke \
58
+ npx codex-webapp smoke \
59
59
  --browser \
60
60
  --url http://127.0.0.1:8214/ \
61
61
  --screenshot artifacts/codex-webapp.png
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codex-webapp",
3
- "version": "0.1.0-beta.3",
3
+ "version": "0.1.1",
4
4
  "description": "Unofficial. Respectful web app surface, doctor, and safety wrapper for Codex App users.",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
package/src/codexWeb.js CHANGED
@@ -28,7 +28,9 @@ export function assertSafeHost(host, { allowNonLoopback = false } = {}) {
28
28
  export function buildCodexWebNpxArgs({ host = DEFAULT_WEB_HOST, port = DEFAULT_WEB_PORT } = {}) {
29
29
  return [
30
30
  "--yes",
31
+ "--package",
31
32
  CODEX_WEB_REFERENCE,
33
+ "codex-web",
32
34
  "--host",
33
35
  host,
34
36
  "--port",
package/src/commands.js CHANGED
@@ -149,7 +149,14 @@ export async function start(args = []) {
149
149
  console.log(`Starting codex-web from ${CODEX_WEB_REFERENCE}...`);
150
150
  console.log(`Open: ${plannedWebUrl}`);
151
151
  console.log("Keep this terminal open. Expose it only through a trusted local, Tailscale, Cloudflare Access, or equivalent boundary.");
152
- const child = spawn("npx", npxArgs, { stdio: "inherit" });
152
+ const codexPath = resolveCodexPath();
153
+ const child = spawn("npx", npxArgs, {
154
+ stdio: "inherit",
155
+ env: {
156
+ ...process.env,
157
+ CODEX_CLI_PATH: codexPath || process.env.CODEX_CLI_PATH || "codex",
158
+ },
159
+ });
153
160
  child.on("exit", (code) => {
154
161
  process.exit(code ?? 0);
155
162
  });