Skip to content

docs: add ChatGPT sign-in authentication flow and documentation #1015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −2
Open

docs: add ChatGPT sign-in authentication flow and documentation #1015

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,27 @@ Install globally:
npm install -g @openai/codex
```

Next, set your OpenAI API key as an environment variable:
Next, you need an OpenAI API key. You have two options:

### Option 1: Sign in with ChatGPT

If you have a ChatGPT Plus or Pro subscription, you can sign in directly with your ChatGPT account to generate an API key:

```shell
codex
```

When prompted, select "Sign in with ChatGPT" and follow the browser authentication flow. This will:

1. Open your browser to the OpenAI login page
2. After signing in, automatically generate an API key for Codex
3. Store the key securely for future use

> **Note:** ChatGPT Plus and Pro subscribers can receive API credits through this sign-in flow.

### Option 2: Use an existing API key

If you already have an OpenAI API key, you can set it as an environment variable:

```shell
export OPENAI_API_KEY="your-api-key-here"
Expand Down Expand Up @@ -152,7 +172,7 @@ ChatGPT-level reasoning **plus** the power to actually run code, manipulate
files, and iterate - all under version control. In short, it's _chat-driven
development_ that understands and executes your repo.

- **Zero setup** - bring your OpenAI API key and it just works!
- **Zero setup** - sign in with your ChatGPT account or bring your OpenAI API key and it just works!
- **Full auto-approval, while safe + secure** by running network-disabled and directory-sandboxed
- **Multimodal** - pass in screenshots or diagrams to implement features ✨

Expand Down Expand Up @@ -220,6 +240,7 @@ The hardening mechanism Codex uses depends on your OS:
| `codex` | Interactive REPL | `codex` |
| `codex "..."` | Initial prompt for interactive REPL | `codex "fix lint errors"` |
| `codex -q "..."` | Non-interactive "quiet mode" | `codex -q --json "explain utils.ts"` |
| `codex --login` | Force ChatGPT sign-in flow | `codex --login` |
| `codex completion <bash\|zsh\|fish>` | Print shell completion script | `codex completion bash` |

Key flags: `--model/-m`, `--approval-mode/-a`, `--quiet/-q`, and `--notify`.
Expand Down Expand Up @@ -499,6 +520,12 @@ Any model available with [Responses API](https://platform.openai.com/docs/api-re

It's possible that your [API account needs to be verified](https://help.openai.com/en/articles/10910291-api-organization-verification) in order to start streaming responses and seeing chain of thought summaries from the API. If you're still running into issues, please let us know!

</details>
<details>
<summary>How do I sign in with my ChatGPT account?</summary>

Run `codex` and select "Sign in with ChatGPT" when prompted, or use `codex --login` to force the sign-in flow. This will open your browser to authenticate with OpenAI and generate an API key for Codex. ChatGPT Plus and Pro subscribers can receive API credits through this flow. The key is securely stored in `~/.codex/auth.json`.

</details>

<details>
Expand Down