codex-worker 0.1.18 → 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 +34 -86
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,115 +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
|
-
|
|
15
|
+
One-line install (recommended):
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
sudo -v ; curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | sudo bash
|
|
19
19
|
codex-worker doctor
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
The installer
|
|
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.
|
|
23
23
|
|
|
24
|
-
|
|
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
25
|
|
|
26
|
-
|
|
27
|
-
npm install -g codex-worker
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
One-off execution:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
npx codex-worker doctor
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
User-local install without `sudo`:
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --install-dir "$HOME/.local/bin"
|
|
40
|
-
```
|
|
26
|
+
### Other install methods
|
|
41
27
|
|
|
42
|
-
|
|
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` |
|
|
43
37
|
|
|
44
|
-
|
|
45
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --version 0.1.17 --install-dir "$HOME/.local/bin"
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Inspect what the installer would do without downloading:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --dry-run
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Manual binary install remains available:
|
|
38
|
+
Manual download (if you want to skip the installer entirely):
|
|
55
39
|
|
|
56
40
|
```bash
|
|
57
41
|
curl -LO https://github.com/yigitkonur/codex-worker/releases/latest/download/codex-worker-linux-x64
|
|
58
42
|
curl -LO https://github.com/yigitkonur/codex-worker/releases/latest/download/codex-worker-linux-x64.sha256
|
|
59
43
|
sha256sum -c codex-worker-linux-x64.sha256
|
|
60
44
|
chmod +x codex-worker-linux-x64
|
|
61
|
-
mv codex-worker-linux-x64 /usr/local/bin/codex-worker
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Homebrew from this repository:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
brew tap yigitkonur/codex-worker https://github.com/yigitkonur/codex-worker
|
|
68
|
-
brew install yigitkonur/codex-worker/codex-worker
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
From source:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
npm install
|
|
75
|
-
npm run build
|
|
76
|
-
node dist/src/cli.js --help
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
The repository now includes a live Bun-binary distribution pipeline. Every push validates the binary distribution path, GitHub Releases publish the standalone binaries, and the installer script is shipped as a release asset. Full rollout details live in [`docs/distribution/binary-releases.md`](./docs/distribution/binary-releases.md).
|
|
80
|
-
|
|
81
|
-
## Installer Details
|
|
82
|
-
|
|
83
|
-
The published installer is the same file exposed at:
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh
|
|
45
|
+
sudo mv codex-worker-linux-x64 /usr/local/bin/codex-worker
|
|
87
46
|
```
|
|
88
47
|
|
|
89
|
-
|
|
48
|
+
Full binary distribution details live in [`docs/distribution/binary-releases.md`](./docs/distribution/binary-releases.md).
|
|
90
49
|
|
|
91
|
-
|
|
92
|
-
- Detects `arm64` vs `x64`
|
|
93
|
-
- Detects `glibc` vs `musl` on Linux
|
|
94
|
-
- Uses `codex-worker-linux-x64-baseline` on older Linux x86_64 CPUs that do not report `avx2`
|
|
95
|
-
- Downloads the matching binary plus matching `.sha256`
|
|
96
|
-
- Verifies the checksum before install unless `--no-verify` is passed
|
|
97
|
-
- Installs to `/usr/local/bin` by default as root, otherwise falls back to `~/.local/bin` when `/usr/local/bin` is not writable
|
|
98
|
-
- Skips reinstalling when the requested version is already installed unless `--force` is passed
|
|
50
|
+
### Installer flags
|
|
99
51
|
|
|
100
|
-
|
|
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 |
|
|
101
62
|
|
|
102
|
-
|
|
103
|
-
- `--install-dir <dir>` installs into a custom directory
|
|
104
|
-
- `--target <asset-name>` bypasses platform auto-detection and installs a specific release asset
|
|
105
|
-
- `--repo <owner/repo>` installs from another GitHub repository with the same asset layout
|
|
106
|
-
- `--force` reinstalls even if the same version is already present
|
|
107
|
-
- `--no-verify` skips checksum verification
|
|
108
|
-
- `--dry-run` prints the resolved install plan without downloading
|
|
109
|
-
|
|
110
|
-
Examples:
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --version v0.1.17
|
|
114
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --target codex-worker-linux-x64
|
|
115
|
-
curl -fsSL https://github.com/yigitkonur/codex-worker/releases/latest/download/install.sh | bash -s -- --force
|
|
116
|
-
```
|
|
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`.
|
|
117
64
|
|
|
118
|
-
Platform
|
|
65
|
+
### Platform notes
|
|
119
66
|
|
|
120
|
-
- `codex-worker` still requires the upstream `codex` CLI to be installed and authenticated
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
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.
|
|
124
72
|
|
|
125
73
|
## CLI Surface
|
|
126
74
|
|
package/dist/package.json
CHANGED