# @framers/agentos-ext-domain-porkbun 中文文档

规范地址：https://npmcn.com/package/%40framers/agentos-ext-domain-porkbun/

版本：0\.1\.5
npm 元数据更新时间：2026-11-11T07:56:46.210Z
中文译文更新时间：2026-11-15T12:40:23.994Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40framers/agentos-ext-domain-porkbun
原文对照：https://npmcn.com/package/%40framers/agentos-ext-domain-porkbun/?lang=original
项目主页：https://github.com/framerslab/agentos-extensions/tree/master/registry/curated/domains/porkbun#readme
源码仓库：https://github.com/framerslab/agentos-extensions

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

- 包体积（解压后）：87.6 kB，36 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- peer 依赖：@framers/agentos \>=0\.10\.40
- 首次发布：2026-05-02T11:35:03.879Z
- 最新版本发布：2026-11-11T07:56:45.708Z
- 近 30 天下载量：20016（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

Porkbun域注册员扩展——通过Porkbun API v3搜索,注册和管理域和DNS记录.

## 安装

```sh
npm install @framers/agentos-ext-domain-porkbun
```

也可以使用：`pnpm add @framers/agentos-ext-domain-porkbun`、`yarn add @framers/agentos-ext-domain-porkbun`、`bun add @framers/agentos-ext-domain-porkbun`

## README

# 猪群域登记员

这个包通过"猪笼草"(Porkbun REST API)提供了代理域的可用性检查,购买,账户列表,DNS管理和转账.

## 安装

```bash
npm install @framers/agentos-ext-domain-porkbun
```

同伴依赖 : `@framers/agentos` `>=0.10.40`。 。 。 .

## 使用量

```ts
import { AgentOS } from '@framers/agentos';

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [
      {
        package: '@framers/agentos-ext-domain-porkbun',
        options: {
          apiKey: process.env.PORKBUN_API_KEY,
          secretApiKey: process.env.PORKBUN_SECRET_API_KEY,
        },
      },
    ],
  },
});
```

## 配置

| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
| --- | --- | --- | --- | --- |
| `apiKey` | `porkbun.apiKey` | `PORKBUN_API_KEY` | 对 | 空字符串 |
| `secretApiKey` | `porkbun.secretApiKey` | `PORKBUN_SECRET_API_KEY` | 对 | 空字符串 |
| `secrets` |  |  | 没有 | A. 背景情况 `secrets`,则 `{}` |
| `baseUrl` (仅服务建筑师) |  |  | 没有 | `https://api.porkbun.com/api/json/v3` |

从选项中确定身份,然后是选定的秘密地图,然后是环境变量。 工厂没有通过 `baseUrl` 服务.

## 工具

| 工具 | 它会做什么 |
| --- | --- |
| `porkbunSearchDomain` | 检查域可用性并检索定价. |
| `porkbunRegisterDomain` | 使用已提供的联系人或账户默认来购买域 . |
| `porkbunListDomains` | 列出日期,状态,锁定,隐私和更新设置的账户域. |
| `porkbunConfigureDns` | 添加,删除,列出或更新 DNS 记录. |
| `porkbunTransferDomain` | 使用授权代码启动向宝克本的转移 . |

### `porkbunSearchDomain`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 要检查的域名( 如"example.com","coolsite.dev") |

