codex-webapp 0.1.0-beta.2 → 0.1.0

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 (8) hide show
  1. package/README.ja.md +112 -31
  2. package/README.md +92 -51
  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
package/README.ja.md CHANGED
@@ -1,91 +1,172 @@
1
1
  # Codex WebApp
2
2
 
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
+ [![npm version](https://img.shields.io/npm/v/codex-webapp?label=npm)](https://www.npmjs.com/package/codex-webapp)
5
+ [![License](https://img.shields.io/npm/l/codex-webapp)](./LICENSE.md)
6
+
3
7
  [English](./README.md) / 日本語 / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
4
8
 
5
- Codex App から、Codex 風のブラウザ画面を開くための小さな非公式 npm package です。
9
+ **Codex WebApp は、Codex `0.130.0` で入った `codex remote-control` を、Codex App ユーザーが貼るだけで起動しやすいローカルのブラウザUIにするための非公式 npm package です。** CLI だけでなく、ブラウザ、スマホ、アプリのような画面から Codex を触りたい人に向けて、準備確認、起動、表示確認までを短い導線にまとめます。
6
10
 
7
- Codex の準備確認、ローカルUIの起動、表示確認を、Codex App に貼るだけのプロンプトで進めやすくします。
11
+ Codex `0.130.0` では、ヘッドレスでリモート制御可能な app-server を起動しやすくする入口として `codex remote-control` が追加されました。[^1] これは大きな前進ですが、そのリリースだけで誰でもすぐに使えるブラウザUIやスマホ向け体験が同梱されたわけではありません。Codex WebApp はその間を埋めるために、ローカルの Codex を確認し、`localhost` 上で Codex 風のWeb画面を起動し、最後に本当に開けたかを smoke test します。
8
12
 
9
13
  ![Codex WebApp overview](./docs/assets/codex-webapp-overview.svg)
10
14
 
11
- ## Codex App に貼る
15
+ ## なぜ作ったか
16
+
17
+ Codex は、ターミナルだけで完結するツールから、よりアプリらしい操作体験へ広がりつつあります。開発者としては Codex を自分のマシンで動かしつつ、ブラウザ、タブレット、スマホ、あるいは Codex App から自然に操作したいはずです。この package の目的は Codex CLI を置き換えることではありません。目的は、**「remote-control が来たらしい」** から **「ローカルのブラウザUIが起動し、表示確認まで通った」** までを最短にすることです。
18
+
19
+ | 欲しい体験 | Codex WebApp が用意するもの |
20
+ | --- | --- |
21
+ | ターミナルに慣れていなくても始めたい | Codex App に貼るだけで進められるセットアップ用プロンプト。 |
22
+ | 起動前に環境を確認したい | `doctor` による Codex CLI、version、`remote-control` の確認。 |
23
+ | 安全な既定値で使いたい | デフォルトは `127.0.0.1`。非 loopback host は明示的に許可しない限り拒否。 |
24
+ | 動いた証拠が欲しい | `smoke` によるURL確認と、必要に応じたブラウザ screenshot。 |
25
+ | 何を起動しているか把握したい | 小さな wrapper と、固定された `codex-web` runtime reference。 |
26
+
27
+ > **非公式だが、丁寧に扱うための companion です。** Codex WebApp は OpenAI の公式プロダクトではなく、OpenAI から承認・推奨されたものでもありません。ローカル制御を前提にし、telemetry、analytics、browser extension、project-operated phone-home path を含まない形を目指しています。
12
28
 
13
- 以下をそのまま Codex App に貼ってください。
29
+ ## Codex App から始める
30
+
31
+ Codex App を使っている場合は、次の指示をそのまま貼ってください。Codex が準備確認、dry-run、ローカルUIの起動、smoke test までを進め、成功・失敗を報告する想定です。
14
32
 
15
33
  ```text
16
34
  Please set up Codex WebApp on this machine.
17
35
 
18
36
  Use this npm package:
19
- codex-webapp@beta
37
+ codex-webapp
20
38
 
21
39
  Please:
22
- 1. Check my Codex version.
40
+ 1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
23
41
  2. Run the package doctor.
24
42
  3. Run start in dry-run mode first.
25
43
  4. Start the local browser UI on localhost.
26
44
  5. Smoke-test the printed local URL.
27
45
 
28
46
  Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
47
+ Keep any raw Codex browser server on localhost unless I have a trusted access boundary such as Tailscale or Cloudflare Access.
29
48
  ```
30
49
 
31
- Codex はだいたい次のコマンドを実行します。
50
+ 実際には、おおむね次のようなコマンドが実行されます。
32
51
 
33
52
  ```bash
34
- npx -y codex-webapp@beta doctor
35
- npx -y codex-webapp@beta start --dry-run
36
- 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
37
56
  ```
38
57
 
39
- `npx` は、npm に公開されている package を一時的に実行する仕組みです。ユーザーが手でプロジェクトを作る必要はありません。
58
+ `npx` は、npm に公開されている package を一時的に実行する仕組みです。試すだけなら、この repository を clone したり、手元で新しい project を作ったりする必要はありません。
59
+
60
+ ## ターミナルから始める
40
61
 
41
- ## ターミナルで使う
62
+ 自分でコマンドを実行したい場合は、次の順番で進めてください。Codex WebApp には **Node.js 20 以上** と **Codex CLI 0.130.0 以上** が必要です。
42
63
 
43
64
  ```bash
44
- npx -y codex-webapp@beta doctor
45
- npx -y codex-webapp@beta start --dry-run
46
- 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
47
68
  ```
48
69
 
49
- デフォルトURL:
70
+ デフォルトでは、ローカルマシン上の次のURLでブラウザUIが開きます。
50
71
 
51
72
  ```text
52
73
  http://127.0.0.1:8214/
53
74
  ```
54
75
 
55
- 表示確認:
76
+ UIが起動したら、URLに到達できるかを確認します。
56
77
 
57
78
  ```bash
58
- 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/
59
80
  ```
60
81
 
61
- ## 何をするものか
82
+ issue や検証用にブラウザの証跡が必要な場合は、screenshot 付きの smoke test を実行できます。
62
83
 
63
- - Codex CLI が入っているか確認する
64
- - `codex remote-control --help` が動くか確認する
65
- - Codex 風のブラウザUIを localhost で起動する
66
- - UI URL にアクセスできるか smoke test する
67
- - Codex App から貼るだけで進めやすい導線を用意する
84
+ ```bash
85
+ npx -y codex-webapp smoke \
86
+ --browser \
87
+ --url http://127.0.0.1:8214/ \
88
+ --screenshot artifacts/codex-webapp.png
89
+ ```
90
+
91
+ ## 内部で何をしているか
92
+
93
+ Codex WebApp は、できるだけ薄い wrapper として作られています。まずローカルの `codex` 実行ファイルが存在するかを確認し、version が `remote-control` に対応しているかを見ます。そのうえで `codex remote-control --help` が動くことを確認し、loopback address 上で Codex 風のWeb画面を起動します。最後に `smoke` でURL到達性を確認するため、セットアップの結果が曖昧になりにくい構成です。
68
94
 
69
- 現在の runtime reference:
95
+ | コマンド | 目的 | 期待される結果 |
96
+ | --- | --- | --- |
97
+ | `doctor` | Codex CLI、version、`remote-control` の利用可否を確認します。 | 準備完了の要約、または更新が必要な箇所の説明。 |
98
+ | `start --dry-run` | 実際には起動せず、起動予定の内容を表示します。 | ローカルURLと内部で実行する `npx` command。 |
99
+ | `start` | 確認後にローカルのブラウザUIを起動します。 | `http://127.0.0.1:8214/` で動くUI。 |
100
+ | `start --yes` | 対話確認なしで起動します。 | script や自動化されたローカル検証に便利。 |
101
+ | `smoke` | UI URL に到達でき、期待する内容があるかを確認します。 | 速い pass/fail 結果。 |
102
+ | `smoke --browser --screenshot ...` | headless browser でUIを開き、証跡を保存します。 | debug や support に使える screenshot。 |
103
+
104
+ 現在の runtime reference は次の通りです。
70
105
 
71
106
  ```text
72
107
  github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
73
108
  ```
74
109
 
75
- ## 安全メモ
110
+ ## 安全性について
111
+
112
+ このブラウザUIは強力です。URLに到達できる人は、そのhost上の Codex を操作できる可能性があります。そのため、Codex WebApp はデフォルトで `127.0.0.1` に bind し、非 loopback host は `--allow-non-loopback` を明示しない限り拒否し、起動前に確認を出します。
113
+
114
+ | シナリオ | 推奨される境界 |
115
+ | --- | --- |
116
+ | 同じマシンで使う | デフォルトの `http://127.0.0.1:8214/` のまま使ってください。 |
117
+ | 自分のスマホや別PCから使う | Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を先に用意してください。 |
118
+ | public internet から直接見せる | 生のUIサーバーを public IP に直接公開しないでください。 |
119
+ | issue で相談する | token、cookie、private repository、customer data、internal URL は必ず redact してください。 |
120
+
121
+ Codex WebApp は telemetry、analytics、browser extension、project-operated phone-home path を含みません。また、extension を入れないため、browser token を extension storage に保存することもありません。
122
+
123
+ ## 必要条件
124
+
125
+ | 項目 | version または補足 |
126
+ | --- | --- |
127
+ | Codex CLI | `codex remote-control` を使うため、`0.130.0` 以上が必要です。 |
128
+ | Node.js | `20` 以上が必要です。 |
129
+ | network binding | デフォルトは `127.0.0.1`。非 loopback host は明示的な opt-in が必要です。 |
130
+ | package channel | npm の `latest` channel から `codex-webapp` を使ってください。現在の release は `0.1.0` です。 |
131
+
132
+ Codex が入っていない、または古い場合は、先に更新してください。
133
+
134
+ ```bash
135
+ npm install -g @openai/codex@latest
136
+ codex --version
137
+ codex remote-control --help
138
+ ```
139
+
140
+ ## Troubleshooting
141
+
142
+ 多くの失敗は、Codex CLI の有無、version、`remote-control` の有無、port、URL のどれかに集約されます。issue を開く場合は、以下の確認結果を redact したうえで共有してください。
76
143
 
77
- Codex WebApp は OpenAI 公式プロダクトではなく、OpenAI から承認・推奨されたものではありません。
144
+ | 症状 | 最初に見るもの | 次に試すこと |
145
+ | --- | --- | --- |
146
+ | `Codex CLI was not found` と出る | `codex --version` | Codex CLI を install または update してください。 |
147
+ | `remote-control` が使えない | `codex remote-control --help` | Codex CLI `0.130.0` 以上へ更新してください。 |
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 が正しいかを確認してください。 |
150
+ | debug 用の証跡が欲しい | `smoke --browser --screenshot artifacts/codex-webapp.png` | screenshot と redact 済み log を issue に添付してください。 |
78
151
 
79
- 生のUIサーバーは `localhost` のまま使ってください。スマホや別PCから使う場合は、Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を先に用意してください。
152
+ ## Development
80
153
 
81
- Codex WebApp は telemetry / analytics / project-operated phone-home path を含みません。browser extension もインストールしません。
154
+ ```bash
155
+ npm test
156
+ npm pack --dry-run
157
+ npm run start:dry-run
158
+ ```
82
159
 
83
160
  ## Support
84
161
 
85
- issue には OS、Node version、Codex version、実行した command、redact済みの `doctor` / `start` / `smoke` output を入れてください。
162
+ issue には OS、shell、Node version、Codex version、実行した command、redact 済みの `doctor` / `start` / `smoke` output を入れてください。token、cookie、private repository contents、customer data、internal URL は public issue に貼らないでください。
86
163
 
87
- token、cookie、private repo、customer data、internal URL は public issue に貼らないでください。
164
+ 追加の方針は [SECURITY.md](./SECURITY.md)、[SUPPORT.md](./SUPPORT.md)、[ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) を参照してください。
88
165
 
89
166
  ## License
90
167
 
91
168
  [Apache-2.0](./LICENSE.md)
169
+
170
+ ## References
171
+
172
+ [^1]: [openai/codex Releases: 0.130.0](https://github.com/openai/codex/releases/tag/rust-v0.130.0) では、`codex remote-control` が headless かつ remotely controllable な app-server を起動しやすくする entrypoint として追加されたことが説明されています。
package/README.md CHANGED
@@ -2,85 +2,104 @@
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
- Open a Codex-style browser UI from Codex App.
7
+ [English](./README.md) / [日本語](./README.ja.md) / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
9
8
 
10
- Codex WebApp is a small, unofficial npm package that helps Codex App check your
11
- local Codex install, start the browser surface, and verify that something useful
12
- actually opened.
9
+ **Codex WebApp turns the new `codex remote-control` capability into a local, browser-based Codex surface that Codex App users can start with one pasted instruction.** It is a small, unofficial npm package for people who want the convenience of an app-like UI without giving up the safety of a local-first Codex setup.
10
+
11
+ Codex `0.130.0` added `codex remote-control` as a simpler entrypoint for starting a headless, remotely controllable app-server.[^1] That is an important foundation, but the CLI release does not by itself give every user a ready-to-use browser or phone-friendly experience. Codex WebApp fills that gap by checking your local Codex installation, starting a pinned browser surface on `localhost`, and verifying that the page actually opened.
13
12
 
14
13
  ![Codex WebApp overview](./docs/assets/codex-webapp-overview.svg)
15
14
 
16
- ## Start From Codex App
15
+ ## Why this exists
16
+
17
+ Codex is becoming more useful outside a terminal-only workflow. Developers want to keep Codex running on their machine, but review and control it from a browser, a tablet, a phone, or an app-like surface. The goal of this package is therefore not to replace Codex CLI. The goal is to give Codex App users a simple path from **“I heard remote-control is here”** to **“I have a local browser UI running and smoke-tested.”**
18
+
19
+ | Need | What Codex WebApp provides |
20
+ | --- | --- |
21
+ | A non-terminal entry point | A pasteable Codex App prompt that lets Codex run the setup steps for you. |
22
+ | Confidence before starting | `doctor` checks whether Codex CLI is installed and whether `remote-control` is available. |
23
+ | A safe default | The UI binds to `127.0.0.1` by default and refuses non-loopback hosts unless you explicitly opt in. |
24
+ | A quick proof that it works | `smoke` verifies the local URL and can capture browser evidence when needed. |
25
+ | A thin, inspectable wrapper | The runtime is pinned to a known `codex-web` reference rather than hidden behind a large installer. |
26
+
27
+ > **Unofficial but respectful.** Codex WebApp is not affiliated with or endorsed by OpenAI. It is designed to stay close to Codex’s local-control model and to avoid telemetry, analytics, browser extensions, or a project-operated phone-home path.
28
+
29
+ ## Quick start from Codex App
17
30
 
18
- Paste this into Codex App:
31
+ If you are using Codex App, paste the following instruction. Codex should perform the checks, run a dry run, start the local UI, and report whether the smoke test passed.
19
32
 
20
33
  ```text
21
34
  Please set up Codex WebApp on this machine.
22
35
 
23
36
  Use this npm package:
24
- codex-webapp@beta
37
+ codex-webapp
25
38
 
26
39
  Please:
27
- 1. Check my Codex version.
40
+ 1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
28
41
  2. Run the package doctor.
29
42
  3. Run start in dry-run mode first.
30
43
  4. Start the local browser UI on localhost.
31
44
  5. Smoke-test the printed local URL.
32
45
 
33
46
  Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
47
+ Keep any raw Codex browser server on localhost unless I have a trusted access boundary such as Tailscale or Cloudflare Access.
34
48
  ```
35
49
 
36
- Codex should run commands like:
50
+ Codex will normally run commands like the following.
37
51
 
38
52
  ```bash
39
- npx -y codex-webapp@beta doctor
40
- npx -y codex-webapp@beta start --dry-run
41
- 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
42
56
  ```
43
57
 
44
- `npx` means Codex runs the published package temporarily. You do not need to
45
- create a project or install this package by hand.
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.
46
59
 
47
- ## Use From A Terminal
60
+ ## Quick start from a terminal
61
+
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**.
48
63
 
49
64
  ```bash
50
- npx -y codex-webapp@beta doctor
51
- npx -y codex-webapp@beta start --dry-run
52
- 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
53
68
  ```
54
69
 
55
- By default the local UI opens at:
70
+ By default, the browser UI opens on the local machine at the following URL.
56
71
 
57
72
  ```text
58
73
  http://127.0.0.1:8214/
59
74
  ```
60
75
 
61
- Check the browser surface:
76
+ When the page is running, confirm that the browser surface is reachable.
62
77
 
63
78
  ```bash
64
- 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/
65
80
  ```
66
81
 
67
- Capture browser evidence when needed:
82
+ If you need browser evidence for a report or issue, run the browser-backed smoke test and save a screenshot.
68
83
 
69
84
  ```bash
70
- npx -y codex-webapp@beta smoke \
85
+ npx -y codex-webapp smoke \
71
86
  --browser \
72
87
  --url http://127.0.0.1:8214/ \
73
88
  --screenshot artifacts/codex-webapp.png
74
89
  ```
75
90
 
76
- ## What It Does
91
+ ## What happens under the hood
92
+
93
+ Codex WebApp is intentionally small. It first verifies that the local `codex` executable exists, checks that its version supports `remote-control`, and confirms that `codex remote-control --help` works. It then starts a pinned Codex-style web surface on a loopback address and gives you a smoke-test command so the setup ends with a concrete pass/fail signal.
77
94
 
78
- - checks that Codex CLI is installed
79
- - checks that `codex remote-control --help` works
80
- - starts a pinned Codex-style browser surface on localhost
81
- - refuses non-loopback hosts unless explicitly allowed
82
- - smoke-tests that the UI URL is reachable
83
- - keeps the install path simple enough to paste into Codex App
95
+ | Command | Purpose | Typical result |
96
+ | --- | --- | --- |
97
+ | `doctor` | Checks Codex CLI, version, and `remote-control` availability. | A readiness summary or a clear update instruction. |
98
+ | `start --dry-run` | Shows what would be launched without starting the UI. | A planned local URL and the underlying `npx` command. |
99
+ | `start` | Starts the local browser UI after confirmation. | A running UI at `http://127.0.0.1:8214/`. |
100
+ | `start --yes` | Starts without the interactive confirmation prompt. | Useful for scripted local setups. |
101
+ | `smoke` | Checks whether the UI URL is reachable and contains expected content. | A fast pass/fail result. |
102
+ | `smoke --browser --screenshot ...` | Opens the UI in a headless browser and captures evidence. | A screenshot file for debugging or support. |
84
103
 
85
104
  Current runtime reference:
86
105
 
@@ -88,24 +107,47 @@ Current runtime reference:
88
107
  github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
89
108
  ```
90
109
 
91
- ## Safety Notes
110
+ ## Safety model
92
111
 
93
- Codex WebApp is not affiliated with or endorsed by OpenAI.
112
+ The browser UI is powerful because anyone who can reach it may be able to operate Codex on the host machine. For that reason, Codex WebApp defaults to `127.0.0.1`, refuses non-loopback hosts unless `--allow-non-loopback` is explicitly provided, and prints a confirmation before starting the UI.
94
113
 
95
- Keep the raw UI server on `localhost` unless you have Tailscale, Cloudflare
96
- Access, or an equivalent trusted access boundary. Do not expose it directly on a
97
- public IP.
114
+ | Scenario | Recommended boundary |
115
+ | --- | --- |
116
+ | Same machine | Keep the default `http://127.0.0.1:8214/`. |
117
+ | Phone or another computer you control | Use Tailscale, Cloudflare Access, or an equivalent trusted access layer before exposing anything beyond localhost. |
118
+ | Public internet | Do not expose the raw UI server directly on a public IP. |
119
+ | Support issue | Redact tokens, cookies, private repository contents, customer data, and internal URLs before sharing logs. |
98
120
 
99
- Codex WebApp does not include telemetry, analytics, or a project-operated
100
- phone-home path. It does not install a browser extension and does not store
101
- browser tokens in extension storage.
121
+ Codex WebApp does not include telemetry, analytics, a browser extension, or a project-operated phone-home path. It also does not store browser tokens in extension storage because it does not install an extension.
102
122
 
103
- ## Languages
123
+ ## Requirements
104
124
 
105
- - English: this README
106
- - Japanese: [README.ja.md](./README.ja.md)
107
- - Korean: [docs/i18n/README.ko.md](./docs/i18n/README.ko.md)
108
- - Simplified Chinese: [docs/i18n/README.zh-CN.md](./docs/i18n/README.zh-CN.md)
125
+ | Requirement | Version or note |
126
+ | --- | --- |
127
+ | Codex CLI | `0.130.0` or newer, because `codex remote-control` is required. |
128
+ | Node.js | `20` or newer. |
129
+ | Network binding | `127.0.0.1` by default. Non-loopback hosts require explicit opt-in. |
130
+ | Package channel | `codex-webapp` from the npm `latest` channel. Current release: `0.1.0`. |
131
+
132
+ If Codex is missing or too old, update it first.
133
+
134
+ ```bash
135
+ npm install -g @openai/codex@latest
136
+ codex --version
137
+ codex remote-control --help
138
+ ```
139
+
140
+ ## Troubleshooting
141
+
142
+ Most setup failures fall into a small number of categories. Run the commands in this order and share only redacted output if you open an issue.
143
+
144
+ | Symptom | First check | Likely next step |
145
+ | --- | --- | --- |
146
+ | `Codex CLI was not found` | `codex --version` | Install or update Codex CLI. |
147
+ | `remote-control` is unavailable | `codex remote-control --help` | Upgrade to Codex CLI `0.130.0` or newer. |
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. |
150
+ | You need proof for debugging | `smoke --browser --screenshot artifacts/codex-webapp.png` | Attach the screenshot and redacted logs to an issue. |
109
151
 
110
152
  ## Development
111
153
 
@@ -117,15 +159,14 @@ npm run start:dry-run
117
159
 
118
160
  ## Support
119
161
 
120
- Open an issue with your OS, Node version, Codex version, the command you ran,
121
- and redacted output from `doctor`, `start`, or `smoke`.
122
-
123
- Do not paste tokens, cookies, private repository contents, customer data, or
124
- internal URLs into a public issue.
162
+ Open an issue with your OS, shell, Node version, Codex version, the command you ran, and redacted output from `doctor`, `start`, or `smoke`. Do not paste tokens, cookies, private repository contents, customer data, or internal URLs into a public issue.
125
163
 
126
- See [SECURITY.md](./SECURITY.md), [SUPPORT.md](./SUPPORT.md), and
127
- [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md).
164
+ See [SECURITY.md](./SECURITY.md), [SUPPORT.md](./SUPPORT.md), and [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) for additional guidance.
128
165
 
129
166
  ## License
130
167
 
131
168
  [Apache-2.0](./LICENSE.md)
169
+
170
+ ## References
171
+
172
+ [^1]: [openai/codex Releases: 0.130.0](https://github.com/openai/codex/releases/tag/rust-v0.130.0) states that `codex remote-control` was added as a simpler entrypoint for starting a headless, remotely controllable app-server.
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.0`이며 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.0`，仍处于 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.2",
3
+ "version": "0.1.0",
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",