codex-worker 0.1.17 → 0.1.19
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 +37 -31
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,57 +12,63 @@ It wraps the app-server protocol in a stable shell surface with local state, res
|
|
|
12
12
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
npm install -g codex-worker
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
One-off execution:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npx codex-worker doctor
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Standalone binary from GitHub Releases:
|
|
15
|
+
One-line install (recommended):
|
|
28
16
|
|
|
29
17
|
```bash
|
|
30
18
|
sudo -v ; curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | sudo bash
|
|
31
19
|
codex-worker doctor
|
|
32
20
|
```
|
|
33
21
|
|
|
34
|
-
|
|
22
|
+
The installer auto-detects OS/arch/libc, downloads the matching release binary plus its `.sha256`, verifies the checksum, and writes `codex-worker` to `/usr/local/bin` as root or `~/.local/bin` otherwise.
|
|
35
23
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
24
|
+
**Override behavior:** if another `codex-worker` is earlier on `PATH` (e.g. a Homebrew symlink at `/opt/homebrew/bin/codex-worker`), the installer removes it so `which codex-worker` resolves to the freshly installed copy. Pass `--no-override` to disable. Only shadowing copies (earlier on `PATH`) are touched; copies later on `PATH` are left alone.
|
|
25
|
+
|
|
26
|
+
### Other install methods
|
|
27
|
+
|
|
28
|
+
| Method | Command |
|
|
29
|
+
| --- | --- |
|
|
30
|
+
| User-local (no sudo) | `curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh \| bash -s -- --install-dir "$HOME/.local/bin"` |
|
|
31
|
+
| Pinned version | `... \| bash -s -- --version 0.1.17` |
|
|
32
|
+
| Dry-run (preview) | `... \| bash -s -- --dry-run` |
|
|
33
|
+
| npm global | `npm install -g codex-worker` |
|
|
34
|
+
| One-off via npx | `npx codex-worker doctor` |
|
|
35
|
+
| Homebrew tap | `brew tap yigitkonur/codex-worker https://github.com/yigitkonur/codex-worker && brew install yigitkonur/codex-worker/codex-worker` |
|
|
36
|
+
| From source | `npm install && npm run build && node dist/src/cli.js --help` |
|
|
39
37
|
|
|
40
|
-
Manual
|
|
38
|
+
Manual download (if you want to skip the installer entirely):
|
|
41
39
|
|
|
42
40
|
```bash
|
|
43
41
|
curl -LO https://github.com/yigitkonur/codex-worker/releases/latest/download/codex-worker-linux-x64
|
|
44
42
|
curl -LO https://github.com/yigitkonur/codex-worker/releases/latest/download/codex-worker-linux-x64.sha256
|
|
45
43
|
sha256sum -c codex-worker-linux-x64.sha256
|
|
46
44
|
chmod +x codex-worker-linux-x64
|
|
47
|
-
mv codex-worker-linux-x64 /usr/local/bin/codex-worker
|
|
45
|
+
sudo mv codex-worker-linux-x64 /usr/local/bin/codex-worker
|
|
48
46
|
```
|
|
49
47
|
|
|
50
|
-
|
|
48
|
+
Full binary distribution details live in [`docs/distribution/binary-releases.md`](./docs/distribution/binary-releases.md).
|
|
51
49
|
|
|
52
|
-
|
|
53
|
-
brew tap yigitkonur/codex-worker https://github.com/yigitkonur/codex-worker
|
|
54
|
-
brew install yigitkonur/codex-worker/codex-worker
|
|
55
|
-
```
|
|
50
|
+
### Installer flags
|
|
56
51
|
|
|
57
|
-
|
|
52
|
+
| Flag | Purpose |
|
|
53
|
+
| --- | --- |
|
|
54
|
+
| `--version <ver>` | Install a specific release tag or version number |
|
|
55
|
+
| `--install-dir <dir>` | Override the install directory |
|
|
56
|
+
| `--target <asset>` | Bypass platform auto-detection and pick a specific release asset |
|
|
57
|
+
| `--repo <owner/repo>` | Install from a fork with the same asset layout |
|
|
58
|
+
| `--force` | Reinstall even if the same version is already present |
|
|
59
|
+
| `--no-verify` | Skip sha256 verification |
|
|
60
|
+
| `--no-override` | Leave other `codex-worker` copies on `PATH` alone |
|
|
61
|
+
| `--dry-run` | Print the resolved install plan without downloading |
|
|
58
62
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
node dist/src/cli.js --help
|
|
63
|
-
```
|
|
63
|
+
Environment overrides: `CODEX_WORKER_INSTALL_DIR`, `CODEX_WORKER_INSTALL_OS`, `CODEX_WORKER_INSTALL_ARCH`, `CODEX_WORKER_INSTALL_LIBC`, `CODEX_WORKER_INSTALL_CPU_FEATURES`, `GITHUB_TOKEN`.
|
|
64
|
+
|
|
65
|
+
### Platform notes
|
|
64
66
|
|
|
65
|
-
|
|
67
|
+
- `codex-worker` still requires the upstream `codex` CLI to be installed and authenticated.
|
|
68
|
+
- Older Linux x86_64 CPUs without `avx2` are auto-served the `codex-worker-linux-x64-baseline` build.
|
|
69
|
+
- Alpine / musl x86_64 without `avx2` has no published asset; build from source on those hosts.
|
|
70
|
+
- Windows: download the `.exe` release asset directly — the shell installer targets Unix-like shells.
|
|
71
|
+
- Pick Homebrew if you want package-manager-owned updates; pick the shell installer if you want the newest release immediately.
|
|
66
72
|
|
|
67
73
|
## CLI Surface
|
|
68
74
|
|
package/dist/package.json
CHANGED