chore: subject docs/*.md to Prettier checks (#4645)

Apparently we were not running our `pnpm run prettier` check in CI, so
many files that were covered by the existing Prettier check were not
well-formatted.

This updates CI and formats the files.

Author: bolinfest

.github/workflows/issue-deduplicator.yml

@@ -60,7 +60,7 @@ jobs:
             - When unsure, prefer returning fewer matches.
             - Include at most five numbers.
 
-          output_schema: | 
+          output_schema: |
             {
               "type": "object",
               "properties": {

.github/workflows/issue-labeler.yml

@@ -43,17 +43,17 @@ jobs:
             10. model-behavior — Undesirable LLM behavior: forgetting goals, refusing work, hallucinating environment details, quota misreports, or other reasoning/performance anomalies.
 
             Issue number: ${{ github.event.issue.number }}
-            
+
             Issue title:
             ${{ github.event.issue.title }}
-            
+
             Issue body:
             ${{ github.event.issue.body }}
-            
+
             Repository full name:
             ${{ github.repository }}
 
-          output_schema: | 
+          output_schema: |
             {
               "type": "object",
               "properties": {

AGENTS.md

@@ -14,9 +14,10 @@ In the codex-rs folder where the rust code lives:
 - When writing tests, prefer comparing the equality of entire objects over fields one by one.
 
 Run `just fmt` (in `codex-rs` directory) automatically after making Rust code changes; do not ask for approval to run it. Before finalizing a change to `codex-rs`, run `just fix -p <project>` (in `codex-rs` directory) to fix any linter issues in the code. Prefer scoping with `-p` to avoid slow workspace‑wide Clippy builds; only run `just fix` without `-p` if you changed shared crates. Additionally, run the tests:
+
 1. Run the test for the specific project that was changed. For example, if changes were made in `codex-rs/tui`, run `cargo test -p codex-tui`.
 2. Once those pass, if any changes were made in common, core, or protocol, run the complete test suite with `cargo test --all-features`.
-When running interactively, ask the user before running `just fix` to finalize. `just fmt` does not require approval. project-specific or individual tests can be run without asking the user, but do ask the user before running the complete test suite.
+   When running interactively, ask the user before running `just fix` to finalize. `just fmt` does not require approval. project-specific or individual tests can be run without asking the user, but do ask the user before running the complete test suite.
 
 ## TUI style conventions
 
@@ -32,6 +33,7 @@ See `codex-rs/tui/styles.md`.
     - Desired: vec!["  └ ".into(), "M".red(), " ".dim(), "tui/src/app.rs".dim()]
 
 ### TUI Styling (ratatui)
+
 - Prefer Stylize helpers: use "text".dim(), .bold(), .cyan(), .italic(), .underlined() instead of manual Style where possible.
 - Prefer simple conversions: use "text".into() for spans and vec![…].into() for lines; when inference is ambiguous (e.g., Paragraph::new/Cell::from), use Line::from(spans) or Span::from(text).
 - Computed styles: if the Style is computed at runtime, using `Span::styled` is OK (`Span::from(text).set_style(style)` is also acceptable).
@@ -43,6 +45,7 @@ See `codex-rs/tui/styles.md`.
 - Compactness: prefer the form that stays on one line after rustfmt; if only one of Line::from(vec![…]) or vec![…].into() avoids wrapping, choose that. If both wrap, pick the one with fewer wrapped lines.
 
 ### Text wrapping
+
 - Always use textwrap::wrap to wrap plain strings.
 - If you have a ratatui Line and you want to wrap it, use the helpers in tui/src/wrapping.rs, e.g. word_wrap_lines / word_wrap_line.
 - If you need to indent wrapped lines, use the initial_indent / subsequent_indent options from RtOptions if you can, rather than writing custom logic.
@@ -64,6 +67,7 @@ This repo uses snapshot tests (via `insta`), especially in `codex-rs/tui`, to va
   - `cargo insta accept -p codex-tui`
 
 If you don’t have the tool:
+
 - `cargo install cargo-insta`
 
 ### Test assertions

README.md

@@ -1,4 +1,3 @@
-
 <p align="center"><code>npm i -g @openai/codex</code><br />or <code>brew install codex</code></p>
 
 <p align="center"><strong>Codex CLI</strong> is a coding agent from OpenAI that runs locally on your computer.
@@ -64,7 +63,6 @@ You can also use Codex with an API key, but this requires [additional setup](./d
 
 Codex CLI supports [MCP servers](./docs/advanced.md#model-context-protocol-mcp). Enable by adding an `mcp_servers` section to your `~/.codex/config.toml`.
 
-
 ### Configuration
 
 Codex CLI supports a rich set of configuration options, with preferences stored in `~/.codex/config.toml`. For full configuration options, see [Configuration](./docs/config.md).

docs/CLA.md

@@ -10,18 +10,21 @@ past and future “Contributions” submitted to the **OpenAI Codex CLI projec
 ---
 
 ## 1. Definitions
+
 - **“Contribution”** – any original work of authorship submitted to the Project
   (code, documentation, designs, etc.).
 - **“You” / “Your”** – the individual (or legal entity) posting the acceptance
   comment.
 
-## 2. Copyright License  
+## 2. Copyright License
+
 You grant **OpenAI, Inc.** and all recipients of software distributed by the
 Project a perpetual, worldwide, non‑exclusive, royalty‑free, irrevocable
 license to reproduce, prepare derivative works of, publicly display, publicly
 perform, sublicense, and distribute Your Contributions and derivative works.
 
-## 3. Patent License  
+## 3. Patent License
+
 You grant **OpenAI, Inc.** and all recipients of the Project a perpetual,
 worldwide, non‑exclusive, royalty‑free, irrevocable (except as below) patent
 license to make, have made, use, sell, offer to sell, import, and otherwise
@@ -32,13 +35,15 @@ Contribution infringes a patent, the patent licenses granted by You to that
 entity under this CLA terminate.
 
 ## 4. Representations
-1. You are legally entitled to grant the licenses above.  
+
+1. You are legally entitled to grant the licenses above.
 2. Each Contribution is either Your original creation or You have authority to
-   submit it under this CLA.  
-3. Your Contributions are provided **“AS IS”** without warranties of any kind.  
+   submit it under this CLA.
+3. Your Contributions are provided **“AS IS”** without warranties of any kind.
 4. You will notify the Project if any statement above becomes inaccurate.
 
-## 5. Miscellany  
+## 5. Miscellany
+
 This Agreement is governed by the laws of the **State of California**, USA,
 excluding its conflict‑of‑laws rules. If any provision is held unenforceable,
 the remaining provisions remain in force.

docs/advanced.md

@@ -31,35 +31,38 @@ env = { "API_KEY" = "value" }
 The Codex CLI can also be run as an MCP _server_ via `codex mcp-server`. For example, you can use `codex mcp-server` to make Codex available as a tool inside of a multi-agent framework like the OpenAI [Agents SDK](https://platform.openai.com/docs/guides/agents). Use `codex mcp` separately to add/list/get/remove MCP server launchers in your configuration.
 
 ### Codex MCP Server Quickstart
+
 You can launch a Codex MCP server with the [Model Context Protocol Inspector](https://modelcontextprotocol.io/legacy/tools/inspector):
 
-``` bash
+```bash
 npx @modelcontextprotocol/inspector codex mcp-server
 ```
+
 Send a `tools/list` request and you will see that there are two tools available:
 
 **`codex`** - Run a Codex session. Accepts configuration parameters matching the Codex Config struct. The `codex` tool takes the following properties:
 
-Property           | Type     | Description
--------------------|----------|----------------------------------------------------------------------------------------------------------
-**`prompt`** (required)             | string   | The initial user prompt to start the Codex conversation.
-`approval-policy`    | string   | Approval policy for shell commands generated by the model: `untrusted`, `on-failure`, `never`.
-`base-instructions`  | string   | The set of instructions to use instead of the default ones.
-`config`             | object   | Individual [config settings](https://github.com/openai/codex/blob/main/docs/config.md#config) that will override what is in `$CODEX_HOME/config.toml`.
-`cwd`                | string   | Working directory for the session. If relative, resolved against the server process's current directory.
-`include-plan-tool`  | boolean  | Whether to include the plan tool in the conversation.
-`model`             | string   | Optional override for the model name (e.g. `o3`, `o4-mini`).
-`profile`            | string   | Configuration profile from `config.toml` to specify default options.
-`sandbox`           | string   | Sandbox mode: `read-only`, `workspace-write`, or `danger-full-access`.
+| Property                | Type    | Description                                                                                                                                            |
+| ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`prompt`** (required) | string  | The initial user prompt to start the Codex conversation.                                                                                               |
+| `approval-policy`       | string  | Approval policy for shell commands generated by the model: `untrusted`, `on-failure`, `never`.                                                         |
+| `base-instructions`     | string  | The set of instructions to use instead of the default ones.                                                                                            |
+| `config`                | object  | Individual [config settings](https://github.com/openai/codex/blob/main/docs/config.md#config) that will override what is in `$CODEX_HOME/config.toml`. |
+| `cwd`                   | string  | Working directory for the session. If relative, resolved against the server process's current directory.                                               |
+| `include-plan-tool`     | boolean | Whether to include the plan tool in the conversation.                                                                                                  |
+| `model`                 | string  | Optional override for the model name (e.g. `o3`, `o4-mini`).                                                                                           |
+| `profile`               | string  | Configuration profile from `config.toml` to specify default options.                                                                                   |
+| `sandbox`               | string  | Sandbox mode: `read-only`, `workspace-write`, or `danger-full-access`.                                                                                 |
 
 **`codex-reply`** - Continue a Codex session by providing the conversation id and prompt. The `codex-reply` tool takes the following properties:
 
-Property   | Type   | Description
------------|--------|---------------------------------------------------------------
-**`prompt`** (required)     | string | The next user prompt to continue the Codex conversation.
-**`conversationId`** (required)  | string | The id of the conversation to continue.
+| Property                        | Type   | Description                                              |
+| ------------------------------- | ------ | -------------------------------------------------------- |
+| **`prompt`** (required)         | string | The next user prompt to continue the Codex conversation. |
+| **`conversationId`** (required) | string | The id of the conversation to continue.                  |
 
 ### Trying it Out
+
 > [!TIP]
 > Codex often takes a few minutes to run. To accommodate this, adjust the MCP inspector's Request and Total timeouts to 600000ms (10 minutes) under ⛭ Configuration.
 

docs/authentication.md

@@ -65,4 +65,4 @@ If you run Codex on a remote machine (VPS/server) without a local browser, the l
 ssh -L 1455:localhost:1455 <user>@<remote-host>
 ```
 
-Then, in that SSH session, run `codex` and select "Sign in with ChatGPT". When prompted, open the printed URL (it will be `http://localhost:1455/...`) in your local browser. The traffic will be tunneled to the remote server. 
+Then, in that SSH session, run `codex` and select "Sign in with ChatGPT". When prompted, open the printed URL (it will be `http://localhost:1455/...`) in your local browser. The traffic will be tunneled to the remote server.