Codex Script for Shell

This is a one-stop installer and manager for the Codex CLI and its model configurations on Linux.

It supports:

• Installing/uninstalling the Codex CLI
• Downloading and switching LLM model configs
• Managing MCP (Model Context Protocol) servers with multi-select support
• Updating the CLI and self-upgrading this script
• Showing install status and versions

Prerequisites

• Linux environment. If you’re on Windows, use WSL (Ubuntu recommended).
• bash, curl, ln, and sha256sum available (present on most distros).
• Network access to your Artifactory (see configuration below).

Quick start

# Installs CLI and default model (kimi-k2)
./codex.sh install

# Or pick a model explicitly
./codex.sh install kimi-k2

# Apply PATH/API key changes made to ~/.bashrc
source ~/.bashrc

# Verify
./codex.sh info
./codex.sh version

Tip: Update the placeholder key in ~/.bashrc (LITELLM_API_KEY=sk-1234) to your real API key.

Common commands

# Help and version
./codex.sh help
./codex.sh version
./codex.sh info

# Update the Codex CLI (re-install flows)
./codex.sh update

# Self-upgrade this script from Artifactory
./codex.sh upgrade

# List models and interactively pick one
./codex.sh model

# Set a model
./codex.sh model <model_name>

# List MCP servers and interactively pick one (or multiple, or 0 to disable all)
./codex.sh mcp

# Set one or more MCP servers (comma-separated)
./codex.sh mcp <mcp_name>
./codex.sh mcp <mcp_name1>,<mcp_name2>,<mcp_name3>

# Example: Enable multiple MCP servers at once
./codex.sh mcp gerrit,git

# Uninstall everything the script installed/added
./codex.sh uninstall

MCP Server Configuration

The script supports Model Context Protocol (MCP) servers, which provide additional tools and capabilities to Codex:

• MCP server configurations are automatically downloaded during install or update
• Configurations are stored in ~/.codex/mcp_servers.toml
• Use ./codex.sh mcp to list available MCP configurations interactively
• Multi-select support: Select multiple MCP servers by entering comma-separated numbers (e.g., 1,3,5)
• Disable all: Enter 0 in the interactive menu to disable all MCP servers
• Use ./codex.sh mcp <mcp_name> to apply a single configuration
• Use ./codex.sh mcp <mcp1>,<mcp2> to enable multiple MCP servers at once
• MCP settings are merged into your active config.toml
• Supported MCP types include STDIO servers (Docker-based) and HTTP servers
• MCP configurations are automatically updated when running ./codex.sh update

Example MCP servers:

• code2prompt: Converts codebase to prompts via Docker
• docker: Provides containerized project operations
• gerrit: Gerrit code review integration
• git: Git repository operations
• custom_api: HTTP-based MCP servers with bearer token authentication

Important: After setting an MCP configuration, ensure you set any required environment variables (like API tokens) in your shell environment.

WSL notes (Windows Subsystem for Linux)

• Run the script inside your Linux (WSL) distro shell, not Windows PowerShell/cmd.
• ~/.bashrc refers to your Linux home. Changes won't affect Windows shells.
• The script supports Linux only; running from Windows directly will show a "only supports Linux" message.

Troubleshooting

• ERROR: Only supports Linux system

  • Run in a Linux shell (or WSL). macOS/Windows shells aren’t supported by this script version.

• ERROR: Unable to query configuration information / downloads fail

  • Verify ARTIFACTORY_HOST/USER/PASS and network access.
  • Ensure the repository and paths exist: codex, codex.sh, config.toml..

• INFO: ~/.bashrc file not found

  • Create it or set BASHRC_PATH to your shell init file, then re-run install.

• codex: command not found after install

  • Source your shell: source ~/.bashrc.
  • Ensure ~/.local/bin is on PATH and the codex file exists/executable.

• Model not listed or selection fails

  • Re-run ./codex.sh update to re-download models.
  • Note: Running update will prompt for confirmation and remove old configurations before updating.

• MCP configuration issues

  • Ensure you've run ./codex.sh update to download latest MCP configurations.
  • Check that required environment variables (API tokens, etc.) are set.
  • MCP servers require their respective tools (Docker for STDIO servers, network access for HTTP servers).
  • Use ./codex.sh mcp to see available configurations and their enabled status.
  • To disable all MCP servers, use the interactive menu and enter 0.
  • You can enable multiple MCP servers at once: ./codex.sh mcp server1,server2,server3
  • If MCP configurations seem outdated, run ./codex.sh update to refresh them from the repository.

• Self-upgrade issues

  • ./codex.sh upgrade compares SHA256 with the remote. If verification fails, the script restores your previous version and exits.

License

This project is licensed under the Apache License - see the LICENSE file for details.