mirror of
https://github.com/openai/codex.git
synced 2026-04-28 02:11:08 +03:00
c1ff22bc6c
It introduces a dedicated `installer/` folder for non-Rust install/update assets, a `CODEX_HOME`-aware on-disk layout, and a wrapper that makes helper CLIs available to Codex without globally polluting the user’s shell. ## Why Today the recommended install path is `npm i -g @openai/codex`, but the npm package bundles native binaries for all platforms (and `rg`), leading to very large installs (hundreds of MB unpacked) even though a single platform binary is much smaller. Homebrew avoids this on macOS by downloading only the matching artifact. This PR brings that same property to a cross-platform one-liner: ```sh curl -fsSL https://raw.githubusercontent.com/openai/codex/main/installer/install.sh | bash ``` Key goals: - Download only the user’s platform artifacts. - Keep curl-managed installs isolated under `CODEX_HOME`. - Preserve compatibility with npm/brew installs (shadowing is fine, breaking is not). - Provide a clean place to add helper CLIs that should be available when Codex runs. ## How It Works ### Install root and layout All curl-managed artifacts live under `CODEX_HOME` (default: `~/.codex`). The layout is: - `CODEX_HOME/bin/` - `CODEX_HOME/versions/<version>/bin/` - `CODEX_HOME/versions/current` (symlink) - `CODEX_HOME/tools/bin/` This design supports atomic version switches and helper CLIs: - The user’s global `PATH` only needs `CODEX_HOME/bin`. - The runtime `PATH` is extended inside the wrapper to include helper CLIs. See `installer/README.md:1`. ### Installer scripts #### `installer/install.sh` `installer/install.sh:1` is the public entrypoint: - Requires Bash explicitly (we use Bash features like `mapfile`). - Loads `installer/lib.sh` locally when run from a checkout, or downloads it when piped from curl. - Detects `arch`/`os`, resolves the version (via `CODEX_VERSION` or GitHub Releases), downloads the correct tarball, installs it, activates it, and updates the user’s rc file. #### `installer/lib.sh` `installer/lib.sh:10` centralizes the mechanics: - Resolves `CODEX_HOME` with a fallback to `~/.codex`. - Detects OS/arch and builds release URLs. - Idempotently updates the user rc file via a marker block that respects non-default `CODEX_HOME` values: `installer/lib.sh:106`. - Installs a wrapper at `CODEX_HOME/bin/codex` that: - Sets `CODEX_MANAGED_BY_CURL=1`. - Extends `PATH` at runtime to include: - `CODEX_HOME/bin` - `CODEX_HOME/tools/bin` - `CODEX_HOME/versions/current/bin` - Execs the active versioned binary: `installer/lib.sh:154`. - Installs the tarball into a versioned `bin/` directory and preserves any additional CLIs present in the tarball (not just `codex`): `installer/lib.sh:181`. - Keeps the last two installed versions and avoids deleting the `current` symlink: `installer/lib.sh:239`. #### `installer/update.sh` `installer/update.sh:1` mirrors the installer flow but always targets the latest release. ### Update UX integration in the CLI Codex’s update prompt already knows how to run a package-manager-specific update command after the TUI exits. This PR adds a curl-managed update action in `codex-rs/tui/src/update_action.rs:3`: - Adds `UpdateAction::CurlInstallerUpdate`. - Detects curl-managed installs via `CODEX_MANAGED_BY_CURL` (set by the wrapper): `codex-rs/tui/src/update_action.rs:40`. - Uses the curl updater one-liner for the update command: `codex-rs/tui/src/update_action.rs:21`. This keeps update behavior consistent with npm/brew while avoiding fragile path heuristics. ## Docs updates - The curl installer is now the first recommended install path in `README.md:1` and `README.md:18`. - `docs/install.md:11` adds a curl install section and points to `installer/README.md` for the detailed mechanics. ## Compatibility and safety notes - This does not modify npm or Homebrew installs. - The rc-file change only adds `CODEX_HOME/bin` to `PATH`. - Additional helper CLIs are available to Codex via the wrapper’s runtime `PATH`, rather than being forced into the user’s global shell. - The installer honors `CODEX_HOME` everywhere, falling back to `~/.codex`. ## Testing Commands run: ```sh cd codex-rs just fmt cargo test -p codex-tui ``` Notes: - In this environment, `cargo test -p codex-tui` required running outside the sandbox due to a macOS `SystemConfiguration` panic; it passed once run with escalated permissions. - No new VS Code diagnostics were reported. ## Follow-ups (explicitly not in this PR) - Ensure the release tarballs include any helper CLIs we expect to be available at runtime (for example, Windows sandbox helpers). - Add an explicit `codex self-update` command that delegates to `installer/update.sh`. - Decide how we want to manage third-party tools like `rg` under `CODEX_HOME/tools/` and whether the CLI should probe a managed fallback path.
74 lines
1.8 KiB
Bash
Executable File
74 lines
1.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
if [ -z "${BASH_VERSION:-}" ]; then
|
|
echo "This installer requires bash." >&2
|
|
echo "Re-run with: curl -fsSL https://raw.githubusercontent.com/openai/codex/main/installer/install.sh | bash" >&2
|
|
exit 1
|
|
fi
|
|
|
|
set -euo pipefail
|
|
|
|
INSTALLER_BASE_URL="${CODEX_INSTALLER_BASE_URL:-https://raw.githubusercontent.com/openai/codex/main/installer}"
|
|
|
|
load_lib() {
|
|
local script_dir lib_path tmp_lib
|
|
script_dir="$(cd "$(dirname "${BASH_SOURCE[0]:-$0}")" && pwd)"
|
|
lib_path="${script_dir}/lib.sh"
|
|
|
|
if [ -f "$lib_path" ]; then
|
|
# Running from a repo checkout.
|
|
# shellcheck disable=SC1090
|
|
source "$lib_path"
|
|
return
|
|
fi
|
|
|
|
tmp_lib="$(mktemp)"
|
|
curl -fsSL "${INSTALLER_BASE_URL}/lib.sh" -o "$tmp_lib"
|
|
# shellcheck disable=SC1090
|
|
source "$tmp_lib"
|
|
rm -f "$tmp_lib"
|
|
}
|
|
|
|
load_lib
|
|
|
|
main() {
|
|
ensure_dirs
|
|
|
|
local arch os tag version url tarball rc_file resolved_home
|
|
arch="$(detect_arch)"
|
|
os="$(detect_os)"
|
|
|
|
if [ -n "${CODEX_VERSION:-}" ]; then
|
|
version="$(normalize_version "$CODEX_VERSION")"
|
|
tag="$(release_tag_for_version "$version")"
|
|
else
|
|
tag="$(latest_tag)"
|
|
if [ -z "$tag" ]; then
|
|
echo "Failed to determine the latest Codex release tag." >&2
|
|
exit 1
|
|
fi
|
|
version="$(normalize_version "$tag")"
|
|
fi
|
|
|
|
url="$(release_url "$version" "$arch" "$os")"
|
|
tarball="$(mktemp)"
|
|
curl -fsSL "$url" -o "$tarball"
|
|
|
|
install_version_from_tarball "$version" "$tarball" "$arch" "$os"
|
|
activate_version "$version"
|
|
install_wrapper
|
|
cleanup_old_versions 2
|
|
|
|
rc_file="$(choose_rc_file)"
|
|
resolved_home="$(codex_home)"
|
|
ensure_path_block "$rc_file" "$resolved_home"
|
|
|
|
rm -f "$tarball"
|
|
|
|
echo "Codex ${version} installed to ${resolved_home}"
|
|
echo "Updated PATH in ${rc_file}"
|
|
echo "Open a new shell or run: source ${rc_file}"
|
|
}
|
|
|
|
main "$@"
|