Codex
========================================

| `Codex <https://developers.openai.com/codex>`__ is the official AI agent from OpenAI.
| It can be used on the ARIM-mdx Jupyter / SSH server (``jupyter.arim.mdx.jp``). See :doc:`jupyter` for how to connect. For long-running autonomous work, run it inside ``tmux`` so that it keeps running after you disconnect.

Installation
------------

Run the install script.

.. code-block:: bash

   curl -fsSL https://chatgpt.com/codex/install.sh | sh

Authentication
--------------

Authenticate with one of the following methods.

* **Browser login (ChatGPT account)**: Run the following and an authentication URL is shown. Open it in a browser on your local PC and log in.

  .. code-block:: bash

     codex login

* **API key**: Set an API key obtained from the `OpenAI Platform <https://developers.openai.com/codex>`__ as an environment variable.

  .. code-block:: bash

     export OPENAI_API_KEY="sk-..."

  Add this line to ``~/.bashrc`` to keep it after you log in again.

Starting
--------

Move to your project directory and start it.

.. code-block:: bash

   cd <working directory>
   codex

See the `Codex documentation <https://developers.openai.com/codex>`__ for details.