### `porkbunRegisterDomain`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 要注册的域名( 如"example.com") |
| `years` | 编号 | 没有 | 注册年数( 默认:1, 最多: 10) |
| `firstName` | 字符串 | 没有 | 注册名( 如果省略则使用账户默认) |
| `lastName` | 字符串 | 没有 | 注册名( 如果省略则使用账户默认) |
| `email` | 字符串 | 没有 | Registrant 电子邮件( 如果省略则使用账户默认) |
| `phone` | 字符串 | 没有 | Registrant 电话号码( 如果省略则使用账户默认) |
| `city` | 字符串 | 没有 | 注册城市( 如果省略则使用账户默认) |
| `state` | 字符串 | 没有 | Registrant 状态/ 省( 如果省/ 省使用账户默认) |
| `zip` | 字符串 | 没有 | Registrant 邮政编码( 如果省略则使用账户默认) |
| `country` | 字符串 | 没有 | Registrant country 代码, 如 “ US ” ( 如果省略则使用账户默认) |
| `organization` | 字符串 | 没有 | 登记组织(可选) |
| `address` | 字符串 | 没有 | Registrant 街道地址( 如果省略则使用账户默认) |

### `porkbunListDomains`

输入方案没有参数.

### `porkbunConfigureDns`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 域名 (如"example.com") |
| `action` | 字符串, enum : `add`, (中文(简体) ), `remove`, (中文(简体) ), `list`, (中文(简体) ), `update` | 没有 | 要执行的行动( 默认: 列表) |
| `recordId` | 字符串 | 没有 | DNS 记录ID( 需要删除和更新动作) |
| `type` | 字符串, enum : `A`, (中文(简体) ), `AAAA`, (中文(简体) ), `CNAME`, (中文(简体) ), `TXT`, (中文(简体) ), `MX`, (中文(简体) ), `NS`, (中文(简体) ), `SRV`, (中文(简体) ), `TLSA`, (中文(简体) ), `CAA`, (中文(简体) ), `ALIAS` | 没有 | DNS 记录类型( 需要添加动作) |
| `name` | 字符串 | 没有 | 子域名或记录名(如"www","mail"). 空字符串或为根域省略. |
| `content` | 字符串 | 没有 | 记录值/内容(如IP地址,主机名,TXT值) |
| `ttl` | 字符串 | 没有 | 以秒计活的时间( 默认为" 300" ) |
| `prio` | 字符串 | 没有 | 优先权(MX记录需要,其他人可以选择) |

### `porkbunTransferDomain`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 要传输的域名( 如"example.com") |
| `authCode` | 字符串 | 对 | 现任登记员的授权/EPP代码(授权转让的必要条件) |

## 页:1

激活拒绝缺失的证书,并通过API ping端点认证. API 密钥来自 `https://porkbun.com/account/api`。请求使用 POST 与 `apikey` 财务报告和审定财务报表 `secretapikey` 在体内.

登记向档案上的支付方法收费。 联系字段在省略时使用账户默认值 。 传输提交域和授权代码;工具描述要求域由上任登记员解锁.

DNS更改创建,编辑或删除记录. 需要增加 `type` 财务报告和审定财务报表 `content`; 需要删除和更新 `recordId`。更新后检索记录并返回匹配记录,或者在找不到匹配时返回完整列表。 定价的检查失败使定价没有结果。 工具失败返回 `success: false` 还有一个 `error` 留言.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @framers/agentos-ext-domain-porkbun 是什么？

Porkbun域注册员扩展——通过Porkbun API v3搜索,注册和管理域和DNS记录\.

### 如何安装 @framers/agentos-ext-domain-porkbun？

在项目目录运行 npm install @framers/agentos-ext-domain-porkbun，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@framers/agentos（\>=0\.10\.40）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @framers/agentos-ext-domain-porkbun 支持 TypeScript 吗？

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

### @framers/agentos-ext-domain-porkbun 支持 ESM 还是 CommonJS？

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

### @framers/agentos-ext-domain-porkbun 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @framers/agentos-ext-domain-porkbun 可以商用吗？

@framers/agentos-ext-domain-porkbun 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @framers/agentos-ext-domain-porkbun 的下载量有多少？

根据 npm 官方下载统计，@framers/agentos-ext-domain-porkbun 在 2026/10/16 – 2026/11/14 这 30 天内被下载 20,016 次，日均约 667 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @framers/agentos-ext-domain-porkbun 还在维护吗？

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