codex-webapp 0.1.0-beta.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.
@@ -0,0 +1,52 @@
1
+ # Acknowledgements
2
+
3
+ Codex WebApp is an unofficial companion package for OpenAI
4
+ Codex `remote-control`. It is not affiliated with or endorsed by OpenAI.
5
+
6
+ ## OpenAI Codex
7
+
8
+ This project is built around the direction opened by OpenAI Codex App Server
9
+ and `codex remote-control`.
10
+
11
+ - OpenAI Codex: https://github.com/openai/codex
12
+ - Codex App Server documentation:
13
+ https://github.com/openai/codex/tree/main/codex-rs/app-server
14
+
15
+ ## Prior Art And Adjacent Projects
16
+
17
+ The remote-Codex and mobile-agent ecosystem is moving quickly. The following
18
+ projects are useful adjacent references for users and maintainers evaluating the
19
+ space:
20
+
21
+ - codex-web by 0xcaff: https://github.com/0xcaff/codex-web
22
+ - RemCodex: https://remcodex.com/
23
+ - Taskdex: https://www.taskdex.app/
24
+ - Taskdex GitHub: https://github.com/DhruvalGolakiya/taskdex
25
+ - Remodex: https://github.com/Emanuele-web04/remodex
26
+ - codexUI: https://github.com/friuns2/codexui
27
+ - FlyDex: https://flydex.net/
28
+ - The Companion: https://docs.thecompanion.sh/
29
+ - MobileCLI: https://www.mobilecli.app/
30
+ - RemoteVibeCode: https://remotevibecode.com/
31
+ - Nitori Codex Webview:
32
+ https://marketplace.visualstudio.com/items?itemName=Kaisei-Yasuzaki.nitori-codex-webview
33
+
34
+ Listing a project here is acknowledgement of prior art or adjacency, not a
35
+ claim that this package includes that project's code.
36
+
37
+ ## codex-web
38
+
39
+ `0xcaff/codex-web` is a particularly important reference point for this package.
40
+ Its README describes a browser frontend for Codex Desktop running on a machine
41
+ the user controls, with a deliberately thin wrapper so upstream Codex changes can
42
+ be integrated quickly.
43
+
44
+ Codex WebApp follows that same spirit: stay thin, make the install path humane,
45
+ keep the operator's machine in control, and avoid pretending to be an official
46
+ OpenAI product.
47
+
48
+ ## Code Provenance
49
+
50
+ This package is intended as a clean public companion module. Unless a future
51
+ file explicitly says otherwise, it does not vendor source code from the projects
52
+ listed above.
@@ -0,0 +1,37 @@
1
+ # Contributing
2
+
3
+ Thanks for helping make Codex remote-control easier to use.
4
+
5
+ This project aims to be unusually kind to first-time users: clear errors,
6
+ copy-pasteable commands, mobile-friendly UI, and conservative security
7
+ defaults.
8
+
9
+ ## Good First Contributions
10
+
11
+ - Improve the `doctor` output for a confusing install state.
12
+ - Add tests for Codex CLI version parsing.
13
+ - Improve mobile layout without adding visual noise.
14
+ - Document a real failure mode and the fix.
15
+ - Improve the browser smoke test so users can verify the console actually
16
+ renders on their machine.
17
+ - Add safer defaults for local or trusted-network operation.
18
+
19
+ ## Ground Rules
20
+
21
+ - Do not imply OpenAI endorsement.
22
+ - Do not add telemetry without explicit opt-in.
23
+ - Do not expose raw app-server endpoints publicly by default.
24
+ - Do not add commercial upgrade UI, hidden private hooks, or paid-feature
25
+ conditionals to the public module.
26
+ - Do not log secrets, prompts, repository contents, cookies, tokens, or session
27
+ IDs.
28
+ - Keep private operations features out of the public module.
29
+
30
+ ## Pull Request Checklist
31
+
32
+ - README or help text updated when behavior changes.
33
+ - Security boundary preserved.
34
+ - `npm run doctor` or the equivalent local command exercised.
35
+ - Browser smoke exercised when UI behavior changes.
36
+ - UI changes checked on a mobile-width viewport.
37
+ - New dependencies justified in the PR body.
package/LICENSE.md ADDED
@@ -0,0 +1,184 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction, and
10
+ distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by the copyright
13
+ owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all other entities
16
+ that control, are controlled by, or are under common control with that entity.
17
+ For the purposes of this definition, "control" means (i) the power, direct or
18
+ indirect, to cause the direction or management of such entity, whether by
19
+ contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20
+ outstanding shares, or (iii) beneficial ownership of such entity.
21
+
22
+ "You" (or "Your") shall mean an individual or Legal Entity exercising
23
+ permissions granted by this License.
24
+
25
+ "Source" form shall mean the preferred form for making modifications, including
26
+ but not limited to software source code, documentation source, and
27
+ configuration files.
28
+
29
+ "Object" form shall mean any form resulting from mechanical transformation or
30
+ translation of a Source form, including but not limited to compiled object
31
+ code, generated documentation, and conversions to other media types.
32
+
33
+ "Work" shall mean the work of authorship, whether in Source or Object form,
34
+ made available under the License, as indicated by a copyright notice that is
35
+ included in or attached to the work (an example is provided in the Appendix
36
+ below).
37
+
38
+ "Derivative Works" shall mean any work, whether in Source or Object form, that
39
+ is based on (or derived from) the Work and for which the editorial revisions,
40
+ annotations, elaborations, or other modifications represent, as a whole, an
41
+ original work of authorship. For the purposes of this License, Derivative Works
42
+ shall not include works that remain separable from, or merely link (or bind by
43
+ name) to the interfaces of, the Work and Derivative Works thereof.
44
+
45
+ "Contribution" shall mean any work of authorship, including the original
46
+ version of the Work and any modifications or additions to that Work or
47
+ Derivative Works thereof, that is intentionally submitted to Licensor for
48
+ inclusion in the Work by the copyright owner or by an individual or Legal
49
+ Entity authorized to submit on behalf of the copyright owner. For the purposes
50
+ of this definition, "submitted" means any form of electronic, verbal, or
51
+ written communication sent to the Licensor or its representatives, including
52
+ but not limited to communication on electronic mailing lists, source code
53
+ control systems, and issue tracking systems that are managed by, or on behalf
54
+ of, the Licensor for the purpose of discussing and improving the Work, but
55
+ excluding communication that is conspicuously marked or otherwise designated in
56
+ writing by the copyright owner as "Not a Contribution."
57
+
58
+ "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
59
+ of whom a Contribution has been received by Licensor and subsequently
60
+ incorporated within the Work.
61
+
62
+ 2. Grant of Copyright License. Subject to the terms and conditions of this
63
+ License, each Contributor hereby grants to You a perpetual, worldwide,
64
+ non-exclusive, no-charge, royalty-free, irrevocable copyright license to
65
+ reproduce, prepare Derivative Works of, publicly display, publicly perform,
66
+ sublicense, and distribute the Work and such Derivative Works in Source or
67
+ Object form.
68
+
69
+ 3. Grant of Patent License. Subject to the terms and conditions of this
70
+ License, each Contributor hereby grants to You a perpetual, worldwide,
71
+ non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
72
+ section) patent license to make, have made, use, offer to sell, sell, import,
73
+ and otherwise transfer the Work, where such license applies only to those
74
+ patent claims licensable by such Contributor that are necessarily infringed by
75
+ their Contribution(s) alone or by combination of their Contribution(s) with the
76
+ Work to which such Contribution(s) was submitted. If You institute patent
77
+ litigation against any entity (including a cross-claim or counterclaim in a
78
+ lawsuit) alleging that the Work or a Contribution incorporated within the Work
79
+ constitutes direct or contributory patent infringement, then any patent
80
+ licenses granted to You under this License for that Work shall terminate as of
81
+ the date such litigation is filed.
82
+
83
+ 4. Redistribution. You may reproduce and distribute copies of the Work or
84
+ Derivative Works thereof in any medium, with or without modifications, and in
85
+ Source or Object form, provided that You meet the following conditions:
86
+
87
+ (a) You must give any other recipients of the Work or Derivative Works a copy
88
+ of this License; and
89
+
90
+ (b) You must cause any modified files to carry prominent notices stating that
91
+ You changed the files; and
92
+
93
+ (c) You must retain, in the Source form of any Derivative Works that You
94
+ distribute, all copyright, patent, trademark, and attribution notices from
95
+ the Source form of the Work, excluding those notices that do not pertain to
96
+ any part of the Derivative Works; and
97
+
98
+ (d) If the Work includes a "NOTICE" text file as part of its distribution, then
99
+ any Derivative Works that You distribute must include a readable copy of
100
+ the attribution notices contained within such NOTICE file, excluding those
101
+ notices that do not pertain to any part of the Derivative Works, in at
102
+ least one of the following places: within a NOTICE text file distributed as
103
+ part of the Derivative Works; within the Source form or documentation, if
104
+ provided along with the Derivative Works; or, within a display generated by
105
+ the Derivative Works, if and wherever such third-party notices normally
106
+ appear. The contents of the NOTICE file are for informational purposes only
107
+ and do not modify the License. You may add Your own attribution notices
108
+ within Derivative Works that You distribute, alongside or as an addendum to
109
+ the NOTICE text from the Work, provided that such additional attribution
110
+ notices cannot be construed as modifying the License.
111
+
112
+ You may add Your own copyright statement to Your modifications and may provide
113
+ additional or different license terms and conditions for use, reproduction, or
114
+ distribution of Your modifications, or for any such Derivative Works as a
115
+ whole, provided Your use, reproduction, and distribution of the Work otherwise
116
+ complies with the conditions stated in this License.
117
+
118
+ 5. Submission of Contributions. Unless You explicitly state otherwise, any
119
+ Contribution intentionally submitted for inclusion in the Work by You to the
120
+ Licensor shall be under the terms and conditions of this License, without any
121
+ additional terms or conditions. Notwithstanding the above, nothing herein shall
122
+ supersede or modify the terms of any separate license agreement you may have
123
+ executed with Licensor regarding such Contributions.
124
+
125
+ 6. Trademarks. This License does not grant permission to use the trade names,
126
+ trademarks, service marks, or product names of the Licensor, except as required
127
+ for reasonable and customary use in describing the origin of the Work and
128
+ reproducing the content of the NOTICE file.
129
+
130
+ 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
131
+ writing, Licensor provides the Work (and each Contributor provides its
132
+ Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
133
+ KIND, either express or implied, including, without limitation, any warranties
134
+ or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
135
+ PARTICULAR PURPOSE. You are solely responsible for determining the
136
+ appropriateness of using or redistributing the Work and assume any risks
137
+ associated with Your exercise of permissions under this License.
138
+
139
+ 8. Limitation of Liability. In no event and under no legal theory, whether in
140
+ tort (including negligence), contract, or otherwise, unless required by
141
+ applicable law (such as deliberate and grossly negligent acts) or agreed to in
142
+ writing, shall any Contributor be liable to You for damages, including any
143
+ direct, indirect, special, incidental, or consequential damages of any
144
+ character arising as a result of this License or out of the use or inability to
145
+ use the Work (including but not limited to damages for loss of goodwill, work
146
+ stoppage, computer failure or malfunction, or any and all other commercial
147
+ damages or losses), even if such Contributor has been advised of the
148
+ possibility of such damages.
149
+
150
+ 9. Accepting Warranty or Additional Liability. While redistributing the Work or
151
+ Derivative Works thereof, You may choose to offer, and charge a fee for,
152
+ acceptance of support, warranty, indemnity, or other liability obligations
153
+ and/or rights consistent with this License. However, in accepting such
154
+ obligations, You may act only on Your own behalf and on Your sole
155
+ responsibility, not on behalf of any other Contributor, and only if You agree
156
+ to indemnify, defend, and hold each Contributor harmless for any liability
157
+ incurred by, or claims asserted against, such Contributor by reason of your
158
+ accepting any such warranty or additional liability.
159
+
160
+ END OF TERMS AND CONDITIONS
161
+
162
+ APPENDIX: How to apply the Apache License to your work.
163
+
164
+ To apply the Apache License to your work, attach the following boilerplate
165
+ notice, with the fields enclosed by brackets "[]" replaced with your own
166
+ identifying information. (Don't include the brackets!) The text should be
167
+ enclosed in the appropriate comment syntax for the file format. We also
168
+ recommend that a file or class name and description of purpose be included on
169
+ the same "printed page" as the copyright notice for easier identification
170
+ within third-party archives.
171
+
172
+ Copyright 2026 PENSO
173
+
174
+ Licensed under the Apache License, Version 2.0 (the "License");
175
+ you may not use this file except in compliance with the License.
176
+ You may obtain a copy of the License at
177
+
178
+ http://www.apache.org/licenses/LICENSE-2.0
179
+
180
+ Unless required by applicable law or agreed to in writing, software
181
+ distributed under the License is distributed on an "AS IS" BASIS,
182
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
183
+ See the License for the specific language governing permissions and
184
+ limitations under the License.
package/README.ja.md ADDED
@@ -0,0 +1,144 @@
1
+ > **非公式の community project です。** この project は OpenAI、公式 Codex team、または公式 Codex App と提携・承認・後援・関連していません。
2
+
3
+ # Codex WebApp
4
+
5
+ [English](./README.md) / 日本語 / [한국어](./docs/i18n/README.ko.md) / [简体中文](./docs/i18n/README.zh-CN.md)
6
+
7
+ Codex App を使っている人向けの、敬意ある非公式 WebApp surface です。
8
+
9
+ Codex App に貼れるプロンプト、わかりやすい `doctor`、安全なローカル起動、そして「本当に Codex っぽいブラウザ画面が開けるか」を確認する smoke test をまとめています。
10
+
11
+ ![Codex WebApp overview](./docs/assets/codex-webapp-overview.svg)
12
+
13
+ > OpenAI とは提携しておらず、OpenAI から承認・推奨された公式プロダクトではありません。
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 に貼るプロンプト
41
+
42
+ 以下をそのまま Codex App に貼ってください。
43
+
44
+ ```text
45
+ Please set up Codex WebApp on this machine.
46
+
47
+ Use this npm package:
48
+ codex-webapp@beta
49
+
50
+ Please:
51
+ 1. Check my Codex version.
52
+ 2. Run the package doctor.
53
+ 3. Run start in dry-run mode first.
54
+ 4. Start the local browser UI only on localhost.
55
+ 5. Smoke-test the printed local URL.
56
+
57
+ Keep everything on localhost unless I already have Tailscale, Cloudflare Access,
58
+ or another trusted access boundary set up.
59
+
60
+ Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
61
+ ```
62
+
63
+ Codex は内部でだいたい次のようなコマンドを実行します。
64
+
65
+ ```bash
66
+ npx -y codex-webapp@beta doctor
67
+ npx -y codex-webapp@beta start --dry-run
68
+ npx -y codex-webapp@beta start
69
+ ```
70
+
71
+ `npx` は「npm に公開されているパッケージを、一時的に実行するための仕組み」です。ユーザーが手でプロジェクトを作ったり、依存関係を管理したりする必要を減らします。
72
+
73
+ ## ターミナルで試す場合
74
+
75
+ ```bash
76
+ codex --version
77
+ codex remote-control --help
78
+ npx -y codex-webapp@beta doctor
79
+ npx -y codex-webapp@beta start --dry-run
80
+ npx -y codex-webapp@beta start
81
+ ```
82
+
83
+ デフォルトでは次のローカルURLを使います。
84
+
85
+ ```text
86
+ http://127.0.0.1:8214/
87
+ ```
88
+
89
+ ## Smoke Test
90
+
91
+ UI サーバーを起動したら、次で確認できます。
92
+
93
+ ```bash
94
+ npx -y codex-webapp@beta smoke \
95
+ --url http://127.0.0.1:8214/
96
+ ```
97
+
98
+ ブラウザ証跡を撮る場合:
99
+
100
+ ```bash
101
+ npx -y codex-webapp@beta smoke \
102
+ --browser \
103
+ --url http://127.0.0.1:8214/ \
104
+ --screenshot artifacts/codex-webapp.png
105
+ ```
106
+
107
+ 公開する証跡には、private repo、branch名、アカウント情報、顧客データ、token、cookie、社内URLを含めないでください。
108
+
109
+ ## 安全境界
110
+
111
+ この package は、危険なネットワーク公開を安全に変える魔法ではありません。
112
+
113
+ 推奨:
114
+
115
+ - 自分のMacだけで使うなら `localhost`
116
+ - 自分の端末間だけなら Tailscale
117
+ - 複数人で使うなら Cloudflare Access などの identity-aware proxy
118
+
119
+ 避けること:
120
+
121
+ - 生の UI サーバーを public IP に出す
122
+ - token / cookie / customer data / private repo 内容を public issue に貼る
123
+ - OpenAI 公式プロダクトのように見せる
124
+ - 現在の beta を managed hosting service として扱う
125
+
126
+ ## Security And Privacy
127
+
128
+ この package は open source で、監査可能であることを前提にしています。
129
+
130
+ CLI wrapper は、prompt、repository、token、cookie、customer data を、この project が運営する第三者サーバーへ送信しません。ローカルの Codex 風 browser surface を起動し、指定された URL に対して readiness / smoke check を行います。
131
+
132
+ この package は browser extension をインストールせず、browser token を `localStorage`、`chrome.storage`、extension profile に保存しません。ただし、下層の Codex 風 runtime や、利用者自身が用意する trusted-access layer には別の挙動があり得ます。運用境界として確認してください。
133
+
134
+ public issue や screenshot を共有する前に、secret と private URL は削除してください。
135
+
136
+ ## 謝辞
137
+
138
+ 現在の beta は、Codex 風ブラウザ体験を実現する public project `0xcaff/codex-web` のアプローチを利用・参照しています。この repository は、その周辺に配布、doctor、安全境界、ドキュメント、検証証跡の層を加えるものです。
139
+
140
+ 詳しくは [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md) を参照してください。
141
+
142
+ ## License
143
+
144
+ [Apache-2.0](./LICENSE.md)
package/README.md ADDED
@@ -0,0 +1,271 @@
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
+ # Codex WebApp
6
+
7
+ [![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)
8
+ [![npm version](https://img.shields.io/npm/v/codex-webapp?label=npm)](https://www.npmjs.com/package/codex-webapp)
9
+ [![npm beta](https://img.shields.io/npm/v/codex-webapp/beta?label=beta)](https://www.npmjs.com/package/codex-webapp)
10
+ [![License](https://img.shields.io/npm/l/codex-webapp)](./LICENSE.md)
11
+
12
+ A respectful, community-maintained web app surface for Codex App users.
13
+
14
+ It gives you a pasteable Codex App prompt, a friendly `doctor`, a safe local
15
+ launcher, and smoke tests that prove a real Codex-style browser surface is
16
+ reachable from a machine you control.
17
+
18
+ ![Codex WebApp overview](./docs/assets/codex-webapp-overview.svg)
19
+
20
+ > Not affiliated with or endorsed by OpenAI.
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
68
+
69
+ Paste this into Codex App:
70
+
71
+ ```text
72
+ Please set up Codex WebApp on this machine.
73
+
74
+ Use this npm package:
75
+ codex-webapp@beta
76
+
77
+ Please:
78
+ 1. Check my Codex version.
79
+ 2. Run the package doctor.
80
+ 3. Run start in dry-run mode first.
81
+ 4. Start the local browser UI only on localhost.
82
+ 5. Smoke-test the printed local URL.
83
+
84
+ Keep everything on localhost unless I already have Tailscale, Cloudflare Access,
85
+ or another trusted access boundary set up.
86
+
87
+ Do not print tokens, cookies, private repo contents, customer data, or internal URLs.
88
+ ```
89
+
90
+ Codex should run commands like these for you:
91
+
92
+ ```bash
93
+ npx -y codex-webapp@beta doctor
94
+ npx -y codex-webapp@beta start --dry-run
95
+ npx -y codex-webapp@beta start
96
+ ```
97
+
98
+ If Codex App asks what `npx` means, the plain-English answer is:
99
+
100
+ > `npx` runs a published npm package temporarily, without asking you to install
101
+ > or manage a project by hand.
102
+
103
+ ## Terminal Quick Start
104
+
105
+ Developers can run the same flow from a terminal:
106
+
107
+ ```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
+ npx -y codex-webapp@beta doctor
116
+
117
+ # 4. Preview the launcher command without starting anything.
118
+ npx -y codex-webapp@beta start --dry-run
119
+
120
+ # 5. Start the local Codex-style browser UI.
121
+ npx -y codex-webapp@beta start
122
+ ```
123
+
124
+ By default the browser UI is local only:
125
+
126
+ ```text
127
+ http://127.0.0.1:8214/
128
+ ```
129
+
130
+ ## Browser Smoke Test
131
+
132
+ Once the UI server is running:
133
+
134
+ ```bash
135
+ npx -y codex-webapp@beta smoke \
136
+ --url http://127.0.0.1:8214/
137
+ ```
138
+
139
+ The lightweight smoke test fetches the page and checks for the expected
140
+ Codex-style surface. To capture browser evidence:
141
+
142
+ ```bash
143
+ npx -y codex-webapp@beta smoke \
144
+ --browser \
145
+ --url http://127.0.0.1:8214/ \
146
+ --screenshot artifacts/codex-webapp.png
147
+ ```
148
+
149
+ If Playwright is missing:
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.
163
+
164
+ Use one of these boundaries:
165
+
166
+ - `localhost` only for local use
167
+ - Tailscale for private-device access
168
+ - Cloudflare Access or an equivalent identity-aware proxy for shared access
169
+
170
+ Do not:
171
+
172
+ - expose a raw Codex UI server on a public IP
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
179
+
180
+ This package is open source and intended to be auditable.
181
+
182
+ The CLI wrapper does not send your prompts, repositories, tokens, cookies, or
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.
186
+
187
+ This package does not install a browser extension and does not write browser
188
+ tokens to `localStorage`, `chrome.storage`, or an extension profile. The
189
+ underlying Codex-style runtime and your own trusted-access layer may have their
190
+ own behavior; review and operate those components as part of your deployment
191
+ boundary.
192
+
193
+ 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
+ ![Mobile and trusted-access concept](./docs/assets/codex-webapp-mobile.svg)
202
+
203
+ - **Codex App first**: the primary path is a prompt a non-CLI user can paste
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
215
+
216
+ ```text
217
+ bin/codex-webapp.mjs CLI entrypoint for doctor/start/smoke
218
+ src/commands.js CLI command handlers
219
+ src/browserSmoke.js HTTP and optional Playwright smoke checks
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
+ ```
228
+
229
+ ## Development
230
+
231
+ ```bash
232
+ npm test
233
+ npm pack --dry-run
234
+ npm run start:dry-run
235
+ ```
236
+
237
+ ## Support
238
+
239
+ Open a GitHub issue with:
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
261
+
262
+ The current beta uses and acknowledges the public `0xcaff/codex-web` approach
263
+ for rendering a Codex-like browser surface. This project adds distribution,
264
+ doctor, safety, documentation, and release-evidence layers around that style of
265
+ workflow while keeping the non-affiliation boundary explicit.
266
+
267
+ See [ACKNOWLEDGEMENTS.md](./ACKNOWLEDGEMENTS.md).
268
+
269
+ ## License
270
+
271
+ [Apache-2.0](./LICENSE.md)