# @agent-proxy/plugin-api 中文文档

规范地址：https://npmcn.com/package/%40agent-proxy/plugin-api/

版本：0\.21\.0
npm 元数据更新时间：2026-11-06T09:20:20.146Z
中文译文更新时间：2026-11-06T18:54:00.432Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40agent-proxy/plugin-api
原文对照：https://npmcn.com/package/%40agent-proxy/plugin-api/?lang=original
项目主页：https://github.com/aceHubert/codex-cliproxy-gateway#readme
源码仓库：https://github.com/aceHubert/codex-cliproxy-gateway

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：30.3 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-11T10:48:47.338Z
- 最新版本发布：2026-11-06T09:20:19.778Z
- 近 30 天下载量：2449（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

Agent Proxy 插件与主机公共契约。

## 安装

```sh
npm install @agent-proxy/plugin-api
```

也可以使用：`pnpm add @agent-proxy/plugin-api`、`yarn add @agent-proxy/plugin-api`、`bun add @agent-proxy/plugin-api`

## README

# @agent-proxy/plugin-api

[![Deploy](https://github.com/aceHubert/codex-cliproxy-gateway/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/aceHubert/codex-cliproxy-gateway/actions/workflows/deploy.yml) [![npm 版本](https://img.shields.io/npm/v/@agent-proxy/plugin-api)](https://www.npmjs.com/package/@agent-proxy/plugin-api)

Agent Proxy 网关与插件共享的 TypeScript 契约和运行基础库。 提供 `GatewayPlugin`、`HostServices`、请求上下文与模型目录类型， 以及 `PluginRegistry` 的模型归属、请求分派和生命周期调度。

## 安装

```sh
bun add @agent-proxy/plugin-api
```

编写插件时，由宿主注入 `HostServices`，提供配置、网络、目录及日志服务。 在 [@agent-proxy/gateway](https://www.npmjs.com/package/@agent-proxy/gateway) 中显式装配插件；使用网关 CLI 请安装网关包。

[项目源码与文档](https://github.com/aceHubert/codex-cliproxy-gateway)

## 常见问题

### @agent-proxy/plugin-api 是什么？

Agent Proxy 插件与主机公共契约。

### 如何安装 @agent-proxy/plugin-api？

在项目目录运行 npm install @agent-proxy/plugin-api，或使用 pnpm add / yarn add / bun add。

### @agent-proxy/plugin-api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @agent-proxy/plugin-api 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @agent-proxy/plugin-api 可以商用吗？

@agent-proxy/plugin-api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @agent-proxy/plugin-api 的下载量有多少？

根据 npm 官方下载统计，@agent-proxy/plugin-api 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,449 次，日均约 82 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @agent-proxy/plugin-api 还在维护吗？

最新版本 0\.21\.0 发布于 2026/11/06（1 天前）；至今共发布 18 个版本，其中过去 12 个月发布了 18 个；首次发布于 2026/10/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。