codex-webapp 0.1.3 → 0.1.5

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 (6) hide show
  1. package/README.ja.md +40 -17
  2. package/README.md +18 -1
  3. package/docs/codex-app-install.md +18 -16
  4. package/docs/i18n/README.ko.md +1 -1
  5. package/docs/i18n/README.zh-CN.md +1 -1
  6. package/package.json +1 -1
package/README.ja.md CHANGED
@@ -28,34 +28,57 @@ Codex は、ターミナルだけで完結するツールから、よりアプ
28
28
 
29
29
  ## Codex App から始める
30
30
 
31
- Codex App を使っている場合は、次の指示をそのまま貼ってください。Codex が準備確認、dry-run、ローカルUIの起動、smoke test までを進め、成功・失敗を報告する想定です。
31
+ Codex App を使っている場合は、次の指示をそのまま貼ってください。Codex が「npm package を一時実行して、ローカルのWeb画面を起動し、ブラウザで開く」ことを認識しやすいように書いてあります。
32
32
 
33
33
  ```text
34
- Please set up Codex WebApp on this machine.
34
+ Codex WebApp をこのPCで起動してください。
35
35
 
36
- Use this npm package:
37
- codex-webapp
36
+ これは OpenAI 公式ではない、Codex App向けの非公式 companion UI です。
37
+ token、cookie、private repository の中身、顧客データ、内部URLは表示しないでください。
38
+ `.env` や `SECRET`、`KEY`、`TOKEN` を含むterminal出力は、AIにもissueにも貼らないでください。
38
39
 
39
- Please:
40
- 1. Check my Codex version. Codex CLI must be 0.130.0 or newer because this uses `codex remote-control`.
41
- 2. Run the package doctor.
42
- 3. Run start in dry-run mode first.
43
- 4. Start the local browser UI on localhost.
44
- 5. Smoke-test the printed local URL.
40
+ 次の順番で進めてください。
45
41
 
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.
42
+ 1. まず `node -v`、`npm -v`、`npx -v` を確認してください。`npx` が使えない場合は、ここで止まり、Node.js/npm が必要だと説明してください。
43
+ 2. `npx -y codex-webapp@latest doctor` を実行して、Codex CLI が 0.130.0 以上で、`codex remote-control` が使えるか確認してください。
44
+ 3. `doctor` がエラーを出した場合は、ここで止まり、`start` には進まず、原因と直し方を説明してください。
45
+ 4. `npx -y codex-webapp@latest start --dry-run` を実行して、起動予定の内容を確認してください。
46
+ 5. 問題なければ `npx -y codex-webapp@latest start` を実行して、ローカルのブラウザUIを起動してください。
47
+ 6. 起動できたら、ブラウザで `http://127.0.0.1:8214/` を開くように案内してください。
48
+ 7. この terminal window を閉じるとWeb画面は止まること、止めたいときは `Ctrl+C` を押すこと、PCを再起動した後はもう一度 `npx -y codex-webapp@latest start` が必要なことも説明してください。
49
+
50
+ 外出先のPCやスマホから使う場合は、raw UI server をpublic IPへ直接公開せず、Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を使ってください。認証なしのport-forwardingやpublic tunnelは使わないでください。
48
51
  ```
49
52
 
50
53
  実際には、おおむね次のようなコマンドが実行されます。
51
54
 
52
55
  ```bash
