Skip to content

Commit 13a8f21

Browse files
committed
Document musl C compiler requirement
Update docs to clarify that portable Linux (musl) builds require a musl C compiler in addition to the Rust musl target. Changes add a CHANGELOG entry and expand README requirements with Debian/Ubuntu installation hints (musl-tools) and a note about the x86_64-linux-musl-gcc tool, plus a troubleshooting tip when the musl C compiler is not found.
1 parent fadb574 commit 13a8f21

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ All notable changes to this project are documented in this file.
88
- Added `--app-server-bin` for standalone Codex App Server executables.
99
- Added Windows auto-detection for common Codex App bundled App Server locations.
1010
- Project activity token headers now show total/out-of-cache token pairs.
11+
- Documented the musl C compiler requirement for portable Linux builds.
1112

1213
## 0.3.4 - 2026-04-24
1314

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ See `CHANGELOG.md` for release history.
1515
<img width="2088" height="952" alt="WindowsTerminal_nrizljNtk5" src="https://github.com/user-attachments/assets/cf2ac2e7-3a94-48cd-9d3b-1a4a98016f45" />
1616
<img width="2088" height="952" alt="WindowsTerminal_HjIAOZQKWE" src="https://github.com/user-attachments/assets/4e3eed0a-d3aa-4ae5-bc4e-c6e5400bc1dd" />
1717

18+
1819
## Requirements
1920

2021
- Rust toolchain (stable) installed.
2122
- C/C++ compiler toolchain available (needed to build bundled SQLite through `rusqlite`).
2223
- Codex CLI installed as `codex` on your `PATH`, or a discoverable/explicit Codex App Server executable (required only for live limits/credits).
2324
- Usage stats still work without Codex CLI (they only need the session logs on disk).
24-
- For portable Linux builds (`--musl`), `rustup` and musl target toolchain support are required.
25+
- For portable Linux builds (`--musl`), install both the Rust musl target and a musl C compiler.
26+
- Debian/Ubuntu: `sudo apt install musl-tools`
27+
- Required tool for x86_64 musl builds: `x86_64-linux-musl-gcc`
2528

2629
## Run
2730

@@ -203,6 +206,7 @@ Linux/macOS:
203206
bash scripts/install-user.sh
204207

205208
# Portable Linux build/install (musl target, auto-detected arch):
209+
# Requires musl-tools on Debian/Ubuntu.
206210
bash scripts/install-user.sh --musl
207211

208212
# Explicit target example:
@@ -248,6 +252,11 @@ bash scripts/package-prebuilt.sh --musl
248252
ls dist/comon-v*-unknown-linux-musl.zip
249253
```
250254

255+
If a musl build fails with `failed to find tool "x86_64-linux-musl-gcc"`,
256+
install `musl-tools` and retry. Adding the Rust target with `rustup target add`
257+
is necessary but not sufficient because bundled SQLite is compiled through a C
258+
compiler.
259+
251260
Additional maintainer options:
252261

253262
```bash

0 commit comments

Comments
 (0)