copilot-relay 0.4.8 → 0.5.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.
Files changed (10) hide show
  1. package/README.md +8 -8
  2. package/config.default.yaml +9 -1
  3. package/dist/main.js +1600 -85
  4. package/dist/main.js.map +1 -1
  5. package/package.json +5 -3
  6. package/vendor/codex/LICENSE +201 -0
  7. package/vendor/codex/NOTICE +6 -0
  8. package/vendor/codex/README.md +15 -0
  9. package/vendor/codex/models.json +1602 -0
  10. package/vendor/codex/prompt.md +275 -0
package/README.md CHANGED
@@ -1,15 +1,16 @@
1
1
  # copilot-relay
2
2
 
3
- **Use Claude Code with the models available through your GitHub Copilot subscription.**
3
+ **Use Claude Code and Codex with the models available through your GitHub Copilot subscription.**
4
4
 
5
- [![CI](https://github.com/D0n9X1n/copilot-relay/actions/workflows/ci.yml/badge.svg)](https://github.com/D0n9X1n/copilot-relay/actions/workflows/ci.yml)
6
- [![npm version](https://img.shields.io/npm/v/copilot-relay.svg?logo=npm)](https://www.npmjs.com/package/copilot-relay)
7
- [![Node.js](https://img.shields.io/badge/node-%3E%3D22-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
8
- [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5
+ [![CI](https://img.shields.io/github/actions/workflow/status/D0n9X1n/copilot-relay/ci.yml?branch=main&logo=githubactions&logoColor=white&label=CI)](https://github.com/D0n9X1n/copilot-relay/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/copilot-relay?logo=npm)](https://www.npmjs.com/package/copilot-relay) [![npm downloads](https://img.shields.io/npm/dm/copilot-relay?logo=npm&label=downloads)](https://www.npmjs.com/package/copilot-relay) [![GitHub release](https://img.shields.io/github/v/release/D0n9X1n/copilot-relay?logo=github)](https://github.com/D0n9X1n/copilot-relay/releases/latest)
6
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D22-339933?logo=node.js&logoColor=white)](https://nodejs.org/) [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white)](tsconfig.json) [![Platforms](https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-lightgrey)](wiki/README.md) [![License: MIT](https://img.shields.io/github/license/D0n9X1n/copilot-relay?color=blue)](LICENSE)
9
7
 
10
8
  ## Features
11
9
 
10
+ [![Watch a one-minute video tour of copilot-relay](https://gitdiagram.com/video-badge.svg)](https://gitdiagram.com/d0n9x1n/copilot-relay/video)
11
+
12
12
  - **Claude Code, familiar workflow** — Messages API compatibility, streaming responses, and tool calls.
13
+ - **Codex CLI and the Codex app** — set up on start with no ChatGPT sign-in, offering the same GPT-6 Astra and Opus 5.5 as Claude Code; [details](wiki/EN-Codex.md) · [中文](wiki/ZH-Codex.md).
13
14
  - **WebSearch that fits the conversation** — relay-managed search, followed by an answer that can still use your tools.
14
15
  - **Your models, your settings** — configurable GPT/Opus routes and reasoning effort; existing selections survive upgrades.
15
16
  - **Use the advertised capacity** — discovered context/output limits, without silently shortening your input.
@@ -74,6 +75,5 @@ scripts. It asks GitHub with the stored token, so no relay needs to run.
74
75
  - Run at login: [macOS](wiki/EN-macOS-LaunchAgent.md) · [Windows](wiki/EN-Windows-Service.md) · [Linux](wiki/EN-Linux-systemd.md)
75
76
  - [Commands](wiki/EN-Commands.md) · [Prompt caching](wiki/EN-Prompt-Caching.md) · [Troubleshoot](wiki/EN-Logging-Troubleshooting.md) · [Understand the architecture](wiki/EN-Architecture.md) · [Contribute](wiki/EN-Development.md)
76
77
 
77
- Unofficial research project; not affiliated with GitHub or Anthropic. Upstream
78
- services and compatibility can change. Model and tool support are not guaranteed;
79
- see the Wiki for known limitations. [MIT licensed](LICENSE).
78
+ Unofficial research project; not affiliated with GitHub, Anthropic or OpenAI. Upstream services and
79
+ compatibility can change; model and tool support are not guaranteed (see the Wiki). [MIT licensed](LICENSE).
package/config.default.yaml CHANGED
@@ -3,7 +3,7 @@
3
3
  # This file is copied to ~/.copilot-relay/config.yaml on first start.
4
4
  # Edit the user config file, not this template, for local changes.
5
5
  # Valid complete edits hot-reload without rewriting this file.
6
- # host, port, claudeSetup, and upstreamProxy require restart.
6
+ # host, port, claudeSetup, codexSetup, and upstreamProxy require restart.
7
7
  #
8
8
  # Values here apply to a fresh install only. copilot-relay writes the resolved
9
9
  # config back to disk, so once a key exists in your config.yaml it is yours:
@@ -43,6 +43,14 @@ upstreamProxy:
43
43
  # CLAUDE_CODE_AUTO_MODE_SERVER=0, when not already set.
44
44
  claudeSetup: true
45
45
 
46
+ # When true, start sets up Codex CLI and the Codex app when Codex is installed
47
+ # ($CODEX_HOME, default ~/.codex, exists). It writes ~/.copilot-relay/codex-models.json,
48
+ # a model list holding only gptModel and opusModel, and points config.toml at this
49
+ # relay: model_provider, model_catalog_json, model (kept when it is one of the two),
50
+ # and the [model_providers.copilot-relay] table, with apiKey sent as x-api-key when
51
+ # set. Codex then needs no ChatGPT sign-in. Other keys and tables are left as they are.
52
+ codexSetup: true
53
+
46
54
  # Log verbosity:
47
55
  # error - startup/preflight/request failures only
48
56
  # info - errors plus status, model/effort and semantic completion summaries