Codex客户端SDK

codex客户端

Repo首个SDK用于Codex应用服务器协议。

此存储库包含Codex应用服务器协议的Python和TypeScript绑定，以及定义共享线路模型的模式和设计说明。目标是使将Codex嵌入主机应用程序变得切实可行，而无需自己重建JSON-RPC传输、类型化方法表面和运行时编排。

什么是Codex应用服务器？

codex app-server 将Codex作为本地双向JSON-RPC服务运行。主机连接到它，执行 initialize，发送 initialized，启动或恢复线程，启动循环，然后使用流式通知和服务器发起的输出、计划、批准、工具输入和完成请求。

此存储库是围绕该协议组织的：

• schema/ 定义导线格式
• DESIGN.md 定义共享生命周期和分层规则
• python/ 行为参考约束
• typescript/ 在TypeScript中实现了相同的三层模型

高级体系结构

Your App
  |
  v
codex-client/python or codex-client/typescript
  |
  +-- Session Runtime
  |     Session -> Thread -> Turn
  |     ApprovalPolicy hooks
  |
  +-- Typed Protocol Client
  |     TypedCodexClient
  |     Generated request/response wrappers
  |
  +-- Protocol Core
  |     StdioTransport
  |     ProtocolConnection
  |     JsonRpcCodec
  |
  v
codex app-server
  |
  v
Codex

此仓库中的支持工件：

• schema/ 是应用程序服务器API表面的真相来源
• python/scripts/generate_protocol_client.py 和 typescript/scripts/generate-protocol-client.mjs 生成签入类型化协议表面
• DESIGN.md 是共享的跨语言设计参考

仓库的规划

• python/ 包含Python包、示例、测试和生成脚本
• typescript/ 包含TypeScript包、示例、测试和生成脚本
• schema/ 包含两个绑定所使用的Codex应用服务器JSON模式
• DESIGN.md 记录共享协议生命周期、对象模型和SDK分层

README地图

• python/README.md：完整的Python SDK指南、示例和开发命令
• python/examples/README.md：Python示例进度
• typescript/README.md：完整的TypeScript SDK指南、示例和开发命令
• typescript/examples/README.md：TypeScript示例进度
• DESIGN.md：跨语言协议和架构参考

支持级别

• Python是此存储库中的行为引用绑定
• TypeScript现在实现了所有三层：协议核心、类型化客户端和会话运行时
• 这两个绑定都包括live codex app-server 综合烟雾测试

入门指南

如果你想直接使用SDK：

• 从...开始 python/README.md 对于Python绑定
• 从...开始 typescript/README.md 对于TypeScript绑定

如果你想先了解共享协议和架构规则，请阅读 DESIGN.md.