codex-webapp 0.1.0-beta.2 → 0.1.0-beta.3
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/README.ja.md +105 -23
- package/README.md +83 -41
- package/package.json +1 -1
package/README.ja.md
CHANGED
|
@@ -1,16 +1,35 @@
|
|
|
1
1
|
# Codex WebApp
|
|
2
2
|
|
|
3
|
+
[](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/codex-webapp)
|
|
5
|
+
[](https://www.npmjs.com/package/codex-webapp)
|
|
6
|
+
[](./LICENSE.md)
|
|
7
|
+
|
|
3
8
|
[English](./README.md) / 日本語 / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
|
|
4
9
|
|
|
5
|
-
Codex
|
|
10
|
+
**Codex WebApp は、Codex `0.130.0` で入った `codex remote-control` を、Codex App ユーザーが貼るだけで起動しやすいローカルのブラウザUIにするための非公式 npm package です。** CLI だけでなく、ブラウザ、スマホ、アプリのような画面から Codex を触りたい人に向けて、準備確認、起動、表示確認までを短い導線にまとめます。
|
|
6
11
|
|
|
7
|
-
Codex
|
|
12
|
+
Codex `0.130.0` では、ヘッドレスでリモート制御可能な app-server を起動しやすくする入口として `codex remote-control` が追加されました。[^1] これは大きな前進ですが、そのリリースだけで誰でもすぐに使えるブラウザUIやスマホ向け体験が同梱されたわけではありません。Codex WebApp はその間を埋めるために、ローカルの Codex を確認し、`localhost` 上で Codex 風のWeb画面を起動し、最後に本当に開けたかを smoke test します。
|
|
8
13
|
|
|
9
14
|

|
|
10
15
|
|
|
11
|
-
##
|
|
16
|
+
## なぜ作ったか
|
|
17
|
+
|
|
18
|
+
Codex は、ターミナルだけで完結するツールから、よりアプリらしい操作体験へ広がりつつあります。開発者としては Codex を自分のマシンで動かしつつ、ブラウザ、タブレット、スマホ、あるいは Codex App から自然に操作したいはずです。この package の目的は Codex CLI を置き換えることではありません。目的は、**「remote-control が来たらしい」** から **「ローカルのブラウザUIが起動し、表示確認まで通った」** までを最短にすることです。
|
|
19
|
+
|
|
20
|
+
| 欲しい体験 | Codex WebApp が用意するもの |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| ターミナルに慣れていなくても始めたい | Codex App に貼るだけで進められるセットアップ用プロンプト。 |
|
|
23
|
+
| 起動前に環境を確認したい | `doctor` による Codex CLI、version、`remote-control` の確認。 |
|
|
24
|
+
| 安全な既定値で使いたい | デフォルトは `127.0.0.1`。非 loopback host は明示的に許可しない限り拒否。 |
|
|
25
|
+
| 動いた証拠が欲しい | `smoke` によるURL確認と、必要に応じたブラウザ screenshot。 |
|
|
26
|
+
| 何を起動しているか把握したい | 小さな wrapper と、固定された `codex-web` runtime reference。 |
|
|
27
|
+
|
|
28
|
+
> **非公式だが、丁寧に扱うための companion です。** Codex WebApp は OpenAI の公式プロダクトではなく、OpenAI から承認・推奨されたものでもありません。ローカル制御を前提にし、telemetry、analytics、browser extension、project-operated phone-home path を含まない形を目指しています。
|
|
12
29
|
|
|
13
|
-
|
|
30
|
+
## Codex App から始める
|
|
31
|
+
|
|
32
|
+
Codex App を使っている場合は、次の指示をそのまま貼ってください。Codex が準備確認、dry-run、ローカルUIの起動、smoke test までを進め、成功・失敗を報告する想定です。
|
|
14
33
|
|
|
15
34
|
```text
|
|
16
35
|
Please set up Codex WebApp on this machine.
|
|
@@ -19,16 +38,17 @@ Use this npm package:
|
|
|
19
38
|
codex-webapp@beta
|
|
20
39
|
|
|
21
40
|
Please:
|
|
22
|
-
1. Check my Codex version.
|
|
41
|
+
1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
|
|
23
42
|
2. Run the package doctor.
|
|
24
43
|
3. Run start in dry-run mode first.
|
|
25
44
|
4. Start the local browser UI on localhost.
|
|
26
45
|
5. Smoke-test the printed local URL.
|
|
27
46
|
|
|
28
47
|
Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
|
|
48
|
+
Keep any raw Codex browser server on localhost unless I have a trusted access boundary such as Tailscale or Cloudflare Access.
|
|
29
49
|
```
|
|
30
50
|
|
|
31
|
-
|
|
51
|
+
実際には、おおむね次のようなコマンドが実行されます。
|
|
32
52
|
|
|
33
53
|
```bash
|
|
34
54
|
npx -y codex-webapp@beta doctor
|
|
@@ -36,9 +56,11 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
36
56
|
npx -y codex-webapp@beta start
|
|
37
57
|
```
|
|
38
58
|
|
|
39
|
-
`npx` は、npm に公開されている package
|
|
59
|
+
`npx` は、npm に公開されている package を一時的に実行する仕組みです。試すだけなら、この repository を clone したり、手元で新しい project を作ったりする必要はありません。
|
|
60
|
+
|
|
61
|
+
## ターミナルから始める
|
|
40
62
|
|
|
41
|
-
|
|
63
|
+
自分でコマンドを実行したい場合は、次の順番で進めてください。Codex WebApp には **Node.js 20 以上** と **Codex CLI 0.130.0 以上** が必要です。
|
|
42
64
|
|
|
43
65
|
```bash
|
|
44
66
|
npx -y codex-webapp@beta doctor
|
|
@@ -46,46 +68,106 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
46
68
|
npx -y codex-webapp@beta start
|
|
47
69
|
```
|
|
48
70
|
|
|
49
|
-
|
|
71
|
+
デフォルトでは、ローカルマシン上の次のURLでブラウザUIが開きます。
|
|
50
72
|
|
|
51
73
|
```text
|
|
52
74
|
http://127.0.0.1:8214/
|
|
53
75
|
```
|
|
54
76
|
|
|
55
|
-
|
|
77
|
+
UIが起動したら、URLに到達できるかを確認します。
|
|
56
78
|
|
|
57
79
|
```bash
|
|
58
80
|
npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
|
|
59
81
|
```
|
|
60
82
|
|
|
61
|
-
|
|
83
|
+
issue や検証用にブラウザの証跡が必要な場合は、screenshot 付きの smoke test を実行できます。
|
|
62
84
|
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
85
|
+
```bash
|
|
86
|
+
npx -y codex-webapp@beta smoke \
|
|
87
|
+
--browser \
|
|
88
|
+
--url http://127.0.0.1:8214/ \
|
|
89
|
+
--screenshot artifacts/codex-webapp.png
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## 内部で何をしているか
|
|
93
|
+
|
|
94
|
+
Codex WebApp は、できるだけ薄い wrapper として作られています。まずローカルの `codex` 実行ファイルが存在するかを確認し、version が `remote-control` に対応しているかを見ます。そのうえで `codex remote-control --help` が動くことを確認し、loopback address 上で Codex 風のWeb画面を起動します。最後に `smoke` でURL到達性を確認するため、セットアップの結果が曖昧になりにくい構成です。
|
|
68
95
|
|
|
69
|
-
|
|
96
|
+
| コマンド | 目的 | 期待される結果 |
|
|
97
|
+
| --- | --- | --- |
|
|
98
|
+
| `doctor` | Codex CLI、version、`remote-control` の利用可否を確認します。 | 準備完了の要約、または更新が必要な箇所の説明。 |
|
|
99
|
+
| `start --dry-run` | 実際には起動せず、起動予定の内容を表示します。 | ローカルURLと内部で実行する `npx` command。 |
|
|
100
|
+
| `start` | 確認後にローカルのブラウザUIを起動します。 | `http://127.0.0.1:8214/` で動くUI。 |
|
|
101
|
+
| `start --yes` | 対話確認なしで起動します。 | script や自動化されたローカル検証に便利。 |
|
|
102
|
+
| `smoke` | UI URL に到達でき、期待する内容があるかを確認します。 | 速い pass/fail 結果。 |
|
|
103
|
+
| `smoke --browser --screenshot ...` | headless browser でUIを開き、証跡を保存します。 | debug や support に使える screenshot。 |
|
|
104
|
+
|
|
105
|
+
現在の runtime reference は次の通りです。
|
|
70
106
|
|
|
71
107
|
```text
|
|
72
108
|
github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
|
|
73
109
|
```
|
|
74
110
|
|
|
75
|
-
##
|
|
111
|
+
## 安全性について
|
|
112
|
+
|
|
113
|
+
このブラウザUIは強力です。URLに到達できる人は、そのhost上の Codex を操作できる可能性があります。そのため、Codex WebApp はデフォルトで `127.0.0.1` に bind し、非 loopback host は `--allow-non-loopback` を明示しない限り拒否し、起動前に確認を出します。
|
|
114
|
+
|
|
115
|
+
| シナリオ | 推奨される境界 |
|
|
116
|
+
| --- | --- |
|
|
117
|
+
| 同じマシンで使う | デフォルトの `http://127.0.0.1:8214/` のまま使ってください。 |
|
|
118
|
+
| 自分のスマホや別PCから使う | Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を先に用意してください。 |
|
|
119
|
+
| public internet から直接見せる | 生のUIサーバーを public IP に直接公開しないでください。 |
|
|
120
|
+
| issue で相談する | token、cookie、private repository、customer data、internal URL は必ず redact してください。 |
|
|
121
|
+
|
|
122
|
+
Codex WebApp は telemetry、analytics、browser extension、project-operated phone-home path を含みません。また、extension を入れないため、browser token を extension storage に保存することもありません。
|
|
123
|
+
|
|
124
|
+
## 必要条件
|
|
125
|
+
|
|
126
|
+
| 項目 | version または補足 |
|
|
127
|
+
| --- | --- |
|
|
128
|
+
| Codex CLI | `codex remote-control` を使うため、`0.130.0` 以上が必要です。 |
|
|
129
|
+
| Node.js | `20` 以上が必要です。 |
|
|
130
|
+
| network binding | デフォルトは `127.0.0.1`。非 loopback host は明示的な opt-in が必要です。 |
|
|
131
|
+
| package channel | beta 中は `codex-webapp@beta` を使ってください。 |
|
|
132
|
+
|
|
133
|
+
Codex が入っていない、または古い場合は、先に更新してください。
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
npm install -g @openai/codex@latest
|
|
137
|
+
codex --version
|
|
138
|
+
codex remote-control --help
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Troubleshooting
|
|
142
|
+
|
|
143
|
+
多くの失敗は、Codex CLI の有無、version、`remote-control` の有無、port、URL のどれかに集約されます。issue を開く場合は、以下の確認結果を redact したうえで共有してください。
|
|
76
144
|
|
|
77
|
-
|
|
145
|
+
| 症状 | 最初に見るもの | 次に試すこと |
|
|
146
|
+
| --- | --- | --- |
|
|
147
|
+
| `Codex CLI was not found` と出る | `codex --version` | Codex CLI を install または update してください。 |
|
|
148
|
+
| `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 が正しいかを確認してください。 |
|
|
151
|
+
| debug 用の証跡が欲しい | `smoke --browser --screenshot artifacts/codex-webapp.png` | screenshot と redact 済み log を issue に添付してください。 |
|
|
78
152
|
|
|
79
|
-
|
|
153
|
+
## Development
|
|
80
154
|
|
|
81
|
-
|
|
155
|
+
```bash
|
|
156
|
+
npm test
|
|
157
|
+
npm pack --dry-run
|
|
158
|
+
npm run start:dry-run
|
|
159
|
+
```
|
|
82
160
|
|
|
83
161
|
## Support
|
|
84
162
|
|
|
85
|
-
issue には OS、Node version、Codex version、実行した command、redact済みの `doctor` / `start` / `smoke` output を入れてください。
|
|
163
|
+
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
164
|
|
|
87
|
-
|
|
165
|
+
追加の方針は [SECURITY.md](./SECURITY.md)、[SUPPORT.md](./SUPPORT.md)、[ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) を参照してください。
|
|
88
166
|
|
|
89
167
|
## License
|
|
90
168
|
|
|
91
169
|
[Apache-2.0](./LICENSE.md)
|
|
170
|
+
|
|
171
|
+
## References
|
|
172
|
+
|
|
173
|
+
[^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
|
@@ -5,17 +5,31 @@
|
|
|
5
5
|
[](https://www.npmjs.com/package/codex-webapp)
|
|
6
6
|
[](./LICENSE.md)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
[English](./README.md) / [日本語](./README.ja.md) / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
|
|
9
9
|
|
|
10
|
-
Codex WebApp is a small, unofficial npm package
|
|
11
|
-
|
|
12
|
-
actually opened.
|
|
10
|
+
**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.
|
|
11
|
+
|
|
12
|
+
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
13
|
|
|
14
14
|

|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Why this exists
|
|
17
|
+
|
|
18
|
+
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.”**
|
|
19
|
+
|
|
20
|
+
| Need | What Codex WebApp provides |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| A non-terminal entry point | A pasteable Codex App prompt that lets Codex run the setup steps for you. |
|
|
23
|
+
| Confidence before starting | `doctor` checks whether Codex CLI is installed and whether `remote-control` is available. |
|
|
24
|
+
| A safe default | The UI binds to `127.0.0.1` by default and refuses non-loopback hosts unless you explicitly opt in. |
|
|
25
|
+
| A quick proof that it works | `smoke` verifies the local URL and can capture browser evidence when needed. |
|
|
26
|
+
| A thin, inspectable wrapper | The runtime is pinned to a known `codex-web` reference rather than hidden behind a large installer. |
|
|
27
|
+
|
|
28
|
+
> **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.
|
|
29
|
+
|
|
30
|
+
## Quick start from Codex App
|
|
17
31
|
|
|
18
|
-
|
|
32
|
+
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
33
|
|
|
20
34
|
```text
|
|
21
35
|
Please set up Codex WebApp on this machine.
|
|
@@ -24,16 +38,17 @@ Use this npm package:
|
|
|
24
38
|
codex-webapp@beta
|
|
25
39
|
|
|
26
40
|
Please:
|
|
27
|
-
1. Check my Codex version.
|
|
41
|
+
1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
|
|
28
42
|
2. Run the package doctor.
|
|
29
43
|
3. Run start in dry-run mode first.
|
|
30
44
|
4. Start the local browser UI on localhost.
|
|
31
45
|
5. Smoke-test the printed local URL.
|
|
32
46
|
|
|
33
47
|
Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
|
|
48
|
+
Keep any raw Codex browser server on localhost unless I have a trusted access boundary such as Tailscale or Cloudflare Access.
|
|
34
49
|
```
|
|
35
50
|
|
|
36
|
-
Codex
|
|
51
|
+
Codex will normally run commands like the following.
|
|
37
52
|
|
|
38
53
|
```bash
|
|
39
54
|
npx -y codex-webapp@beta doctor
|
|
@@ -41,10 +56,11 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
41
56
|
npx -y codex-webapp@beta start
|
|
42
57
|
```
|
|
43
58
|
|
|
44
|
-
`npx`
|
|
45
|
-
create a project or install this package by hand.
|
|
59
|
+
`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
60
|
|
|
47
|
-
##
|
|
61
|
+
## Quick start from a terminal
|
|
62
|
+
|
|
63
|
+
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
64
|
|
|
49
65
|
```bash
|
|
50
66
|
npx -y codex-webapp@beta doctor
|
|
@@ -52,19 +68,19 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
52
68
|
npx -y codex-webapp@beta start
|
|
53
69
|
```
|
|
54
70
|
|
|
55
|
-
By default the
|
|
71
|
+
By default, the browser UI opens on the local machine at the following URL.
|
|
56
72
|
|
|
57
73
|
```text
|
|
58
74
|
http://127.0.0.1:8214/
|
|
59
75
|
```
|
|
60
76
|
|
|
61
|
-
|
|
77
|
+
When the page is running, confirm that the browser surface is reachable.
|
|
62
78
|
|
|
63
79
|
```bash
|
|
64
80
|
npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
|
|
65
81
|
```
|
|
66
82
|
|
|
67
|
-
|
|
83
|
+
If you need browser evidence for a report or issue, run the browser-backed smoke test and save a screenshot.
|
|
68
84
|
|
|
69
85
|
```bash
|
|
70
86
|
npx -y codex-webapp@beta smoke \
|
|
@@ -73,14 +89,18 @@ npx -y codex-webapp@beta smoke \
|
|
|
73
89
|
--screenshot artifacts/codex-webapp.png
|
|
74
90
|
```
|
|
75
91
|
|
|
76
|
-
## What
|
|
92
|
+
## What happens under the hood
|
|
93
|
+
|
|
94
|
+
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
95
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
96
|
+
| Command | Purpose | Typical result |
|
|
97
|
+
| --- | --- | --- |
|
|
98
|
+
| `doctor` | Checks Codex CLI, version, and `remote-control` availability. | A readiness summary or a clear update instruction. |
|
|
99
|
+
| `start --dry-run` | Shows what would be launched without starting the UI. | A planned local URL and the underlying `npx` command. |
|
|
100
|
+
| `start` | Starts the local browser UI after confirmation. | A running UI at `http://127.0.0.1:8214/`. |
|
|
101
|
+
| `start --yes` | Starts without the interactive confirmation prompt. | Useful for scripted local setups. |
|
|
102
|
+
| `smoke` | Checks whether the UI URL is reachable and contains expected content. | A fast pass/fail result. |
|
|
103
|
+
| `smoke --browser --screenshot ...` | Opens the UI in a headless browser and captures evidence. | A screenshot file for debugging or support. |
|
|
84
104
|
|
|
85
105
|
Current runtime reference:
|
|
86
106
|
|
|
@@ -88,24 +108,47 @@ Current runtime reference:
|
|
|
88
108
|
github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
|
|
89
109
|
```
|
|
90
110
|
|
|
91
|
-
## Safety
|
|
111
|
+
## Safety model
|
|
92
112
|
|
|
93
|
-
Codex WebApp is
|
|
113
|
+
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
114
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
115
|
+
| Scenario | Recommended boundary |
|
|
116
|
+
| --- | --- |
|
|
117
|
+
| Same machine | Keep the default `http://127.0.0.1:8214/`. |
|
|
118
|
+
| Phone or another computer you control | Use Tailscale, Cloudflare Access, or an equivalent trusted access layer before exposing anything beyond localhost. |
|
|
119
|
+
| Public internet | Do not expose the raw UI server directly on a public IP. |
|
|
120
|
+
| Support issue | Redact tokens, cookies, private repository contents, customer data, and internal URLs before sharing logs. |
|
|
98
121
|
|
|
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.
|
|
122
|
+
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
123
|
|
|
103
|
-
##
|
|
124
|
+
## Requirements
|
|
104
125
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
126
|
+
| Requirement | Version or note |
|
|
127
|
+
| --- | --- |
|
|
128
|
+
| Codex CLI | `0.130.0` or newer, because `codex remote-control` is required. |
|
|
129
|
+
| Node.js | `20` or newer. |
|
|
130
|
+
| 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. |
|
|
132
|
+
|
|
133
|
+
If Codex is missing or too old, update it first.
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
npm install -g @openai/codex@latest
|
|
137
|
+
codex --version
|
|
138
|
+
codex remote-control --help
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Troubleshooting
|
|
142
|
+
|
|
143
|
+
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.
|
|
144
|
+
|
|
145
|
+
| Symptom | First check | Likely next step |
|
|
146
|
+
| --- | --- | --- |
|
|
147
|
+
| `Codex CLI was not found` | `codex --version` | Install or update Codex CLI. |
|
|
148
|
+
| `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. |
|
|
151
|
+
| You need proof for debugging | `smoke --browser --screenshot artifacts/codex-webapp.png` | Attach the screenshot and redacted logs to an issue. |
|
|
109
152
|
|
|
110
153
|
## Development
|
|
111
154
|
|
|
@@ -117,15 +160,14 @@ npm run start:dry-run
|
|
|
117
160
|
|
|
118
161
|
## Support
|
|
119
162
|
|
|
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.
|
|
163
|
+
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
164
|
|
|
126
|
-
See [SECURITY.md](./SECURITY.md), [SUPPORT.md](./SUPPORT.md), and
|
|
127
|
-
[ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md).
|
|
165
|
+
See [SECURITY.md](./SECURITY.md), [SUPPORT.md](./SUPPORT.md), and [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) for additional guidance.
|
|
128
166
|
|
|
129
167
|
## License
|
|
130
168
|
|
|
131
169
|
[Apache-2.0](./LICENSE.md)
|
|
170
|
+
|
|
171
|
+
## References
|
|
172
|
+
|
|
173
|
+
[^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/package.json
CHANGED