codex-relay 1.0.1 → 1.0.3

package/README.md

@@ -13,7 +13,7 @@ Codex Relay runs a local bridge server for the Codex Relay mobile app. Keep Code
 Run the server from the workspace you want Codex to use:
 
 ```sh
-npx codex-relay
+npx codex-relay@latest
 ```
 
 The CLI prints a QR code, a mobile URL, and a `codex-relay://pair...` pairing payload. Scan the QR code from the mobile app. If scanning is not available, paste the full pairing payload into the app.
@@ -21,7 +21,7 @@ The CLI prints a QR code, a mobile URL, and a `codex-relay://pair...` pairing pa
 When the app shows an approval code, approve it on the computer:
 
 ```sh
-npx codex-relay approve XXXX-XXXX
+npx codex-relay@latest approve XXXX-XXXX
 ```
 
 After approval, the phone can list Codex threads, start new work, stream messages, and handle approval prompts from the local Codex runtime.
@@ -31,7 +31,7 @@ After approval, the phone can list Codex threads, start new work, stream message
 To keep the relay running after the command returns:
 
 ```sh
-npx codex-relay --bg
+npx codex-relay@latest --bg
 ```
 
 Background mode writes runtime files under `.codex-relay/` in the current directory:
@@ -44,7 +44,7 @@ Background mode writes runtime files under `.codex-relay/` in the current direct
 Print the current pairing QR again:
 
 ```sh
-npx codex-relay qr
+npx codex-relay@latest qr
 ```
 
 Stop a background server with the printed process id:
@@ -56,56 +56,63 @@ kill -TERM <pid>
 ## Commands
 
 ```sh
-npx codex-relay
+npx codex-relay@latest
 ```
 
 Start the relay in the foreground.
 
 ```sh
-npx codex-relay --bg
+npx codex-relay@latest --bg
 ```
 
 Start the relay in the background.
 
 ```sh
-npx codex-relay qr
+npx codex-relay@latest qr
 ```
 
 Print the latest pairing QR for an already running relay.
 
 ```sh
-npx codex-relay approve XXXX-XXXX
+npx codex-relay@latest approve XXXX-XXXX
 ```
 
 Approve a pending mobile pairing request.
 
+```sh
+npx codex-relay@latest --dangerously-auto-approve
+```
+
+Start the relay and automatically approve mobile pairing requests. Use this only for controlled review or demo environments.
+
 ## Configuration
 
 The relay listens on `0.0.0.0:8787` by default. Configure it with environment variables:
 
-| Variable                      | Purpose                                                                                     |
-| ----------------------------- | ------------------------------------------------------------------------------------------- |
-| `PORT`                        | Server port. Defaults to `8787`.                                                            |
-| `HOST`                        | Listen host. Defaults to `0.0.0.0`.                                                         |
-| `CODEX_RELAY_PUBLIC_URL`      | URL printed into the pairing QR, for example a Tailscale or tunnel URL.                     |
-| `CODEX_RELAY_WORKSPACE_PATH`  | Workspace path Codex should use. Defaults to the directory where you run `npx codex-relay`. |
-| `CODEX_RELAY_AUTH_DB_PATH`    | Pairing and session database path. Defaults to `.codex-relay/auth.db`.                      |
-| `CODEX_RELAY_APPROVAL_SECRET` | Secret used by the local approve command. Usually generated automatically.                  |
-| `CODEX_HOME`                  | Codex home directory, used when reading Codex session metadata.                             |
-| `CODEX_BIN`                   | Codex CLI executable path.                                                                  |
+| Variable                               | Purpose                                                                                            |
+| -------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `PORT`                                 | Server port. Defaults to `8787`.                                                                   |
+| `HOST`                                 | Listen host. Defaults to `0.0.0.0`.                                                                |
+| `CODEX_RELAY_PUBLIC_URL`               | URL printed into the pairing QR, for example a Tailscale or tunnel URL.                            |
+| `CODEX_RELAY_WORKSPACE_PATH`           | Workspace path Codex should use. Defaults to the directory where you run `npx codex-relay@latest`. |
+| `CODEX_RELAY_AUTH_DB_PATH`             | Pairing and session database path. Defaults to `.codex-relay/auth.db`.                             |
+| `CODEX_RELAY_APPROVAL_SECRET`          | Secret used by the local approve command. Usually generated automatically.                         |
+| `CODEX_RELAY_DANGEROUSLY_AUTO_APPROVE` | Set to `1` to auto-approve mobile pairing requests. Prefer the CLI flag for local use.             |
+| `CODEX_HOME`                           | Codex home directory, used when reading Codex session metadata.                                    |
+| `CODEX_BIN`                            | Codex CLI executable path.                                                                         |
 
 Examples:
 
 ```sh
-PORT=8788 npx codex-relay
+PORT=8788 npx codex-relay@latest
 ```
 
 ```sh
-CODEX_RELAY_PUBLIC_URL=http://100.64.0.10:8787 npx codex-relay
+CODEX_RELAY_PUBLIC_URL=http://100.64.0.10:8787 npx codex-relay@latest
 ```
 
 ```sh
-CODEX_RELAY_WORKSPACE_PATH=/path/to/project npx codex-relay
+CODEX_RELAY_WORKSPACE_PATH=/path/to/project npx codex-relay@latest
 ```
 
 ## Network Notes
