codex app-server în OpenAI Codex CLI

Pornește local Codex app server, protocolul prin care alte aplicații integrează Codex, pe stdio, WebSocket sau socket Unix.

Sintaxă & invocare
codex app-server [--listen stdio:// | ws://IP:PORT | unix:// | unix://CALE | off] [opțiuni]

Ce face codex app-server

codex app-server pornește local serverul de aplicații Codex. Este experimental, gândit în principal pentru dezvoltare și depanare, și se poate schimba fără anunț. --listen stdio:// păstrează comportamentul implicit JSONL pe stdio, iar --stdio este alias pentru el.

--listen ws://IP:PORT activează transportul WebSocket. Serverul acceptă doar URL-uri ws://; pentru clienți pe wss:// folosește terminare TLS sau un proxy securizat. --listen unix:// folosește socketul Unix implicit al Codex, iar unix:///cale/absolută.sock alege alt socket. Dacă generezi scheme pentru bindings, adaugă --experimental ca să incluzi câmpurile și metodele limitate.

--code-mode-host conectează serverul la un host Code Mode la distanță în loc să pornească unul local. Conexiunea este separată de --listen și comună tuturor firelor din proces; ws:// se folosește doar pentru localhost sau un host redirecționat prin SSH.

Sintaxă și opțiuni

Opțiune / Parametru Descriere
--stdio Transport stdio; echivalent cu --listen stdio://, exclusiv cu --listen.
--listen <URL> stdio:// (implicit), ws://IP:PORT, unix://, unix://CALE sau off.
--code-mode-host ws://HOST/CALE|wss://HOST/CALE Host Code Mode la distanță.
--ws-auth capability-token|signed-bearer-token Autentificarea clienților WebSocket. Fără ea, autentificarea este oprită, iar listener-ele nelocale afișează un avertisment.
--ws-token-file <cale absolută> Fișierul cu token-ul capability (sau --ws-token-sha256).
--ws-token-sha256 <hex> Digest-ul SHA-256 așteptat pentru token-ul capability.
--ws-shared-secret-file <cale absolută> Secretul HMAC pentru JWT-urile semnate; obligatoriu cu signed-bearer-token.
--ws-issuer / --ws-audience <text> Valorile așteptate pentru iss și aud.
--ws-max-clock-skew-seconds <n> Toleranța de ceas pentru exp și nbf (implicit 30).
--analytics-default-enabled Analytics activ implicit pentru clienții first-party, cu excepția renunțării din configurație.

Exemple practice

Exemplul 1: App server pe WebSocket, cu token

codex app-server --listen ws://127.0.0.1:4500 --ws-auth capability-token --ws-token-file /etc/codex/token

Exemplul 2: TUI-ul conectat la el

codex --remote ws://127.0.0.1:4500

Greșeli frecvente și bune practici

  • Expui serverul pe o interfață publică fără --ws-auth.
  • Pui wss:// direct în --listen; serverul acceptă doar ws://, cu TLS făcut de un proxy.

Comenzi înrudite