codex-relay 1.0.1-beta.1 → 1.0.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.md +17 -10
- package/api-schema.ts +1 -0
- package/dist/api-schema.js +2 -0
- package/dist/api-schema2.js +1349 -0
- package/dist/cli.js +39 -20
- package/dist/collaboration-mode-templates/default.md +11 -0
- package/dist/collaboration-mode-templates/execute.md +45 -0
- package/dist/collaboration-mode-templates/pair_programming.md +7 -0
- package/dist/collaboration-mode-templates/plan.md +128 -0
- package/dist/paths.js +25 -0
- package/dist/src.js +5349 -697
- package/package.json +12 -5
- package/src/api-schema.ts +1453 -0
- package/dist/src2.js +0 -3072
package/README.md
CHANGED
|
@@ -79,20 +79,27 @@ npx codex-relay@latest approve XXXX-XXXX
|
|
|
79
79
|
|
|
80
80
|
Approve a pending mobile pairing request.
|
|
81
81
|
|
|
82
|
+
```sh
|
|
83
|
+
npx codex-relay@latest --dangerously-auto-approve
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Start the relay and automatically approve mobile pairing requests. Use this only for controlled review or demo environments.
|
|
87
|
+
|
|
82
88
|
## Configuration
|
|
83
89
|
|
|
84
90
|
The relay listens on `0.0.0.0:8787` by default. Configure it with environment variables:
|
|
85
91
|
|
|
86
|
-
| Variable
|
|
87
|
-
|
|
|
88
|
-
| `PORT`
|
|
89
|
-
| `HOST`
|
|
90
|
-
| `CODEX_RELAY_PUBLIC_URL`
|
|
91
|
-
| `CODEX_RELAY_WORKSPACE_PATH`
|
|
92
|
-
| `CODEX_RELAY_AUTH_DB_PATH`
|
|
93
|
-
| `CODEX_RELAY_APPROVAL_SECRET`
|
|
94
|
-
| `
|
|
95
|
-
| `
|
|
92
|
+
| Variable | Purpose |
|
|
93
|
+
| -------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
94
|
+
| `PORT` | Server port. Defaults to `8787`. |
|
|
95
|
+
| `HOST` | Listen host. Defaults to `0.0.0.0`. |
|
|
96
|
+
| `CODEX_RELAY_PUBLIC_URL` | URL printed into the pairing QR, for example a Tailscale or tunnel URL. |
|
|
97
|
+
| `CODEX_RELAY_WORKSPACE_PATH` | Workspace path Codex should use. Defaults to the directory where you run `npx codex-relay@latest`. |
|
|
98
|
+
| `CODEX_RELAY_AUTH_DB_PATH` | Pairing and session database path. Defaults to `.codex-relay/auth.db`. |
|
|
99
|
+
| `CODEX_RELAY_APPROVAL_SECRET` | Secret used by the local approve command. Usually generated automatically. |
|
|
100
|
+
| `CODEX_RELAY_DANGEROUSLY_AUTO_APPROVE` | Set to `1` to auto-approve mobile pairing requests. Prefer the CLI flag for local use. |
|
|
101
|
+
| `CODEX_HOME` | Codex home directory, used when reading Codex session metadata. |
|
|
102
|
+
| `CODEX_BIN` | Codex CLI executable path. |
|
|
96
103
|
|
|
97
104
|
Examples:
|
|
98
105
|
|
package/api-schema.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./src/api-schema";
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
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";
|
|
2
|
+
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 };
|