codex-bridge

(β˜… 114)

A lightweight MCP server bridging AI agents to OpenAI models via official CLI

  • .gitignore
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • RELEASE_NOTES_v1.2.1.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/eLyiN/codex-bridge

Downloads the entire project code from GitHub to your computer.

cd codex-bridge

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
  • Python 3 Python is required to use pip.
npm install -g @openai/codex-cli

Installs the package published on the npm registry globally β€” no need to clone the source.

pip install codex-bridge

Installs the package published on PyPI directly β€” no need to clone the source.

pip install dist/*.whl

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t codex-bridge .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 codex-bridge

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install codex-bridge

Installs the package published on PyPI directly β€” no need to clone the source.

pip install dist/*.whl

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

claude mcp add codex-bridge-dev -s user -- python -m src

Runs the Python script (or module).

python -m src

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation