@rcodex-lab/gateway
v1.4.16
Published
rCodex Gateway CLI for connecting local Codex runtime to rCodex apps.
Readme
rCodex Gateway
Linux and macOS one-command install:
curl -fsSL https://dl.rcodex.org/rcodex/install.sh | shManual npm install:
npm install -g @rcodex-lab/gateway
rcodex-gateway setup
rcodex-gateway service install
rcodex-gateway service startRequires Node.js 22 or later. Automatic Node.js installation on Linux requires
glibc 2.28 or newer; older systems may provide their own working Node.js 22.
The Gateway package includes the official
@openai/codex runtime, so a separate global Codex CLI installation is not
required. Codex still needs a valid ChatGPT login, API key, or configured
provider credential for actual model requests.
Use rcodex-gateway start only for foreground debugging. The service commands install a user-level background service with auto start.
On Windows, new installations store configuration and data under %LOCALAPPDATA%\rCodex\Gateway. Existing C:\ProgramData\rCodex\Gateway\gateway.env installations remain supported. The background task runs after the current user logs in, uses that user's home directory and Codex credentials, creates no CMD or PowerShell window, and continues running after the terminal closes. Installation does not require administrator privileges or the Windows account password.
Use rcodex-gateway service status to check the scheduled task, Gateway process, HTTP health, and log paths. After upgrading an older Windows installation, run rcodex-gateway service install again before restarting so the latest task definition is applied.
Use rcodex-gateway service update to update the same npm prefix that contains
the running Gateway package, refresh the service definition, restart it, and
print the final status. The command never invokes sudo automatically.
Use rcodex-gateway config to print the effective configuration after the local
gateway.env, process environment, and built-in defaults are merged. Passwords,
tokens, URL credentials, and sensitive command arguments are always hidden. The
command is read-only and does not start or modify the Gateway.
The bundled Codex runtime is used when CODEX_COMMAND is unset, still has the
legacy default value codex, or points to a versioned Codex executable inside
the VS Code openai.chatgpt-* extension. Set CODEX_COMMAND only when the
Gateway must use an explicitly managed external Codex executable.
