python-codex 0.0.1__tar.gz → 0.1.0__tar.gz

{python_codex-0.0.1 → python_codex-0.1.0}/.github/workflows/publish.yml

@@ -48,7 +48,7 @@ jobs:
       id-token: write
     environment:
       name: testpypi
-      url: https://test.pypi.org/p/python-codex
+      url: https://test.pypi.org/project/pycodex/
     steps:
       - name: Download distributions
         uses: actions/download-artifact@v4
@@ -69,7 +69,7 @@ jobs:
       id-token: write
     environment:
       name: pypi
-      url: https://pypi.org/p/python-codex
+      url: https://pypi.org/project/pycodex/
     steps:
       - name: Download distributions
         uses: actions/download-artifact@v4

python_codex-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+.pytest_cache/
+__pycache__/
+*.pyc
+.tmp/
+uv.lock

python_codex-0.1.0/AGENTS.md

@@ -0,0 +1,38 @@
+# pycodex AGENTS
+
+## Repo Priors
+
+- 这个仓库的目标是尽可能准确地复现上游 Codex（`https://github.com/openai/codex`），不是发明一个“类似 Codex”的简化替代品；凡是行为差异都应优先朝原版 Codex 收敛。
+- 发布到 PyPI 时，distribution name 用 `python-codex`；代码包目录、`import` 路径和 CLI 命令仍保持 `pycodex`。
+- 包结构直接放在 repo 根目录下的 `pycodex/`，不使用 `src/` layout。
+- Rust 到 Python 的主映射：`submission_loop` -> `pycodex/runtime.py`，`run_turn` / `run_sampling_request` -> `pycodex/agent.py`，`ToolRouter` -> `pycodex/tools/base_tool.py` + `pycodex/tools/`.
+- 会话协议先收敛到 4 类 item：`UserMessage`、`AssistantMessage`、`ToolCall`、`ToolResult`；只有这层稳定后再扩 richer event model。
+- 优先保持主循环可测试、可替换：模型侧通过 `ModelClient` 协议接入；测试专用的 `ScriptedModelClient` 放在 `tests/fakes.py`，不要放进运行时包。
+- `ResponsesModelClient` 直接复用 `~/.codex/config.toml` 的 provider 配置；当前已验证这里的 responses provider 需要 `stream = true`，否则会返回 `400` 和 `Stream must be set to true`。
+- `responses_server` compat 层应透传请求里的 `model`；不要再做 “取 downstream /models 第一个 id 并强制覆盖请求模型” 这种兜底兼容。
+- `responses_server` 的 provider-specific chat payload 定制统一放在 `responses_server/payload_processors.py`：使用 `CompatServerConfig.model_provider` 选择 `provider_name -> proc_fn(outcomming_request)` 映射，并且只在真正发出 downstream `/v1/chat/completions` 前 post-process；`StreamRouter` 内部继续保留 canonical payload，避免 tool hydration / mock web_search follow-up 被 provider 改写污染。
+- `pycodex` 默认是最小交互 CLI；无 prompt 时进入 REPL，并通过 `AgentRuntime` 跑外层提交循环。当前会显示最小事件流、assistant 流式输出、简单 title/history（`/title`, `/history`），并默认注册一组与原版一一对应的本地工具子集。
+- 交互 CLI 的事件流展示优先表达用户可感知的阶段（例如工具开始/完成、模型回看工具结果），不要直接把内部 `iteration` 计数暴露成主要状态文案；`iterations` 应继续保留在 `TurnResult` 等程序化结果里。
+- prompt/context 相关逻辑统一放在 `pycodex/context.py`：`AgentLoop` 只维护真实会话历史；每轮请求前由 `ContextManager` 注入 base instructions、developer message、`AGENTS.md` 指令和 `<environment_context>`，且这些注入项不写回 history。
+- `AgentLoop` 的 turn-loop 语义要跟上游 `codex-rs/core/src/codex.rs` 一致：按 follow-up / tool handoff 自然收敛，不要加固定 12 轮之类的 hard cap，也不要保留本地专用的 iteration-limit 参数。
+- `README.md` 和 `docs/` 属于对齐工作的一部分：只要实现状态、对齐结论或使用方式发生实质变化，就应及时更新，不要让文档滞后于当前代码。
+- 新工具必须继承 `BaseTool`，然后通过 `ToolRegistry.register(tool_instance)` 接入；不要再给 registry 传散装 name/description/handler 参数。
+- request/tool schema 对齐应落在实际建模层（`ToolSpec` / `BaseTool` / request builder）本身，不要再引入 prompt 级别的 `serialized_tools` 旁路覆盖。
+- 当前已接入的内置工具子集：`shell`、`shell_command`、`exec_command`、`write_stdin`、`exec`、`wait`、`web_search`、`update_plan`、`request_user_input`、`request_permissions`、`spawn_agent`、`send_input`、`resume_agent`、`wait_agent`、`close_agent`、`apply_patch`、`grep_files`、`read_file`、`list_dir`、`view_image`。后续继续新增时，仍然按原版 Codex 内置工具逐个补齐。
+- `exec_command` / `write_stdin` 的 unified-exec 对齐要注意两层默认截断语义：省略 `max_output_tokens` 时也要按 upstream 默认 `10_000` token 预算裁剪 tool response；同时长时间未轮询的未读输出缓冲不能无限累积，需保留 upstream 同款 `1 MiB` head/tail。
+- 当前协议层已经支持两类原版工具载荷：普通 function tools，以及 `apply_patch` 这类 freeform/custom tools；工具结果也支持结构化 `input_image` content items，用于 `view_image` 这类会把图片喂回模型的工具。
+- 当前本地 runtime 已支持一个最小的 in-process sub-agent 管理层：`spawn_agent` / `send_input` / `resume_agent` / `wait_agent` / `close_agent` 通过共享的 `SubAgentManager` 驱动新的 `AgentRuntime` 实例，不依赖 CLI harness 自带的多 agent 基础设施。
+- 当前交互工具 `request_user_input` / `request_permissions` 已接到 `pycodex` 交互 CLI：它们会在一次 turn 内直接复用同一个 stdin/input_fn 向用户提问，因此只有交互模式下有完整体验；非交互调用默认会返回取消/不可用类错误。
+- `request_user_input` 对齐上游时要注意两层：Default mode 默认返回固定错误 `request_user_input is unavailable in Default mode`；Plan mode happy path 则要求每个问题都有非空 `options`、handler 会补 `isOther=true`，并把结构化答案序列化成 JSON 字符串加 `success=true` 塞回 `function_call_output`。
+- 在 `/data/pycodex` 本机已安装的 `codex-cli 0.115.0` 上，用 `tests/compare_request_user_input_roundtrip.py` 做 Plan-mode deterministic proxy live capture 时，upstream 的 second request `function_call_output` 当前不带 `success`；而 GitHub `openai/codex` `main` 源码里的 `FunctionCallOutputPayload` / `request_user_input` handler 支持传递 `success`。写对齐结论时要明确区分“installed CLI live capture”与“upstream main 源码建模”。
+- 当前 `exec` / `wait` 已有一个最小 code-mode 实现：底层通过 Node 子进程运行 JavaScript，自带 `text` / `image` / `store` / `load` / `exit` / `notify` / `yield_control` helper，并允许通过 `tools.<name>(...)` 调回本地已注册工具；`web_search` 当前作为 Responses API provider-native tool declaration 暴露给模型，不经过本地 ToolRegistry 执行。
+- 我们支持的 tools 必须和原版 Codex 内置 tools 一一对应：名称、定位、参数形状、交互模型、输出语义都应尽量对齐；不要混合多个原版工具的语义做一个“折中工具”。
+- 代码风格上不要使用 `*` 定义 keyword-only 参数；接口默认允许位置参数。
+- 本仓库使用 `uv`；本地默认没有预装测试依赖，开始工作前先跑 `uv sync --dev`，验证用 `uv run pytest`。
+- 上游 Codex 的 `steer` 目前是 TUI 交互层能力：开启后 `Enter` 会立即提交，`Tab` 才是排队。对齐时优先盯“下一次发出去的请求体”而不是内部控制流；当前 `pycodex` 已把 steer/queue 语义下沉到 `AgentRuntime`，并让 `AgentLoop.run_turn(texts)` 一次接收一批 user texts，这样下一次请求的 `input` 可以把多个 steer 文本按顺序并到 history 尾部。`CliSessionView.handle_event()` 把 spinner 再次拉起。要保证输入不被遮挡，需要让 view 知道“当前正在输入”，并在 input-active 期间抑制这些事件对 spinner 的 resume。
+- steer 的最小交互反馈已经约定为两条显式状态文案：入队时打印 `[steer] queued: <prompt>`，该条 queued turn 真正开始执行时打印 `[steer] inserted: <prompt>`。后续如果补更复杂的 queue UI，也应保留这两个核心状态语义。
+- 在当前 `pycodex` CLI 里，普通输入与 `/queue <message>` 只负责选择 runtime queue；真正的 steer/queue 差别由 `AgentRuntime.enqueue_user_turn(..., queue=...)` 决定。runtime 内部也应保持成两个同构 queue，而不是一个普通 queue 再叠一个 steer 专用旁路状态机。
+- 对上游 steer 语义要非常谨慎：正常 active-turn steer 首先走的是 `inject_input(...)` + `pending_input`，不是立刻 `spawn_task(...)` / `TurnAbortReason::Replaced`。更准确的理解是“在最近一次 sampling 边界插入”，而不是“任意时刻硬打断当前模型/工具调用”。
+- 用 `tests/fake_responses_server.py` 做 steer 时序对比时，不要把 proxy capture 文件的生成时刻当成“请求已到达 upstream”的信号；`build_proxy_handler(...)` 会等整条 upstream response 读完后才 `write_capture(...)`。如果要在第一条 request 仍未完成时注入 steer，应该同步等待 fake origin 自己收到第 1 条 POST。
+- 在本机做 steer fake-server 对比时，不要把用户本地 `config.toml` 里的 `service_tier` / fast-mode 设置混进“默认 steer”结论。`tests/compare_steer_request_bodies.py` 现在会给 upstream 和 `pycodex` 都生成临时 config，并去掉顶层 `service_tier` 后再比较 request body。
+- `x-codex-turn-metadata.workspaces` 的时机不是“整个 session 只发第一条请求”。当前对齐结论是：首个 turn 的后续 steer/follow-up request 也继续带 `workspaces`；切到后续新 turn 才省略。

