Coding Agent API 参考

本页是 @vetta/coding-agent 的导出地图。具体类型、参数和返回值以安装版本的声明文件为准；示例应只从 package.json#exports 中列出的入口导入，不要深度导入 src/**。

导出路径

Session 生命周期

推荐顺序是：

create → inspect diagnostics → subscribe → prompt / steer / followUp
      → abort or complete → unsubscribe → close

• 创建阶段处理 diagnostics，不要静默吞掉资源或扩展加载失败。
• subscribe() 返回的取消函数必须在宿主销毁时调用。
• abort() 只中止当前执行，不替代 close()。
• 文件存储 Session 必须明确创建、恢复或内存语义；多个活动 Session 不得写同一会话文件。
• 宿主应保留 Agent、turn、message、tool、compaction、retry 和终止事件的语义。

完整的最小示例见 使用 Coding Agent SDK。

集成边界

兼容策略

1. 在 package.json 中固定兼容的 @vetta/coding-agent 版本范围。
2. 启动时记录版本和 diagnostics，遇到未知能力时提供降级或清晰错误。
3. RPC 宿主按响应和事件分别路由，并处理无 id 的事件。
4. 取消、重试、压缩、工具失败和进程退出都要映射到上层状态。
5. 只有公开导出、类型定义和文档明确承诺的字段才可作为集成合同。