Metadata-Version: 2.4
Name: jupyterlab_codex_extension
Version: 0.6.12
Summary: Session management for the OpenAI Codex CLI in JupyterLab
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_codex_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_codex_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_codex_extension.git
Author-email: Stellars Henson <konrad.jelen+github@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Stellars Henson
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: jupyter-server<3,>=2.4.0
Provides-Extra: dev
Requires-Dist: jupyter-builder>=1.0.0; extra == 'dev'
Requires-Dist: jupyterlab>=4; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
Description-Content-Type: text/markdown

# jupyterlab_codex_extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_codex_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_codex_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/jupyterlab_codex_extension.svg)](https://www.npmjs.com/package/jupyterlab_codex_extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab_codex_extension.svg)](https://pypi.org/project/jupyterlab_codex_extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab_codex_extension)](https://pepy.tech/project/jupyterlab_codex_extension)
[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
[![Brought To You By KOLOMOLO](https://img.shields.io/badge/Brought%20To%20You%20By-KOLOMOLO-00ffff?style=flat)](https://kolomolo.com)
[![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-blue?style=flat)](https://www.paypal.com/donate/?hosted_button_id=B4KPBJDLLXTSA)

Session management for the OpenAI Codex CLI in JupyterLab. Start, resume, fork, switch, and clean up Codex CLI sessions from a side panel - one click lands you in the right terminal with Codex already running, no duplicate tabs, no session-id hunting. The Codex counterpart of [jupyterlab_claude_code_extension](https://github.com/stellarshenson/jupyterlab_claude_code_extension), with identical functionality wherever the Codex CLI makes it possible.

The extension runs the genuine, unmodified Codex CLI in JupyterLab terminals - every Codex release works the day it lands. The extension owns the JupyterLab side: launching, finding, reusing, and managing sessions.

![Codex Sessions panel](.resources/screenshot.png)

## Features

- **Side panel** with Favorites, Recent, and All projects, each scrolling independently
- **One-click resume** - click a row to jump back into that session; a terminal already running that conversation is reused, never duplicated
- **Live activity indicator** - see which projects have a Codex process running right now, with last-activity times on every row
- **Session switcher** - list a project's parallel conversations, pick one and the next click resumes exactly that one
- **Branch session** - fork the current conversation into a new one in its own terminal
- **Clean up parallel sessions** - remove a project's extra conversations, keeping only the current one; honours JupyterLab's trash setting, archiving conversations when it is on and deleting them permanently when it is off
- **Search** - fuzzy filter across projects, with presentation modes (session name or relative path)
- **Approval bypass** - opt-in and off by default: a setting and a matching menu entry launch Codex with `--dangerously-bypass-approvals-and-sandbox`, skipping every approval prompt and the sandbox
- **Auto-disabled** when the Codex CLI is not installed

## Requirements

- JupyterLab >= 4.0.0
- Python >= 3.10
- `codex` CLI on `PATH`

## Install

To install the extension, execute:

```bash
pip install jupyterlab_codex_extension
```

Developers build and install via the project Makefile:

```bash
make install
```

> [!WARNING]
> `package.json` pins `webpack: 5.106.0` and `chalk: 4.1.2` in both `resolutions` and `overrides`. Do not remove these. webpack `>= 5.106.1` changed its module-federation share identifier format and crashes the unmaintained `license-webpack-plugin` (`split('=')[1].trim()`) that `@jupyterlab/builder` injects into every production build; the duplicate `chalk@2.4.2` pulled by `duplicate-package-checker-webpack-plugin` crashes on Node 24+ in the build-isolation install. Without the pins, `make publish` and CI fail on `python -m build`.

> [!NOTE]
> Codex mints its own session ids, so a new or forked conversation is identified after launch rather than before it. Everything the Codex CLI cannot express is recorded as a deviation in `docs/acc-crit-jupyterlab-codex-extension.md`.

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterlab_codex_extension
```