53
- npx -y codex-webapp doctor
54
- npx -y codex-webapp start --dry-run
55
- npx -y codex-webapp start
56
+ npx -y codex-webapp@latest doctor
57
+ npx -y codex-webapp@latest start --dry-run
58
+ npx -y codex-webapp@latest start
56
59
  ```
57
60
 
58
- `npx` は、npm に公開されている package を一時的に実行する仕組みです。試すだけなら、この repository を clone したり、手元で新しい project を作ったりする必要はありません。
61
+ `npx` は、npm に公開されている package を一時的に実行する仕組みです。試すだけなら、この repository を clone したり、手元で新しい project を作ったりする必要はありません。READMEでは、常に公開済みの最新パッチを使うため `codex-webapp@latest` を指定しています。
62
+
63
+ > **秘密情報はユーザー側でも確認してください。** Codexには秘密情報を出さないよう指示していますが、AIへの指示だけで安全が保証されるわけではありません。terminal output、`.env`、error log、issue本文を貼る前に、`SECRET`、`KEY`、`TOKEN`、cookie、顧客名、private URL が含まれていないか必ず見てください。
64
+
65
+ ## 起動中だけ使える、という基本
66
+
67
+ Codex WebApp はクラウド上に常駐するサービスではありません。あなたのPC上で `npx -y codex-webapp@latest start` が動いている間だけ、ブラウザUIが使えます。
68
+
69
+ 大事なポイントは、**PCを再起動すると、このプロセスは自動では戻らない**ということです。昨日使えていても、今日PCを再起動した後は、もう一度 `npx -y codex-webapp@latest start` を実行する必要があります。
70
+
71
+ | できごと | 何が起きるか | どうすればよいか |
72
+ | --- | --- | --- |
73
+ | terminal window を閉じた | Web画面は止まります。 | もう一度 `npx -y codex-webapp@latest start` を実行します。 |
74
+ | 起動中のUIを止めたい | terminal上のプロセスを止めます。 | 起動しているterminalで `Ctrl+C` を押してください。 |
75
+ | PCをスリープした | 復帰後に動く場合もありますが、接続が切れることがあります。 | 開けない場合は起動し直してください。 |
76
+ | PCを再起動した | プロセスは残りません。昨日のWeb画面はもう動いていません。 | 再起動後にもう一度 `npx -y codex-webapp@latest start` を実行してください。 |
77
+ | 別のPCやスマホから開きたい | `127.0.0.1` は「このPC自身」を指すため、そのままでは別端末から開けません。 | Tailscale、Cloudflare Access、または同等の安全なアクセス境界を用意してください。 |
78
+
79
+ まずは同じPCのブラウザで `http://127.0.0.1:8214/` を開けるところまでを確認してください。スマホや外出先PCからの利用は、その次の段階です。認証なしのport-forwardingやpublic tunnelでraw UI serverを公開すると、意図しない第三者にあなたのPC上のCodex操作面を見せる危険があります。
80
+
81
+ 毎日使う場合は、PC起動時に自動で `npx -y codex-webapp@latest start` を実行する設定を検討できます。これは「PCを再起動しても、毎回自分でstartし直さなくてよい」ようにするための設定です。ただし、初回セットアップではなく常用者向けです。まず手動起動で `doctor`、`start`、ブラウザ表示、止め方、アクセス境界を確認してから、macOS の Login Items、`launchd`、または自分が管理できるプロセスマネージャーで設定してください。自動起動する場合も、raw UI server を認証なしで外へ出さないでください。
59
82
 
60
83
  ## ターミナルから始める
61
84
 
@@ -127,7 +150,7 @@ Codex WebApp は telemetry、analytics、browser extension、project-operated ph
127
150
  | Codex CLI | `codex remote-control` を使うため、`0.130.0` 以上が必要です。 |
128
151
  | Node.js | `20` 以上が必要です。 |
129
152
  | network binding | デフォルトは `127.0.0.1`。非 loopback host は明示的な opt-in が必要です。 |
130
- | package channel | npm の `latest` channel から `codex-webapp` を使ってください。現在の release は `0.1.3` です。 |
153
+ | package channel | npm の `latest` channel から `codex-webapp` を使ってください。現在の release は `0.1.5` です。 |
131
154
 
132
155
  Codex が入っていない、または古い場合は、先に更新してください。
133
156
 
package/README.md CHANGED
@@ -57,6 +57,23 @@ npx -y codex-webapp start
57
57
 
58
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.
59
59
 
60
+ ## It only works while the process is running
61
+
62
+ Codex WebApp is not a hosted cloud service. The browser UI is available only while `npx -y codex-webapp start` is running on your computer.
63
+
64
+ The important point: **after your computer restarts, that process does not come back automatically.** Even if the browser UI worked yesterday, you need to run `npx -y codex-webapp start` again after a reboot unless you have deliberately configured auto-start.
65
+
66
+ | Event | What happens | What to do |
67
+ | --- | --- | --- |
68
+ | You close the terminal window | The browser UI stops. | Run `npx -y codex-webapp start` again. |
69
+ | The computer sleeps | The connection may survive, but it can also break. | Restart the command if the page no longer opens. |
70
+ | The computer restarts | The process is gone. Yesterday’s browser UI is no longer running. | Run `npx -y codex-webapp start` again after rebooting. |
71
+ | You want to open it from a phone or another PC | `127.0.0.1` means “this same computer,” so another device cannot use that URL directly. | Put Tailscale, Cloudflare Access, or an equivalent trusted access boundary in front first. |
72
+
73
+ Start with the same computer first: run the command, then open `http://127.0.0.1:8214/` in that computer’s browser. Phone and remote access should come after that local check passes.
74
+
75
+ If you use this every day, you may eventually want an auto-start setup that runs `npx -y codex-webapp start` when the computer starts. Treat that as an advanced, after-the-first-success step. First confirm manual `doctor`, `start`, browser access, how to stop the process, and your trusted access boundary. If you do configure auto-start through Login Items, `launchd`, or a process manager you control, still do not expose the raw UI server without authentication.
76
+
60
77
  ## Quick start from a terminal
61
78
 
62
79
  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**.
@@ -127,7 +144,7 @@ Codex WebApp does not include telemetry, analytics, a browser extension, or a pr
127
144
  | Codex CLI | `0.130.0` or newer, because `codex remote-control` is required. |
128
145
  | Node.js | `20` or newer. |
