From 701b6736ff5b7e54f6071ba45dd7a8631f514118 Mon Sep 17 00:00:00 2001 From: Uladzimir Yancharuk Date: Thu, 17 Apr 2025 20:44:02 +0200 Subject: [PATCH] docs: add tracing instructions to README (#257) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **What**? Add a `Tracing / Verbose Logging` section to the README **Why**? Enable easier troubleshooting by logging full API requests, responses, and prompt details used during code generation. **How**? Inserted the new section between `Non‑interactive / CI mode` and `FAQ`. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index ab6cf3a7..abb505a1 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,14 @@ Run Codex head‑less in pipelines. Example GitHub Action step: Set `CODEX_QUIET_MODE=1` to silence interactive UI noise. +## Tracing / Verbose Logging + +Setting the environment variable `DEBUG=true` prints full API request and response details: + +```shell +DEBUG=true codex +``` + --- ## Recipes