gpt5-codex-cli


Namegpt5-codex-cli JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryTask-oriented GPT-5 Codex command line interface with streaming and web search
upload_time2025-10-28 00:37:35
maintainerNone
docs_urlNone
authorOpenAI Codex CLI Contributors
requires_python>=3.9
licenseMIT
keywords openai codex cli assistant gpt-5
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GPT-5 Codex CLI

A lightweight terminal client that mirrors the experience of products like OpenAI's Codex CLI, Claude Code, and Gemini Code. The tool focuses on high-level task execution (not just code generation) by defaulting to the `gpt-5-codex` model with both streaming output and the web search tool enabled.

## Features

- Autodetects `OPENAI_API_KEY` and guides you to create one if it is missing.
- Streaming responses that closely resemble established AI coding assistants.
- Web search tool enabled by default so the model can pull in fresh information as needed.
- Clean interactive loop for multi-turn task planning and execution, plus one-shot mode via CLI arguments.

## Installation

```bash
pip install -e .
```

This project depends on the [official OpenAI Python SDK](https://pypi.org/project/openai/). Install it automatically through the editable install above or explicitly with `pip install openai`.

## Usage

Interactive session:

```bash
export OPENAI_API_KEY="sk-..."
gpt5-codex
```

Single task run:

```bash
gpt5-codex "Plan a two-day itinerary for Tokyo that balances food, art, and tech"
```

Optional flags:

- `--model MODEL_NAME` – override the default `gpt-5-codex` model.
- `--temperature FLOAT` – tune the generation temperature (default `0.2`).
- `--no-search` – disable the built-in web search tool.
- `--no-stream` – disable streaming output.

## Testing

```bash
pip install -e .[dev]
pytest
```

## Publishing to PyPI

The repository includes a standard `pyproject.toml`. To publish:

```bash
python -m build
python -m twine upload dist/*
```

> **Note:** Uploading requires a PyPI account and network access, which may not be available in every environment.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gpt5-codex-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "openai, codex, cli, assistant, gpt-5",
    "author": "OpenAI Codex CLI Contributors",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/2a/fb/d735782562cd0b2da0c6011aa8705e9efee1b0cdee33069c25b4b6cbf118/gpt5_codex_cli-0.1.0.tar.gz",
    "platform": null,
    "description": "# GPT-5 Codex CLI\n\nA lightweight terminal client that mirrors the experience of products like OpenAI's Codex CLI, Claude Code, and Gemini Code. The tool focuses on high-level task execution (not just code generation) by defaulting to the `gpt-5-codex` model with both streaming output and the web search tool enabled.\n\n## Features\n\n- Autodetects `OPENAI_API_KEY` and guides you to create one if it is missing.\n- Streaming responses that closely resemble established AI coding assistants.\n- Web search tool enabled by default so the model can pull in fresh information as needed.\n- Clean interactive loop for multi-turn task planning and execution, plus one-shot mode via CLI arguments.\n\n## Installation\n\n```bash\npip install -e .\n```\n\nThis project depends on the [official OpenAI Python SDK](https://pypi.org/project/openai/). Install it automatically through the editable install above or explicitly with `pip install openai`.\n\n## Usage\n\nInteractive session:\n\n```bash\nexport OPENAI_API_KEY=\"sk-...\"\ngpt5-codex\n```\n\nSingle task run:\n\n```bash\ngpt5-codex \"Plan a two-day itinerary for Tokyo that balances food, art, and tech\"\n```\n\nOptional flags:\n\n- `--model MODEL_NAME` \u2013 override the default `gpt-5-codex` model.\n- `--temperature FLOAT` \u2013 tune the generation temperature (default `0.2`).\n- `--no-search` \u2013 disable the built-in web search tool.\n- `--no-stream` \u2013 disable streaming output.\n\n## Testing\n\n```bash\npip install -e .[dev]\npytest\n```\n\n## Publishing to PyPI\n\nThe repository includes a standard `pyproject.toml`. To publish:\n\n```bash\npython -m build\npython -m twine upload dist/*\n```\n\n> **Note:** Uploading requires a PyPI account and network access, which may not be available in every environment.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Task-oriented GPT-5 Codex command line interface with streaming and web search",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/PDFSage/openai_cli",
        "Repository": "https://github.com/PDFSage/openai_cli"
    },
    "split_keywords": [
        "openai",
        " codex",
        " cli",
        " assistant",
        " gpt-5"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ee1916cfee5442c75292a6f143da906ebf24dd873dc8e647007c4e71f66c9736",
                "md5": "c8129e643c33faf9f0bde27b64d9c228",
                "sha256": "3205b53c1b66c43e917a1dd2611343f4970fa6973a55c8e958f80667a7fdf483"
            },
            "downloads": -1,
            "filename": "gpt5_codex_cli-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c8129e643c33faf9f0bde27b64d9c228",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7040,
            "upload_time": "2025-10-28T00:37:34",
            "upload_time_iso_8601": "2025-10-28T00:37:34.750276Z",
            "url": "https://files.pythonhosted.org/packages/ee/19/16cfee5442c75292a6f143da906ebf24dd873dc8e647007c4e71f66c9736/gpt5_codex_cli-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2afbd735782562cd0b2da0c6011aa8705e9efee1b0cdee33069c25b4b6cbf118",
                "md5": "b4704fc2f2cacc8fac5a9b14c3483eb2",
                "sha256": "cbefdfae02420ea789a3746d2b87f5c1df07b9d0bfc15fb1d395e08340c04625"
            },
            "downloads": -1,
            "filename": "gpt5_codex_cli-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b4704fc2f2cacc8fac5a9b14c3483eb2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 7063,
            "upload_time": "2025-10-28T00:37:35",
            "upload_time_iso_8601": "2025-10-28T00:37:35.676052Z",
            "url": "https://files.pythonhosted.org/packages/2a/fb/d735782562cd0b2da0c6011aa8705e9efee1b0cdee33069c25b4b6cbf118/gpt5_codex_cli-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-28 00:37:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PDFSage",
    "github_project": "openai_cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "gpt5-codex-cli"
}
        
Elapsed time: 1.27119s