@@ -118,16 +125,16 @@ The phone must be able to reach the URL printed as `Mobile:` by the relay.
 
 ## Troubleshooting
 
-If `npx codex-relay qr` cannot find a server, start one first:
+If `npx codex-relay@latest qr` cannot find a server, start one first:
 
 ```sh
-npx codex-relay
+npx codex-relay@latest
 ```
 
 If the relay says another process is using the local pairing database, use the existing server:
 
 ```sh
-npx codex-relay qr
+npx codex-relay@latest qr
 ```
 
 Or stop the background process shown by the CLI:

package/api-schema.ts

@@ -0,0 +1 @@
+export * from "./src/api-schema";

package/dist/api-schema.js

@@ -0,0 +1,2 @@
+import { $ as SandboxModeSchema, A as PairResponseSchema, At as stripPromptSkillMentions, B as QueuedThreadInputSchema, C as ListQueuedThreadInputsResponseSchema, Ct as isPromptSkillMarkdownMention, D as ListWorkspaceFilesResponseSchema, Dt as promptSkillMentionLabel, E as ListWorkspaceDirectoriesResponseSchema, Et as promptSkillDisplayName, F as PromptAttachmentSummarySchema, G as ResolveApprovalRequestSchema, H as RateLimitWindowSchema, I as PromptContextInputSchema, J as RunThreadResponseSchema, K as ResolveApprovalResponseSchema, L as PromptContextSchema, M as PendingInputRequestQuestionSchema, N as PendingInputRequestSchema, O as PairEncryptedPayloadSchema, Ot as promptSkillMentionMarkdown, P as PromptAttachmentSchema, Q as RuntimePreferencesSchema, R as PromptSkillSchema, S as ListModelsResponseSchema, St as createOpenApiDocument, T as ListThreadsResponseSchema, Tt as promptMarkdownWithSkills, U as RateLimitsResponseSchema, V as RateLimitBucketSchema, W as ReasoningEffortSchema, X as RuntimePreferencesByWorkspacePathSchema, Y as RuntimeModeSchema, Z as RuntimePreferencesResponseSchema, _ as EncryptedPayloadSchema, _t as WorkspaceFileMentionSchema, a as ArchiveThreadResponseSchema, at as ThreadContextWindowResponseSchema, b as InterruptThreadRunResponseSchema, bt as apiPaths, c as ChatMessageRoleSchema, ct as ThreadMessageDetailResponseSchema, d as CheckoutWorkspaceBranchRequestSchema, dt as ThreadSummarySchema, et as StatusResponseSchema, f as CodexModelSchema, ft as UpdateRuntimePreferencesRequestSchema, g as CreateThreadResponseSchema, gt as WorkspaceDirectoryEntrySchema, h as CreateThreadRequestSchema, ht as WorkspaceChangesResponseSchema, i as ApprovalModeSchema, it as ThreadCollaborationModeSchema, j as PendingInputRequestOptionSchema, k as PairRequestSchema, kt as promptSkillMentionTextCandidates, l as ChatMessageSchema, lt as ThreadRunOptionsSchema, m as ContextWindowUsageSchema, mt as WebPreviewTargetSchema, n as AgentSkillSourceSchema, nt as StreamThreadRunRequestSchema, o as ChatMessageKindSchema, ot as ThreadDetailResponseSchema, p as CommitPushWorkspaceRequestSchema, pt as VersionResponseSchema, q as RunThreadRequestSchema, r as ApprovalDecisionSchema, rt as SubmitThreadInputResponseSchema, s as ChatMessagePromptDetailsSchema, st as ThreadMessageDetailFieldSchema, t as AgentSkillSchema, tt as StreamThreadRunEventSchema, u as ChatMessageStateSchema, ut as ThreadStateSchema, v as ErrorResponseSchema, vt as WorkspaceGitActionResponseSchema, w as ListSkillsResponseSchema, wt as normalizePromptContext, x as IsoDateTimeSchema, xt as chatMessageDetailsFromPromptContext, y as ImageAttachmentUploadResponseSchema, yt as WorkspaceSelectionRequestSchema, z as QueuedThreadInputActionResponseSchema } from "./api-schema2.js";
+export { AgentSkillSchema, AgentSkillSourceSchema, ApprovalDecisionSchema, ApprovalModeSchema, ArchiveThreadResponseSchema, ChatMessageKindSchema, ChatMessagePromptDetailsSchema, ChatMessageRoleSchema, ChatMessageSchema, ChatMessageStateSchema, CheckoutWorkspaceBranchRequestSchema, CodexModelSchema, CommitPushWorkspaceRequestSchema, ContextWindowUsageSchema, CreateThreadRequestSchema, CreateThreadResponseSchema, EncryptedPayloadSchema, ErrorResponseSchema, ImageAttachmentUploadResponseSchema, InterruptThreadRunResponseSchema, IsoDateTimeSchema, ListModelsResponseSchema, ListQueuedThreadInputsResponseSchema, ListSkillsResponseSchema, ListThreadsResponseSchema, ListWorkspaceDirectoriesResponseSchema, ListWorkspaceFilesResponseSchema, PairEncryptedPayloadSchema, PairRequestSchema, PairResponseSchema, PendingInputRequestOptionSchema, PendingInputRequestQuestionSchema, PendingInputRequestSchema, PromptAttachmentSchema, PromptAttachmentSummarySchema, PromptContextInputSchema, PromptContextSchema, PromptSkillSchema, QueuedThreadInputActionResponseSchema, QueuedThreadInputSchema, RateLimitBucketSchema, RateLimitWindowSchema, RateLimitsResponseSchema, ReasoningEffortSchema, ResolveApprovalRequestSchema, ResolveApprovalResponseSchema, RunThreadRequestSchema, RunThreadResponseSchema, RuntimeModeSchema, RuntimePreferencesByWorkspacePathSchema, RuntimePreferencesResponseSchema, RuntimePreferencesSchema, SandboxModeSchema, StatusResponseSchema, StreamThreadRunEventSchema, StreamThreadRunRequestSchema, SubmitThreadInputResponseSchema, ThreadCollaborationModeSchema, ThreadContextWindowResponseSchema, ThreadDetailResponseSchema, ThreadMessageDetailFieldSchema, ThreadMessageDetailResponseSchema, ThreadRunOptionsSchema, ThreadStateSchema, ThreadSummarySchema, UpdateRuntimePreferencesRequestSchema, VersionResponseSchema, WebPreviewTargetSchema, WorkspaceChangesResponseSchema, WorkspaceDirectoryEntrySchema, WorkspaceFileMentionSchema, WorkspaceGitActionResponseSchema, WorkspaceSelectionRequestSchema, apiPaths, chatMessageDetailsFromPromptContext, createOpenApiDocument, isPromptSkillMarkdownMention, normalizePromptContext, promptMarkdownWithSkills, promptSkillDisplayName, promptSkillMentionLabel, promptSkillMentionMarkdown, promptSkillMentionTextCandidates, stripPromptSkillMentions };