python_codex-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 OpenAI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

python_codex-0.1.0/PKG-INFO

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: python-codex
+Version: 0.1.0
+Summary: A minimal Python extraction of Codex's main agent loop
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: debugpy>=1.8.20
+Requires-Dist: fastapi>=0.115
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: prompt-toolkit>=3.0
+Requires-Dist: requests>=2.31
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Requires-Dist: uvicorn>=0.32
+Description-Content-Type: text/markdown
+
+# pycodex
+
+PyPI distribution name: `python-codex`  
+Import path and CLI command remain `pycodex`.
+
+这个仓库把上游 Codex（`https://github.com/openai/codex`）里最核心的 agent
+闭环先抽成一个尽量小的 Python 版本，重点保留两层结构：
+
+- `submission_loop`：顺序消费提交的操作。
+- `run_turn`：在单个 turn 内持续执行 `模型采样 -> 工具调用 -> 把工具结果喂回模型`，直到拿到最终回答。
+
+对应的 Rust 参考点：
+
+- `codex-rs/core/src/codex.rs` 里的 `submission_loop`
+- `codex-rs/core/src/codex.rs` 里的 `run_turn`
+- `codex-rs/core/src/codex.rs` 里的 `run_sampling_request`
+- `codex-rs/core/src/tools/router.rs` 里的 `ToolRouter`
+- `codex-rs/core/src/stream_events_utils.rs` 里的 `handle_output_item_done`
+
+## 快速开始
+
+先安装开发依赖：
+
+```bash
+uv sync
+```
+
+试一下真实入口：
+
+```bash
+uv run pycodex "Reply with exactly OK."
+uv run pycodex
+```
+
+## 设计取舍
+
+这里不是对 Rust 版本做 1:1 移植，而是先收敛到一个最小可复用内核：
+
+1. 用一个很薄的 `ModelClient` 协议抽象模型侧。
+2. 用 `ToolRegistry` 管理工具规格和执行器。
+3. 用 `AgentLoop` 实现核心闭环。
+4. 用 `AgentRuntime` 保留外层提交队列，方便以后继续对齐 Rust 的 `submission_loop`。
+
+暂时刻意不包含：
+
+- TUI / 流式增量渲染
+- MCP / connectors / sandbox / approvals
+- memory / compact / hooks / review mode
+- 真实 OpenAI 适配器
+
+这些都可以后续继续往上叠，但当前项目先把最核心的“工具增强推理主循环”钉住。
+
+## 目录
+
+- `pycodex/protocol.py`：最小的会话 item / prompt / event 协议
+- `pycodex/model.py`：模型客户端协议和 Responses API 适配器
+- `pycodex/cli.py`：`pycodex` 单轮命令行入口
+- `pycodex/tools/base_tool.py`：`BaseTool`、`ToolRegistry`、`ToolContext`
+- `pycodex/tools/`：具体工具实现
+- `pycodex/agent.py`：主循环
+- `pycodex/runtime.py`：外层提交队列
+- `tests/test_agent.py`：核心行为测试
+
+## 当前对齐状态
+
+当前进度可以分成两层看：
+
+- prompt/context 对齐：
+  - 非交互 `exec` 路径下，`instructions` 和 `input` 已经对齐到上游 Codex；
+  - 这一层现在主要由 `pycodex/context.py` 和 vendored prompt data 负责。
+- turn-loop 语义对齐：
+  - `AgentLoop` 默认不再使用固定 12 轮上限；
+  - 现在和上游一样，按 “还有没有 follow-up / tool handoff” 自然收敛；
+  - 本地不再保留额外的 iteration-limit 参数。
+- request-level 对齐：
+  - 非交互 `exec` 路径的 request body 已基本对齐；
+  - 默认 CLI 的 non-exec 首轮请求现在也已切到 `codex-tui` + `<collaboration_mode>` 这条上游路径；
+  - 默认 CLI 的两轮主线程对话 request/header 也已补抓并对齐，包括后续 turn 不再携带 `workspaces`；
+  - 当前剩余重点主要转向更外围的行为分支，而不是这条已比较路径上的 request/header。
+- tool round-trip 对齐：
+  - `request_user_input` 的 Default-mode unavailable 路径已按真实 upstream capture 对齐；
+  - Plan-mode happy path 现在也已按 upstream 源码补齐到工具/协议层：会强制 `isOther=true`、要求非空 `options`，并以 JSON 字符串 + `success=true` 回传结构化答案；
+  - 新增了一个基于 `tests/fake_responses_server.py` proxy 模式的 deterministic round-trip compare 脚本 `tests/compare_request_user_input_roundtrip.py`；它在本机已安装的 `codex-cli 0.115.0` 上确认：Plan-mode live capture 里唯一剩余的 `function_call_output` schema 差异是 `pycodex` 多带了 `success=true`。
+
+更细的对齐说明见 `docs/ALIGNMENT.md`。
+
+## 真实模型联调
+
+如果本机已经有 Codex CLI 配置，可直接复用 `~/.codex/config.toml` 里的
+`model`、`model_provider`、`base_url`、`env_key`：
+
+```python
+from pycodex import ResponsesModelClient
+
+client = ResponsesModelClient.from_codex_config()
+```
+
+当前实现走 OpenAI-compatible Responses API 的流式 `/responses` 接口。这个点
+已经用本机 `~/.codex/config.toml` 做过联调验证。
+
+通过 CLI 启动时，`pycodex` 还会在读取配置前加载同目录下的 `.env`
+（通常是 `~/.codex/.env`），方便把 provider key 之类的环境变量放在那里。
+为对齐上游 Codex，`.env` 中以 `CODEX_` 开头的变量不会被导入。
+
+## pycodex
+
+`pycodex` 现在默认是一个最小交互式入口，内部通过 `AgentRuntime` 驱动 turn
+提交循环，默认直接复用 `~/.codex/config.toml`：
+
+```bash
+pycodex
+pycodex "Summarize this repo in one sentence."
+printf 'Reply with exactly OK.' | pycodex
+pycodex --json "Reply with exactly OK."
+pycodex --profile model_proxy "Reply with exactly OK."
+pycodex --vllm-endpoint http://127.0.0.1:18000 "Reply with exactly OK."
+pycodex doctor
+```
+
+当前行为：
+
+- 没有 argv prompt 且 stdin 是 TTY 时，进入交互模式
+- 有 argv prompt 或 stdin 管道输入时，执行单轮请求
+- 交互模式下支持 `/exit` 和 `/quit`
+- 交互模式下会显示简洁阶段事件流，例如工具执行状态和模型回看工具结果
+- assistant 文本会按流式 delta 直接打印
+- 交互模式下支持 `/history`、`/title` 和 `/model`
+- `/model <name>` 会切换当前交互会话后续请求使用的模型；`/model` 会显示当前模型和可选模型
+- 交互模式默认支持 steer：普通输入会走 runtime 的 steer 路径，当前请求会在下一个安全边界尽快停下，后续 steer 文本会按顺序并入下一次模型请求的 `input`；如需明确排队可用 `/queue <message>`，会打印 `[steer] queued: ...`，随后等该 turn 真正开始时再打印 `[steer] inserted: ...`
+- 当前默认注册一组与原版 Codex 一一对应的本地工具子集：`shell`、`shell_command`、`exec_command`、`write_stdin`、`exec`、`wait`、`web_search`、`update_plan`、`request_user_input`、`request_permissions`、`spawn_agent`、`send_input`、`resume_agent`、`wait_agent`、`close_agent`、`apply_patch`、`grep_files`、`read_file`、`list_dir`、`view_image`
+- `--vllm-endpoint http://host:port` 会自动拉起一个本地 `responses_server` compat 层；当 path 为空时会内部补 `/v1`，再把 `/responses` 请求转到下游 `/v1/chat/completions`，并在 provider 侧适配 mock `web_search` 与 custom-tool function wrapper
+- `pycodex doctor` 会检查配置、`.env`、API key、DNS、TCP/TLS，以及可选的 live Responses API 请求
+
+它目前主要用于：
+
+- 验证 provider / model / auth 配置是否可用
+- 调试 `ResponsesModelClient`
+- 做最小单轮 / 多轮 smoke test
+
+`doctor` 示例：
+
+```bash
+pycodex doctor
+pycodex doctor --skip-live
+pycodex doctor --json
+```
+
+## 示例
+
+```python
+import asyncio
+
+from pycodex import (
+    AgentLoop,
+    BaseTool,
+    ContextManager,
+    ResponsesModelClient,
+    ToolRegistry,
+)
+
+
+class EchoTool(BaseTool):
+    name = "echo"
+    description = "Echo the provided text."
+    input_schema = {
+        "type": "object",
+        "properties": {"text": {"type": "string"}},
+        "required": ["text"],
+    }
+
+    async def run(self, context, args):
+        del context
+        return args["text"]
+
+
+async def main() -> None:
+    model = ResponsesModelClient.from_codex_config()
+    context_manager = ContextManager.from_codex_config()
+
+    tools = ToolRegistry()
+    tools.register(EchoTool())
+
+    agent = AgentLoop(model, tools, context_manager)
+    result = await agent.run_turn("Call the echo tool with text=hello, then tell me what it returned.")
+    print(result.output_text)
+
+
+asyncio.run(main())
+```
+
+## 对齐清单
+
+更细的说明见 `docs/ALIGNMENT.md`。这里保留一个高层 checklist，方便直接看当前进度。
+
+### Tools 对齐
+
+上游官方工具：
+
+- [x] `shell` — 执行 argv 形式的 shell 命令。
+- [x] `shell_command` — 执行字符串形式的 shell script。
+- [x] `exec_command` — 启动带 session 的长命令执行。
+- [x] `write_stdin` — 向已有执行 session 写入 stdin 或轮询输出。
+- [x] `web_search` — 暴露 provider-native 的网页搜索能力。
+- [x] `update_plan` — 更新任务计划并维护步骤状态。
+- [x] `request_user_input` — 向用户发起结构化问题并等待回答。
+- [x] `request_permissions` — 请求额外权限再继续执行。
+- [x] `spawn_agent` — 创建并启动子 agent。
+- [x] `send_input` — 给已有子 agent 继续发送输入。
+- [x] `resume_agent` — 恢复已关闭的子 agent。
+- [x] `wait_agent` — 等待子 agent 进入终态。
+- [x] `close_agent` — 关闭不再需要的子 agent。
+- [x] `apply_patch` — 用 freeform patch 精确修改文件。
+- [x] `grep_files` — 按模式搜索文件内容。
+- [x] `read_file` — 读取文件片段并保留行号语义。
+- [x] `list_dir` — 列出目录树片段。
+- [x] `view_image` — 把本地图片转成模型可见输入。
+
+尚未单独建模的上游官方低频 / 特殊模式工具：
+
+- [ ] `wait_infinite` — 长时间阻塞等待外部事件或后续输入。
+- [ ] `spawn_agents_on_csv` — 按 CSV 批量创建子 agent 任务。
+- [ ] `report_agent_job_result` — 上报批处理 agent job 的结果。
+- [ ] `js_repl` — JavaScript REPL / code-mode 主入口。
+- [ ] `js_repl_reset` — 重置 `js_repl` 的运行状态。
+- [ ] `artifacts` — 生成或管理结构化工件输出。
+- [ ] `list_mcp_resources` — 列出 MCP 资源。
+- [ ] `list_mcp_resource_templates` — 列出 MCP 资源模板。
+- [ ] `read_mcp_resource` — 读取 MCP 资源内容。
+- [ ] `multi_tool_use.parallel` — 并行包装多个 developer tools 调用。
+
+本仓库额外兼容层 / 过渡工具：
+
+- [x] `exec` — 当前对 code-mode 的本地近似实现。
+- [x] `wait` — 当前对 code-mode 等待行为的本地近似实现。
+
+### 行为对齐
+
+- [x] `AgentLoop` / `AgentRuntime` 主循环骨架 — turn 闭环和提交队列已成立。
+- [x] 非交互 `exec` 路径的 `instructions` 对齐 — base instructions 已对齐上游。
+- [x] 非交互 `exec` 路径的 `input` 对齐 — prompt input 已对齐上游。
+- [x] developer/contextual-user message 的 shape 对齐 — message/content 结构已对齐。
+- [x] `AGENTS.md` + `<environment_context>` 注入逻辑对齐 — 上下文拼接顺序已对齐。
+- [x] 非交互 `exec` 路径的工具子集对齐 — 暴露给模型的工具集合已收敛。
+- [x] `include = ["reasoning.encrypted_content"]` — reasoning include 字段已对齐。
+- [x] `prompt_cache_key` — 请求级 prompt cache key 已补齐。
+- [x] `x-client-request-id` — 请求 id header 已补齐。
+- [x] `x-codex-turn-metadata` — turn id / sandbox header 已补齐。
+- [x] `originator` — mode-aware originator header 已补齐。
+- [x] `user-agent` 精确字符串对齐 — 非交互 `exec` 路径已对齐上游字符串。
+- [x] exec-mode tool schema 的逐字段对齐 — 当前通过工具层直接复用上游 snapshot。
+- [ ] 交互模式与非 `exec` 路径的完整行为对齐 — non-exec 首轮 context 已切到 `codex-tui` 路径，但 REPL 连续多轮行为还未完全验证。
+- [ ] sandbox / approvals / compact / memory 等外围行为对齐 — 外围系统仍在后续范围。