codex-copilot-dx 0.5.4 → 0.5.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.
- package/README.md +11 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,6 +60,8 @@ ccdx update npm
|
|
|
60
60
|
ccdx update github
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
+
`ccdx update gh` is accepted as a shorthand for the GitHub source.
|
|
64
|
+
|
|
63
65
|
The npm source installs `codex-copilot-dx@latest` through the registry already
|
|
64
66
|
configured for npm, including a company mirror. The GitHub source installs the
|
|
65
67
|
latest commit from `DaleXiao/codex-copilot-dx` `main` and opts in to Git fetching
|
|
@@ -68,6 +70,8 @@ for that command, as required by npm 12. It does not change npm's persistent
|
|
|
68
70
|
interpolation. A currently running adapter keeps its loaded version until it is
|
|
69
71
|
stopped and started again. The
|
|
70
72
|
`codex-copilot-dx update` compatibility command behaves identically.
|
|
73
|
+
If a configured npm mirror has not synchronized the current release yet, use
|
|
74
|
+
the GitHub source to install the current `main` revision.
|
|
71
75
|
|
|
72
76
|
On first run, it will:
|
|
73
77
|
1. Authenticate with GitHub via device flow (if needed), after first trying compatible local Copilot token sources
|
|
@@ -194,7 +198,9 @@ Environment variables:
|
|
|
194
198
|
| `CCDX_IMG_CACHE_MAX_BYTES` | `67108864` | Process-local byte ceiling for cached image optimization results; set to `0` to disable result caching |
|
|
195
199
|
| `CCDX_DISABLE_IMG_OPT` | unset | Set to `1` to disable image optimization |
|
|
196
200
|
| `CCDX_CONFIGURE_CLAUDE_DESKTOP` | unset | Set to `1` to write the Claude App 3P gateway profile during startup |
|
|
201
|
+
| `CCDX_AUTO_LAUNCH` | enabled | Set to `0`, `false`, `no`, or `off` to start the adapter without opening Codex or ChatGPT |
|
|
197
202
|
| `CCDX_CLAUDE_DESKTOP_API_KEY` | managed profile or generated for opt-in setup | Explicit bearer key written into the Claude App profile and recognized by the adapter for model discovery |
|
|
203
|
+
| `CCDX_PROXY_API_KEY` | unset | Backward-compatible alias for `CCDX_CLAUDE_DESKTOP_API_KEY`; the Claude-specific variable takes precedence |
|
|
198
204
|
| `CCDX_CLAUDE_MODEL_ALIASES` | built-in Claude aliases | Comma-separated Desktop-to-upstream aliases, for example `claude-sonnet-4-6=claude-sonnet-4.6` |
|
|
199
205
|
| `CCDX_GITHUB_TOKEN` | unset | Explicit GitHub Copilot OAuth token to validate and import before device login |
|
|
200
206
|
| `CCDX_GITHUB_TOKEN_PATH` | unset | Explicit file containing a GitHub Copilot OAuth token to validate and import before device login |
|
|
@@ -204,6 +210,7 @@ Environment variables:
|
|
|
204
210
|
| `CCDX_TOKEN_LOCK_TIMEOUT_MS` | `600000` | Maximum time to wait for another local process to finish GitHub token login/import |
|
|
205
211
|
| `CCDX_TOKEN_LOCK_STALE_MS` | `900000` | Age after which a stale GitHub token lock file can be removed |
|
|
206
212
|
| `CCDX_EXISTING_ADAPTER_TIMEOUT_MS` | `500` | Timeout for detecting an already-running local adapter during startup |
|
|
213
|
+
| `CCDX_MODEL_REFRESH_TIMEOUT_MS` | `5000` | Timeout for a Copilot model metadata refresh or live Auto-review model lookup |
|
|
207
214
|
| `CCDX_MODEL_REFRESH_INTERVAL_MS` | `7200000` | Interval for refreshing Copilot model metadata; successful lists are cached locally as last-known-good data |
|
|
208
215
|
| `CCDX_RESPONSE_HISTORY_MAX_BYTES` | `67108864` | Total in-memory byte budget for locally expanded Responses history |
|
|
209
216
|
| `CCDX_RESPONSE_HISTORY_MAX_ENTRIES` | `4096` | Maximum stored incremental Responses history nodes |
|
|
@@ -216,14 +223,14 @@ Environment variables:
|
|
|
216
223
|
|
|
217
224
|
The adapter records token usage metadata to `~/.local/share/codex-copilot-dx/usage.jsonl` when upstream responses include usage fields. It logs counts, model names, API surface, and response IDs only; it does not log prompts, completions, tool arguments, or image content.
|
|
218
225
|
|
|
219
|
-
### Debug logging
|
|
220
|
-
|
|
221
|
-
Set `CCDX_LOG_PATH=1` to mirror terminal logs to `~/.local/share/codex-copilot-dx/debug.log`, or set `CCDX_LOG_PATH` to a custom file. Add `CCDX_LOG_LEVEL=debug` to include upstream request attempts, retry causes, status codes, and timings. Debug logs do not include prompts, completions, request bodies, or authorization tokens.
|
|
222
|
-
|
|
223
226
|
```bash
|
|
224
227
|
ccdx usage
|
|
225
228
|
```
|
|
226
229
|
|
|
230
|
+
### Debug logging
|
|
231
|
+
|
|
232
|
+
Set `CCDX_LOG_PATH=1` to mirror terminal logs to `~/.local/share/codex-copilot-dx/debug.log`, or set `CCDX_LOG_PATH` to a custom file. Add `CCDX_LOG_LEVEL=debug` to include upstream request attempts, retry causes, status codes, and timings. Debug logs do not include prompts, completions, request bodies, or authorization tokens.
|
|
233
|
+
|
|
227
234
|
### Image optimization
|
|
228
235
|
|
|
229
236
|
Long computer-use sessions can accumulate screenshots inside the conversation history. Each screenshot is shipped on later turns, and GitHub Copilot's `/responses` endpoint can reject oversized requests with `408 Request Timeout` while reading the body or `413 Payload Too Large`.
|