codex-webapp 0.1.0-beta.1 → 0.1.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +27 -80
- package/README.md +43 -183
- package/package.json +1 -1
package/README.ja.md
CHANGED
|
@@ -1,43 +1,14 @@
|
|
|
1
|
-
> **非公式の community project です。** この project は OpenAI、公式 Codex team、または公式 Codex App と提携・承認・後援・関連していません。
|
|
2
|
-
|
|
3
1
|
# Codex WebApp
|
|
4
2
|
|
|
5
3
|
[English](./README.md) / 日本語 / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
|
|
6
4
|
|
|
7
|
-
Codex App
|
|
5
|
+
Codex App から、Codex 風のブラウザ画面を開くための小さな非公式 npm package です。
|
|
8
6
|
|
|
9
|
-
Codex
|
|
7
|
+
Codex の準備確認、ローカルUIの起動、表示確認を、Codex App に貼るだけのプロンプトで進めやすくします。
|
|
10
8
|
|
|
11
9
|

|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
>
|
|
15
|
-
> 生の UI サーバーは原則 `localhost` のまま使ってください。スマホや別PCから触る場合は、Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を先に用意してください。公開IPへ直接出さないでください。
|
|
16
|
-
|
|
17
|
-
## これは何ですか
|
|
18
|
-
|
|
19
|
-
「Codex をブラウザやスマホから使えるらしい」と聞いたのに、サーバー起動後に何を開けばいいかわからない。そこを埋めるための npm パッケージです。
|
|
20
|
-
|
|
21
|
-
この beta でできること:
|
|
22
|
-
|
|
23
|
-
- Codex CLI が入っているか確認する
|
|
24
|
-
- `codex remote-control --help` が使えるか確認する
|
|
25
|
-
- npm の一時実行で `doctor` / `start` / `smoke` を走らせる
|
|
26
|
-
- Codex App に貼るだけのプロンプトを提供する
|
|
27
|
-
- ローカルの Codex 風ブラウザ UI を起動する
|
|
28
|
-
- smoke test で「画面が本当に見えている」ことを確認する
|
|
29
|
-
|
|
30
|
-
## いまの beta の位置づけ
|
|
31
|
-
|
|
32
|
-
現在の npm beta は `codex-webapp@0.1.0-beta.1` です。
|
|
33
|
-
|
|
34
|
-
これは Codex App の native marketplace plugin、browser extension、one-click installer、managed hosting service ではありません。Codex App にプロンプトを貼り、Codex に `npx` で npm パッケージを実行してもらう形です。
|
|
35
|
-
|
|
36
|
-
現在の方針は experimental かつ compatibility-first です。現在は `0xcaff/codex-web` の commit `585613f5a3a355af5aefc388ca4e31b07a472cda` を参照する Codex 風 browser runtime を起動し、その周辺に install、safety、evidence、support の層を加えています。この public repository は package、user documentation、safety notes、contribution path に絞ります。
|
|
37
|
-
|
|
38
|
-
注: 現在、software interface 自体は主に英語です。この日本語ドキュメントは setup を助けるための翻訳です。
|
|
39
|
-
|
|
40
|
-
## Codex App に貼るプロンプト
|
|
11
|
+
## Codex App に貼る
|
|
41
12
|
|
|
42
13
|
以下をそのまま Codex App に貼ってください。
|
|
43
14
|
|
|
@@ -51,16 +22,13 @@ Please:
|
|
|
51
22
|
1. Check my Codex version.
|
|
52
23
|
2. Run the package doctor.
|
|
53
24
|
3. Run start in dry-run mode first.
|
|
54
|
-
4. Start the local browser UI
|
|
25
|
+
4. Start the local browser UI on localhost.
|
|
55
26
|
5. Smoke-test the printed local URL.
|
|
56
27
|
|
|
57
|
-
Keep everything on localhost unless I already have Tailscale, Cloudflare Access,
|
|
58
|
-
or another trusted access boundary set up.
|
|
59
|
-
|
|
60
28
|
Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
|
|
61
29
|
```
|
|
62
30
|
|
|
63
|
-
Codex
|
|
31
|
+
Codex はだいたい次のコマンドを実行します。
|
|
64
32
|
|
|
65
33
|
```bash
|
|
66
34
|
npx -y codex-webapp@beta doctor
|
|
@@ -68,76 +36,55 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
68
36
|
npx -y codex-webapp@beta start
|
|
69
37
|
```
|
|
70
38
|
|
|
71
|
-
`npx`
|
|
39
|
+
`npx` は、npm に公開されている package を一時的に実行する仕組みです。ユーザーが手でプロジェクトを作る必要はありません。
|
|
72
40
|
|
|
73
|
-
##
|
|
41
|
+
## ターミナルで使う
|
|
74
42
|
|
|
75
43
|
```bash
|
|
76
|
-
codex --version
|
|
77
|
-
codex remote-control --help
|
|
78
44
|
npx -y codex-webapp@beta doctor
|
|
79
45
|
npx -y codex-webapp@beta start --dry-run
|
|
80
46
|
npx -y codex-webapp@beta start
|
|
81
47
|
```
|
|
82
48
|
|
|
83
|
-
|
|
49
|
+
デフォルトURL:
|
|
84
50
|
|
|
85
51
|
```text
|
|
86
52
|
http://127.0.0.1:8214/
|
|
87
53
|
```
|
|
88
54
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
UI サーバーを起動したら、次で確認できます。
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
npx -y codex-webapp@beta smoke \
|
|
95
|
-
--url http://127.0.0.1:8214/
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
ブラウザ証跡を撮る場合:
|
|
55
|
+
表示確認:
|
|
99
56
|
|
|
100
57
|
```bash
|
|
101
|
-
npx -y codex-webapp@beta smoke
|
|
102
|
-
--browser \
|
|
103
|
-
--url http://127.0.0.1:8214/ \
|
|
104
|
-
--screenshot artifacts/codex-webapp.png
|
|
58
|
+
npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
|
|
105
59
|
```
|
|
106
60
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
## 安全境界
|
|
61
|
+
## 何をするものか
|
|
110
62
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
-
|
|
116
|
-
- 自分の端末間だけなら Tailscale
|
|
117
|
-
- 複数人で使うなら Cloudflare Access などの identity-aware proxy
|
|
118
|
-
|
|
119
|
-
避けること:
|
|
63
|
+
- Codex CLI が入っているか確認する
|
|
64
|
+
- `codex remote-control --help` が動くか確認する
|
|
65
|
+
- Codex 風のブラウザUIを localhost で起動する
|
|
66
|
+
- UI URL にアクセスできるか smoke test する
|
|
67
|
+
- Codex App から貼るだけで進めやすい導線を用意する
|
|
120
68
|
|
|
121
|
-
|
|
122
|
-
- token / cookie / customer data / private repo 内容を public issue に貼る
|
|
123
|
-
- OpenAI 公式プロダクトのように見せる
|
|
124
|
-
- 現在の beta を managed hosting service として扱う
|
|
69
|
+
現在の runtime reference:
|
|
125
70
|
|
|
126
|
-
|
|
71
|
+
```text
|
|
72
|
+
github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
|
|
73
|
+
```
|
|
127
74
|
|
|
128
|
-
|
|
75
|
+
## 安全メモ
|
|
129
76
|
|
|
130
|
-
|
|
77
|
+
Codex WebApp は OpenAI 公式プロダクトではなく、OpenAI から承認・推奨されたものではありません。
|
|
131
78
|
|
|
132
|
-
|
|
79
|
+
生のUIサーバーは `localhost` のまま使ってください。スマホや別PCから使う場合は、Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を先に用意してください。
|
|
133
80
|
|
|
134
|
-
|
|
81
|
+
Codex WebApp は telemetry / analytics / project-operated phone-home path を含みません。browser extension もインストールしません。
|
|
135
82
|
|
|
136
|
-
##
|
|
83
|
+
## Support
|
|
137
84
|
|
|
138
|
-
|
|
85
|
+
issue には OS、Node version、Codex version、実行した command、redact済みの `doctor` / `start` / `smoke` output を入れてください。
|
|
139
86
|
|
|
140
|
-
|
|
87
|
+
token、cookie、private repo、customer data、internal URL は public issue に貼らないでください。
|
|
141
88
|
|
|
142
89
|
## License
|
|
143
90
|
|
package/README.md
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
> **Unofficial community project.** This project is not affiliated with,
|
|
2
|
-
> sponsored by, endorsed by, or associated with OpenAI, the official Codex team,
|
|
3
|
-
> or the official Codex App.
|
|
4
|
-
|
|
5
1
|
# Codex WebApp
|
|
6
2
|
|
|
7
3
|
[](https://github.com/penso-os/codex-webapp/actions/workflows/ci.yml)
|
|
@@ -9,62 +5,15 @@
|
|
|
9
5
|
[](https://www.npmjs.com/package/codex-webapp)
|
|
10
6
|
[](./LICENSE.md)
|
|
11
7
|
|
|
12
|
-
|
|
8
|
+
Open a Codex-style browser UI from Codex App.
|
|
13
9
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
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.
|
|
17
13
|
|
|
18
14
|

|
|
19
15
|
|
|
20
|
-
|
|
21
|
-
>
|
|
22
|
-
> Keep the raw UI server on `localhost` unless you have Tailscale, Cloudflare
|
|
23
|
-
> Access, or an equivalent trusted access boundary. Do not put the raw server on
|
|
24
|
-
> a public IP.
|
|
25
|
-
|
|
26
|
-
Quick check:
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npx -y codex-webapp@beta doctor
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Languages
|
|
33
|
-
|
|
34
|
-
- English: this README
|
|
35
|
-
- Japanese: [README.ja.md](./README.ja.md)
|
|
36
|
-
- Korean: [docs/i18n/README.ko.md](./docs/i18n/README.ko.md)
|
|
37
|
-
- Simplified Chinese: [docs/i18n/README.zh-CN.md](./docs/i18n/README.zh-CN.md)
|
|
38
|
-
|
|
39
|
-
## Who This Is For
|
|
40
|
-
|
|
41
|
-
This package is for people who opened Codex App, heard that Codex can be used
|
|
42
|
-
from a browser or phone, and then got stuck at "the server is running, but what
|
|
43
|
-
do I open?"
|
|
44
|
-
|
|
45
|
-
It is also for maintainers who want a repeatable public-beta gate:
|
|
46
|
-
|
|
47
|
-
- check the local Codex install
|
|
48
|
-
- start the Codex-style browser UI on a safe local port
|
|
49
|
-
- verify the page with HTTP or browser smoke tests
|
|
50
|
-
- collect evidence before sharing a beta package
|
|
51
|
-
- document the trusted-access boundary instead of improvising it in DMs
|
|
52
|
-
|
|
53
|
-
## Current Beta Shape
|
|
54
|
-
|
|
55
|
-
Current npm beta: `codex-webapp@0.1.0-beta.1`
|
|
56
|
-
|
|
57
|
-
This is an npm package that Codex App can run through a prompt. It is not a
|
|
58
|
-
native Codex App marketplace plugin, browser extension, one-click installer, or
|
|
59
|
-
managed hosting service.
|
|
60
|
-
|
|
61
|
-
The current beta is experimental and compatibility-first. It launches a pinned
|
|
62
|
-
Codex-style web runtime reference, currently `0xcaff/codex-web` at commit
|
|
63
|
-
`585613f5a3a355af5aefc388ca4e31b07a472cda`, and wraps it with clearer install,
|
|
64
|
-
safety, evidence, and support behavior. The public repository is kept focused on
|
|
65
|
-
the package, user documentation, safety notes, and contribution path.
|
|
66
|
-
|
|
67
|
-
## Codex App Quick Start
|
|
16
|
+
## Start From Codex App
|
|
68
17
|
|
|
69
18
|
Paste this into Codex App:
|
|
70
19
|
|
|
@@ -78,16 +27,13 @@ Please:
|
|
|
78
27
|
1. Check my Codex version.
|
|
79
28
|
2. Run the package doctor.
|
|
80
29
|
3. Run start in dry-run mode first.
|
|
81
|
-
4. Start the local browser UI
|
|
30
|
+
4. Start the local browser UI on localhost.
|
|
82
31
|
5. Smoke-test the printed local URL.
|
|
83
32
|
|
|
84
|
-
Keep everything on localhost unless I already have Tailscale, Cloudflare Access,
|
|
85
|
-
or another trusted access boundary set up.
|
|
86
|
-
|
|
87
33
|
Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
|
|
88
34
|
```
|
|
89
35
|
|
|
90
|
-
Codex should run commands like
|
|
36
|
+
Codex should run commands like:
|
|
91
37
|
|
|
92
38
|
```bash
|
|
93
39
|
npx -y codex-webapp@beta doctor
|
|
@@ -95,49 +41,30 @@ npx -y codex-webapp@beta start --dry-run
|
|
|
95
41
|
npx -y codex-webapp@beta start
|
|
96
42
|
```
|
|
97
43
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
> `npx` runs a published npm package temporarily, without asking you to install
|
|
101
|
-
> or manage a project by hand.
|
|
44
|
+
`npx` means Codex runs the published package temporarily. You do not need to
|
|
45
|
+
create a project or install this package by hand.
|
|
102
46
|
|
|
103
|
-
##
|
|
104
|
-
|
|
105
|
-
Developers can run the same flow from a terminal:
|
|
47
|
+
## Use From A Terminal
|
|
106
48
|
|
|
107
49
|
```bash
|
|
108
|
-
# 1. Confirm Codex is available.
|
|
109
|
-
codex --version
|
|
110
|
-
|
|
111
|
-
# 2. Check whether the remote-control command exists.
|
|
112
|
-
codex remote-control --help
|
|
113
|
-
|
|
114
|
-
# 3. Run the friendly readiness check.
|
|
115
50
|
npx -y codex-webapp@beta doctor
|
|
116
|
-
|
|
117
|
-
# 4. Preview the launcher command without starting anything.
|
|
118
51
|
npx -y codex-webapp@beta start --dry-run
|
|
119
|
-
|
|
120
|
-
# 5. Start the local Codex-style browser UI.
|
|
121
52
|
npx -y codex-webapp@beta start
|
|
122
53
|
```
|
|
123
54
|
|
|
124
|
-
By default the
|
|
55
|
+
By default the local UI opens at:
|
|
125
56
|
|
|
126
57
|
```text
|
|
127
58
|
http://127.0.0.1:8214/
|
|
128
59
|
```
|
|
129
60
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
Once the UI server is running:
|
|
61
|
+
Check the browser surface:
|
|
133
62
|
|
|
134
63
|
```bash
|
|
135
|
-
npx -y codex-webapp@beta smoke
|
|
136
|
-
--url http://127.0.0.1:8214/
|
|
64
|
+
npx -y codex-webapp@beta smoke --url http://127.0.0.1:8214/
|
|
137
65
|
```
|
|
138
66
|
|
|
139
|
-
|
|
140
|
-
Codex-style surface. To capture browser evidence:
|
|
67
|
+
Capture browser evidence when needed:
|
|
141
68
|
|
|
142
69
|
```bash
|
|
143
70
|
npx -y codex-webapp@beta smoke \
|
|
@@ -146,85 +73,39 @@ npx -y codex-webapp@beta smoke \
|
|
|
146
73
|
--screenshot artifacts/codex-webapp.png
|
|
147
74
|
```
|
|
148
75
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
```bash
|
|
152
|
-
npm install -D playwright
|
|
153
|
-
npx playwright install chromium
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
Public evidence must use a clean or demo environment. Do not publish screenshots
|
|
157
|
-
that expose private repositories, private branches, account metadata, customer
|
|
158
|
-
data, tokens, cookies, or internal URLs.
|
|
159
|
-
|
|
160
|
-
## Safety Boundary
|
|
161
|
-
|
|
162
|
-
This package does not make an unsafe network setup safe.
|
|
76
|
+
## What It Does
|
|
163
77
|
|
|
164
|
-
|
|
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
|
|
165
84
|
|
|
166
|
-
|
|
167
|
-
- Tailscale for private-device access
|
|
168
|
-
- Cloudflare Access or an equivalent identity-aware proxy for shared access
|
|
85
|
+
Current runtime reference:
|
|
169
86
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
- paste tokens, cookies, customer data, or private repository contents into
|
|
174
|
-
public issues
|
|
175
|
-
- describe this project as an official OpenAI or Codex product
|
|
176
|
-
- treat the current beta as a managed hosting service
|
|
177
|
-
|
|
178
|
-
## Security And Privacy
|
|
87
|
+
```text
|
|
88
|
+
github:0xcaff/codex-web#585613f5a3a355af5aefc388ca4e31b07a472cda
|
|
89
|
+
```
|
|
179
90
|
|
|
180
|
-
|
|
91
|
+
## Safety Notes
|
|
181
92
|
|
|
182
|
-
|
|
183
|
-
customer data to a third-party service operated by this project. It launches a
|
|
184
|
-
local Codex-style browser surface and runs local readiness/smoke checks against
|
|
185
|
-
the URL you provide.
|
|
93
|
+
Codex WebApp is not affiliated with or endorsed by OpenAI.
|
|
186
94
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
own behavior; review and operate those components as part of your deployment
|
|
191
|
-
boundary.
|
|
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.
|
|
192
98
|
|
|
193
99
|
Codex WebApp does not include telemetry, analytics, or a project-operated
|
|
194
|
-
phone-home path.
|
|
195
|
-
|
|
196
|
-
For public support, remove secrets and private URLs before sharing command
|
|
197
|
-
output or screenshots.
|
|
198
|
-
|
|
199
|
-
## Product Principles
|
|
200
|
-
|
|
201
|
-

|
|
100
|
+
phone-home path. It does not install a browser extension and does not store
|
|
101
|
+
browser tokens in extension storage.
|
|
202
102
|
|
|
203
|
-
|
|
204
|
-
into Codex App.
|
|
205
|
-
- **Compatibility first**: staying close to the Codex browser experience is more
|
|
206
|
-
valuable than a custom UI that drifts quickly.
|
|
207
|
-
- **Security owned**: the public package must keep the raw server local and make
|
|
208
|
-
trusted access explicit.
|
|
209
|
-
- **Evidence driven**: launch claims must be backed by doctor, dry-run, smoke,
|
|
210
|
-
browser, and clean-sandbox evidence.
|
|
211
|
-
- **Contribution friendly**: the repo should be easy to inspect, test, and
|
|
212
|
-
improve without needing private maintainer context.
|
|
213
|
-
|
|
214
|
-
## Repository Layout
|
|
103
|
+
## Languages
|
|
215
104
|
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
src/codexWeb.js Codex-style web launch arguments and safety checks
|
|
221
|
-
src/version.js Codex CLI version parsing and readiness checks
|
|
222
|
-
test/*.test.mjs node:test coverage
|
|
223
|
-
docs/assets/ public-safe README visuals
|
|
224
|
-
docs/i18n/ localized quickstart docs
|
|
225
|
-
docs/codex-app-install.md Codex App prompt-driven setup guide
|
|
226
|
-
docs/ja-quickstart.md Japanese quickstart guide
|
|
227
|
-
```
|
|
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)
|
|
228
109
|
|
|
229
110
|
## Development
|
|
230
111
|
|
|
@@ -236,35 +117,14 @@ npm run start:dry-run
|
|
|
236
117
|
|
|
237
118
|
## Support
|
|
238
119
|
|
|
239
|
-
Open
|
|
240
|
-
|
|
241
|
-
- your OS
|
|
242
|
-
- Node version
|
|
243
|
-
- Codex version
|
|
244
|
-
- the exact command you ran
|
|
245
|
-
- the doctor or smoke output after removing secrets and private URLs
|
|
246
|
-
|
|
247
|
-
Never paste tokens, cookies, private repository contents, customer data, or
|
|
248
|
-
internal URLs into a public issue. See [SECURITY.md](./SECURITY.md) and
|
|
249
|
-
[SUPPORT.md](./SUPPORT.md).
|
|
250
|
-
|
|
251
|
-
## Project Boundary
|
|
252
|
-
|
|
253
|
-
This repository is the public distribution layer for the browser companion:
|
|
254
|
-
launcher, doctor, smoke tests, documentation, safety boundary, and release
|
|
255
|
-
evidence.
|
|
256
|
-
|
|
257
|
-
Managed hosting, private support operations, proprietary gateways, and internal
|
|
258
|
-
workspace automation are outside this public package.
|
|
259
|
-
|
|
260
|
-
## Acknowledgements
|
|
120
|
+
Open an issue with your OS, Node version, Codex version, the command you ran,
|
|
121
|
+
and redacted output from `doctor`, `start`, or `smoke`.
|
|
261
122
|
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
doctor, safety, documentation, and release-evidence layers around that style of
|
|
265
|
-
workflow while keeping the non-affiliation boundary explicit.
|
|
123
|
+
Do not paste tokens, cookies, private repository contents, customer data, or
|
|
124
|
+
internal URLs into a public issue.
|
|
266
125
|
|
|
267
|
-
See [
|
|
126
|
+
See [SECURITY.md](./SECURITY.md), [SUPPORT.md](./SUPPORT.md), and
|
|
127
|
+
[ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md).
|
|
268
128
|
|
|
269
129
|
## License
|
|
270
130
|
|
package/package.json
CHANGED