Skip to main content

How to use dsh-codex-connect

Use OpenAI Codex models in DSH via ChatGPT OAuth, with optional independent search, image understanding, and image generation capabilities.

This article is auto-derived from indexed fields (wiki / faq / compatibility_json), not freshly AI-generated.

This article is derived from the plugin's already-indexed fields (wiki / faq / compatibility_json / readme), not freshly generated by AI. Source field is noted at the end of each section.

Quick start

dsh-codex-connect

— source: plugin_wiki.wiki_content

Install & verify

dsh plugin --profile web add dsh-codex-connect

Run the command above in your DSH Web Profile. Then enable the plugin in the plugin list.

— source: plugins.install

Key points

  • For the exact gpt-5.3-codex-spark model, the Composer reads the Spark weekly bucket. Other GPT Codex models read the standard Codex weekly bucket; these are separate limits.
  • id: llm-openai-codex
  • enableSearch: true registers Codex as an available search provider. It does not select the profile's global search route.
  • enableImageTool: true enables view_image for approved local reads and public-network image fetches on vision-capable models.
  • Codex · Weekly is the standard Codex weekly bucket used by ordinary GPT Codex models.

— source: plugin_wiki.readme_en (fallback readme_raw)

FAQ

Will it replace the default model or global search after installation?

No. cordis.patch.yml only adds one line for llm-openai-codex with all capabilities defaulting to false; the default model in profile and web.searchProvider need to be manually configured by the user.

Where are OAuth credentials stored? What's the relationship with ~/.codex/auth.json?

Credentials are stored in $DSH_HOME/.openai-codex-auth.json (default ~/.dsh), separate from Codex CLI/Desktop, and won't be deleted when uninstalling the package. To copy credentials, simply sign in again on the target machine.

Do I need an OpenAI Platform API Key?

No. Codex Connect uses ChatGPT OAuth bearer token; private OpenAI Platform credentials are not read or used.

How to recover login after reinstalling or switching machines?

Simply go to Settings → Plugins → Plugin configuration → Codex Connect and click Sign in with ChatGPT to complete browser authorization. Do not paste authorization codes in issues/logs/config.

Can it be used on Windows? Any limitations?

All capabilities can be used, but OAuth files skip POSIX owner-only checks; history repair commands can only run in dry-run mode on Windows, and apply mode will be rejected.

Will doctor/status/migrate-history leak credentials?

No. doctor only reads lstat metadata and outputs JSON without keys; status only distinguishes between signed-in/signed-out; migrate-history creates a backup in the same directory before modifying, and fail-closed rejects overwriting by default.

After upgrading to DSH 0.1.0-rc.7, Alpha 4.10 search history can't be read. What should I do?

First run dsh plugin --profile web exec dsh-codex-connect migrate-history --json to view and confirm, then stop all DSH, and finally run with --apply --confirm-stopped --json to actually overwrite the history file.

What if both the old dsh-codex are installed?

Harness prohibits duplicate providers and will reject at startup while提示 only one can be kept. First uninstall the old package and remove the extra llm-openai-codex lines from the profile, then add Codex Connect.

— source: plugin_wiki.faq_json

Compatibility

  • DSH: 0.1.0-rc.7
  • Node: >=22.19.0

— source: plugin_wiki.compatibility_json

Pitfalls

Review the upstream repo before installing. This guide is auto-derived from indexed fields and may lag the latest release. If anything contradicts the official docs, treat the upstream source as authoritative.

— source: general rule

How to use dsh-codex-connect