Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 3.06 KB

README.md

File metadata and controls

71 lines (50 loc) · 3.06 KB

coder

coder is a cross-platform detachable wrapper for codex.

It starts codex inside a background broker process that owns the pseudo-terminal. The foreground coder process only attaches your current terminal to that broker. If VS Code closes the terminal, the broker and Codex process keep running.

Usage

coder
coder resume

While attached, press Ctrl+] to detach without stopping Codex.

The wrapper does not reserve public command-line arguments. Arguments are passed to Codex. Plain coder and plain coder resume reattach to the default broker when one exists. Targeted resumes such as coder resume <session-id> get their own broker key, so separate resumed sessions do not steal each other's terminal.

Set CODER_CODEX to override the program used for Codex. By default this machine uses C:\Programs\nodejs\node.exe with the installed Codex JavaScript entrypoint. If Codex cannot be found, coder exits with a message explaining how to install Codex or set CODER_CODEX.

Set CODER_SESSION to use a separate broker name:

$env:CODER_SESSION = 'worktree-a'
coder

If Codex exits with an out-of-memory signature, the broker keeps the session alive and restarts Codex after 3 minutes.

Install

Release assets are unpacked single binaries. Linux is built with musl, Windows is built with the static CRT, and macOS is shipped as a universal binary.

Linux, bash:

repo=flcl42/coder; mkdir -p "$HOME/.local/bin"; curl -fsSL "https://github.com/$repo/releases/latest/download/coder-linux-x86_64" -o "$HOME/.local/bin/coder"; chmod +x "$HOME/.local/bin/coder"; grep -qxF 'export PATH="$HOME/.local/bin:$PATH"' "$HOME/.bashrc" || echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$HOME/.bashrc"

macOS, zsh:

repo=flcl42/coder; mkdir -p "$HOME/.local/bin"; curl -fsSL "https://github.com/$repo/releases/latest/download/coder-macos-universal" -o "$HOME/.local/bin/coder"; chmod +x "$HOME/.local/bin/coder"; grep -qxF 'export PATH="$HOME/.local/bin:$PATH"' "$HOME/.zshrc" || echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$HOME/.zshrc"

Windows, PowerShell:

$repo='flcl42/coder'; $dir='C:\Programs'; New-Item -ItemType Directory -Force $dir | Out-Null; Invoke-WebRequest "https://github.com/$repo/releases/latest/download/coder-windows-x86_64.exe" -OutFile "$dir\coder.exe"; $p=[Environment]::GetEnvironmentVariable('Path','User'); if (($p -split ';') -notcontains $dir) { [Environment]::SetEnvironmentVariable('Path', ((@($p -split ';') + $dir | Where-Object { $_ }) -join ';'), 'User'); $env:Path += ";$dir" }

Development

When publishing an updated build to C:\Programs\coder.exe, stop any running coder.exe broker/client processes first if they lock the file, then replace the binary directly. Do not leave a separate fixed-name executable as the normal test path.

Exception: for input-handling fixes or other changes where preserving active sessions is more important than immediate install, do not stop live coder.exe processes. Build target\release\coder.exe and install it after the active sessions exit.