Skip to main content

Remote-friendly web workspace for Codex sessions

Project description

Open Codex UI

Open Codex UI

A remote-friendly web workspace for continuing Codex sessions from desktop and mobile browsers.

[!IMPORTANT] Non-commercial use only. This project is provided solely for learning, research, personal use, and other non-commercial purposes. Commercial use requires prior written permission from the copyright holder.

Preview

Open Codex UI desktop workspace

Open Codex UI mobile chat    Open Codex UI mobile project drawer

Quick Start

Run the packaged application through Node.js:

npx open-codex-ui

The npm launcher reuses an existing uvx, or installs uv from Astral's official installer into its own cache. You can also run the Python package directly with uv:

uvx open-codex-ui

Open http://127.0.0.1:13140. The wheel already contains the compiled frontend. To accept connections from other devices, bind explicitly to the network:

uvx open-codex-ui serve --host 0.0.0.0 --port 13140

Background Service

Install the command persistently and register login startup:

npx open-codex-ui daemon install
# or
uvx open-codex-ui daemon install

This installs open-codex-ui into uv's user bin directory and uses the native service manager for the current platform:

Platform Service
macOS LaunchAgent in ~/Library/LaunchAgents
Linux systemd --user service
Windows Current-user Task Scheduler task

After opening a new shell, manage the service directly:

open-codex-ui daemon status
open-codex-ui daemon stop
open-codex-ui daemon start
open-codex-ui daemon uninstall

The service starts when the user logs in. Runtime state, retained environment, and logs live under ~/.yier/web/. Run daemon install again to update its host, port, or captured environment; use update for application versions.

Updating

Update a persistent installation to the latest stable release:

open-codex-ui update
# or
npx open-codex-ui update

If the login service is running, it is restarted after the update. Plain uvx and npx runs resolve their release when launched, so the command makes no persistent changes when no uv tool installation exists.

Authentication

Authentication is disabled unless a password variable is configured:

export YIER_AUTH_PASSWORD='change-this-password'
uvx open-codex-ui daemon install --host 0.0.0.0

For a hashed password:

uv run --with open-codex-ui python -c "from yier_web.auth import hash_password; print(hash_password('change-this-password'))"
export YIER_AUTH_PASSWORD_HASH='paste-generated-hash-here'
Variable Purpose
YIER_AUTH_PASSWORD Plain login password
YIER_AUTH_PASSWORD_HASH Hashed login password
YIER_AUTH_SECRET Additional session-cookie signing secret
YIER_AUTH_SESSION_TTL_HOURS Session lifetime; defaults to 168 hours
YIER_CODEX_EMBED_TOKEN Token for unauthenticated iframe access

daemon install retains HOME, PATH, CODEX_HOME, and current YIER_* variables in a user-only environment file so they remain available after login.

Development

Source development requires Python 3.12+, Node.js 20+, uv, and pnpm:

uv sync
pnpm --dir web install
uv run dev

The application remains at http://127.0.0.1:13140; in development mode the backend proxies frontend traffic to the Vite server on port 5173.

Command Purpose
uv run dev Start frontend and backend with reload
uv run dev-web Start Vite only
uv run dev-backend Start the backend only
uv run publish Type-check and build frontend assets into yier_web/static
uv run open-codex-ui Run the source checkout in production mode
uv run pytest Run backend tests
uv run python -m compileall yier_web Check Python compilation
pnpm --dir web test:unit Run frontend unit tests
pnpm --dir web type-check Run frontend type checking

To test the production build from source:

uv run publish
uv run open-codex-ui

Codex integration is provided by the published open-codex-bridge package.

Iframe Embedding

See IFRAME.md for iframe authentication, setup, and the postMessage API.

License

Copyright 2026 Sube (zhangluguang). Licensed under the PolyForm Noncommercial License 1.0.0. Commercial use is not permitted without separate written authorization from the copyright holder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_codex_ui-0.1.7.tar.gz (866.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_codex_ui-0.1.7-py3-none-any.whl (858.0 kB view details)

Uploaded Python 3

File details

Details for the file open_codex_ui-0.1.7.tar.gz.

File metadata

  • Download URL: open_codex_ui-0.1.7.tar.gz
  • Upload date:
  • Size: 866.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for open_codex_ui-0.1.7.tar.gz
Algorithm Hash digest
SHA256 22ca9147b0db83605272066e1cb80ce6f3e5a4cc11189db6cb73298e9cf5b581
MD5 3ccb07a421769010dc499fe25be3da35
BLAKE2b-256 b48083fabbc41caf967793ddadce0582f7f784be8635c6054ffebf315ec59f0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_codex_ui-0.1.7.tar.gz:

Publisher: publish.yml on Sube-py/open-codex-ui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_codex_ui-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: open_codex_ui-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 858.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for open_codex_ui-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 417c4968f8d4aee8bcec5b33cef786d10516807ec724e223ed833c2dbb5d1195
MD5 b4bd7970a99cf13784416bb5c5be7d5d
BLAKE2b-256 2e64216615c8c6542ec2dfdd6f7757c1fc1930f60c7a9de48d101e702da54ac6

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_codex_ui-0.1.7-py3-none-any.whl:

Publisher: publish.yml on Sube-py/open-codex-ui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page