129
146
  | 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.3`. |
147
+ | Package channel | `codex-webapp` from the npm `latest` channel. Current release: `0.1.5`. |
131
148
 
132
149
  If Codex is missing or too old, update it first.
133
150
 
package/docs/codex-app-install.md CHANGED
@@ -15,24 +15,26 @@ Tailscale, Cloudflare Access, or an equivalent trusted boundary.
15
15
 
16
16
  ## Paste Prompt
17
17
 
18
- Paste this prompt into Codex App:
18
+ Paste this prompt into Codex App. Japanese is intentional here: it is written for users who may be more comfortable asking Codex App in Japanese.
19
19
 
20
20
  ```text
21
- Please verify Codex WebApp on this machine.
22
-
23
- Constraints:
24
- - Treat it as an unofficial companion UI, not an OpenAI-endorsed tool.
25
- - Do not paste or print tokens, cookies, private repository content, customer data, or internal URLs.
26
- - Keep any raw Codex browser server or app-server on localhost or behind Tailscale, Cloudflare Access, or an equivalent trusted boundary.
27
-
28
- Steps:
29
- 1. Check whether Codex is available and whether `codex remote-control --help` works.
30
- 2. If Codex is older than 0.130.0, explain the update that is needed.
31
- 3. Run `npx -y codex-webapp doctor`.
32
- 4. Run `npx -y codex-webapp start --dry-run`.
33
- 5. If a UI server is available, run `npx -y codex-webapp smoke --url http://127.0.0.1:8214/`.
34
- 6. Use `--browser --screenshot artifacts/codex-webapp.png` only when browser evidence is needed.
35
- 7. Summarize pass/fail status and start a small diagnosis if a step fails.
21
+ Codex WebApp をこのPCで起動してください。
22
+
23
+ これは OpenAI 公式ではない、Codex App向けの非公式 companion UI です。
24
+ token、cookie、private repository の中身、顧客データ、内部URLは表示しないでください。
25
+ `.env` や `SECRET`、`KEY`、`TOKEN` を含むterminal出力は、AIにもissueにも貼らないでください。
26
+
27
+ 次の順番で進めてください。
28
+
29
+ 1. まず `node -v`、`npm -v`、`npx -v` を確認してください。`npx` が使えない場合は、ここで止まり、Node.js/npm が必要だと説明してください。
30
+ 2. `npx -y codex-webapp@latest doctor` を実行して、Codex CLI が 0.130.0 以上で、`codex remote-control` が使えるか確認してください。
31
+ 3. `doctor` がエラーを出した場合は、ここで止まり、`start` には進まず、原因と直し方を説明してください。
32
+ 4. `npx -y codex-webapp@latest start --dry-run` を実行して、起動予定の内容を確認してください。
33
+ 5. 問題なければ `npx -y codex-webapp@latest start` を実行して、ローカルのブラウザUIを起動してください。
34
+ 6. 起動できたら、ブラウザで `http://127.0.0.1:8214/` を開くように案内してください。
35
+ 7. この terminal window を閉じるとWeb画面は止まること、止めたいときは `Ctrl+C` を押すこと、PCを再起動した後はもう一度 `npx -y codex-webapp@latest start` が必要なことも説明してください。
36
+
37
+ 外出先のPCやスマホから使う場合は、raw UI server をpublic IPへ直接公開せず、Tailscale、Cloudflare Access、または同等の信頼できるアクセス境界を使ってください。認証なしのport-forwardingやpublic tunnelは使わないでください。
36
38
  ```
37
39
 
38
40
  The proof we want is not that a developer can type commands. The proof is that
package/docs/i18n/README.ko.md CHANGED
@@ -80,7 +80,7 @@ npx -y codex-webapp smoke \
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
- 현재 release는 `0.1.3`이며 early, compatibility-first입니다. 현재 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda`를 참조하는 Codex 스타일 browser runtime을 실행하고, 그 주변에 설치, 안전, 문서, 검증 evidence 계층을 더합니다.
83
+ 현재 release는 `0.1.5`이며 early, compatibility-first입니다. 현재 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda`를 참조하는 Codex 스타일 browser runtime을 실행하고, 그 주변에 설치, 안전, 문서, 검증 evidence 계층을 더합니다.
84
84
 
85
85
  ## Security And Privacy
86
86
 
package/docs/i18n/README.zh-CN.md CHANGED
@@ -80,7 +80,7 @@ npx -y codex-webapp smoke \
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
- 当前 release 为 `0.1.3`，仍处于 early 阶段，并采用 compatibility-first 方针。它目前运行一个引用 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda` 的 Codex 风格 browser runtime，并在其周围增加安装、安全、文档和验证证据层。
83
+ 当前 release 为 `0.1.5`，仍处于 early 阶段，并采用 compatibility-first 方针。它目前运行一个引用 `0xcaff/codex-web` commit `585613f5a3a355af5aefc388ca4e31b07a472cda` 的 Codex 风格 browser runtime，并在其周围增加安装、安全、文档和验证证据层。
84
84
 
85
85
  ## Security And Privacy
86
86
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codex-webapp",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
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",