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

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

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

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

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

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

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

## 中文简介

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

## 安装

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

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

## README

# Namecheap 域注册员

此包通过"Namecheap XML API"提供代理域可用性检查,注册,账户上市和DNS主机记录管理.

## 安装

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

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

## 使用量

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

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [
      {
        package: '@framers/agentos-ext-domain-namecheap',
        options: {
          apiUser: process.env.NAMECHEAP_API_USER,
          apiKey: process.env.NAMECHEAP_API_KEY,
          userName: process.env.NAMECHEAP_USERNAME,
          clientIp: process.env.NAMECHEAP_CLIENT_IP,
          useSandbox: process.env.NAMECHEAP_SANDBOX === 'true',
        },
      },
    ],
  },
});
```

## 配置

| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
| --- | --- | --- | --- | --- |
| `apiUser` | `namecheap.apiUser` | `NAMECHEAP_API_USER` | 对 | 空字符串 |
| `apiKey` | `namecheap.apiKey` | `NAMECHEAP_API_KEY` | 对 | 空字符串 |
| `userName` | `namecheap.userName` | `NAMECHEAP_USERNAME` | 没有 | `apiUser` |
| `clientIp` | `namecheap.clientIp` | `NAMECHEAP_CLIENT_IP` | 对 | 空字符串 |
| `useSandbox` |  | `NAMECHEAP_SANDBOX` | 没有 | `false` |
| `secrets` |  |  | 没有 | A. 背景情况 `secrets`,则 `{}` |
| `baseUrl` (仅服务建筑师) |  |  | 没有 | `https://api.namecheap.com/xml.response`,或 `https://api.sandbox.namecheap.com/xml.response` 何时 `useSandbox` 真实 |

从选项中确定身份,然后是选定的秘密地图,然后是环境变量。 沙盒环境变量仅在等同时允许沙盒 `true`工厂没有通过 `baseUrl` 服务.

## 工具

| 工具 | 它会做什么 |
| --- | --- |
| `namecheapSearchDomain` | 检查逗号分隔的域名,以确定可用性和溢价. |
| `namecheapRegisterDomain` | 购买一个有注册联系人, WhoisGuard 和 nameserver 选项的域. |
| `namecheapListDomains` | 列出具有创建,到期,锁定,续签和WhoisGuard状态的账户域. |
| `namecheapConfigureDns` | 设置 DNS 主机记录,替换域的所有已存在的记录. |
| `namecheapGetDnsRecords` | 检索带有值,TTL,MX优先级和活性状态的 DNS 主机记录. |

### `namecheapSearchDomain`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domains` | 字符串 | 对 | 要检查的逗号分隔域列表( 如"example.com,example.net,example.io") |

### `namecheapRegisterDomain`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domainName` | 字符串 | 对 | 要注册的域名( 如"example.com") |
| `years` | 编号 | 没有 | 登记年数(1-10,默认:1) |
| `registrant` | 对象 | 对 | 登记人联系信息: `firstName`, (中文(简体) ), `lastName`, (中文(简体) ), `address1`, (中文(简体) ), `city`, (中文(简体) ), `stateProvince`, (中文(简体) ), `postalCode`, (中文(简体) ), `country`, (中文(简体) ), `phone`, (中文(简体) ), `emailAddress`可选: `organizationName`, (中文(简体) ), `address2`。 。 。 . |
| `registrant.firstName` | 字符串 | 对,在 `registrant` |  |
| `registrant.lastName` | 字符串 | 对,在 `registrant` |  |
| `registrant.address1` | 字符串 | 对,在 `registrant` |  |
| `registrant.city` | 字符串 | 对,在 `registrant` |  |
| `registrant.stateProvince` | 字符串 | 对,在 `registrant` |  |
| `registrant.postalCode` | 字符串 | 对,在 `registrant` |  |
| `registrant.country` | 字符串 | 对,在 `registrant` | `2`\- 字母国家代码(例如“美国”、“GB”) |
| `registrant.phone` | 字符串 | 对,在 `registrant` | 电话为+countryCode格式(如"+1.55555555555") |
| `registrant.emailAddress` | 字符串 | 对,在 `registrant` |  |
| `registrant.organizationName` | 字符串 | 没有 |  |
| `registrant.address2` | 字符串 | 没有 |  |
| `tech` | 对象 | 没有 | 技术联系人(形状与 `registrant`,默认为 `registrant`(中文(简体) ) |
| `admin` | 对象 | 没有 | 管理员联系人( 形状与 `registrant`,默认为 `registrant`(中文(简体) ) |
| `auxBilling` | 对象 | 没有 | AuxBilling 联系人(形状与 `registrant`,默认为 `registrant`(中文(简体) ) |
| `addFreeWhoisguard` | 布尔 | 没有 | 启用 Whois 守护隐私( 默认: true) |
| `wgEnabled` | 布尔 | 没有 | 激活 Whois Guard( 默认: 真) |
| `nameservers` | 字符串 | 没有 | 自定义名称服务器, 逗号分隔( 如果省略则使用 Namecheap 默认) |

### `namecheapListDomains`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `pageSize` | 编号 | 没有 | 每页域数( 默认: 20, 最大: 100) |
| `page` | 编号 | 没有 | 要检索的页码( 默认:1) |

### `namecheapConfigureDns`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 完全合格域名(如"example.com") |
| `records` | 对象数组 | 对 | 要设置的 DNS 记录阵列 。 每个记录需要: `hostName` (例如"@","www"), `recordType` (单位:千美元)`A`, (中文(简体) ), `AAAA`, (中文(简体) ), `CNAME`, (中文(简体) ), `MX`, (中文(简体) ), `TXT`, (中文(简体) ), `URL`, (中文(简体) ), `URL301`, (中文(简体) ), `FRAME`, (中文(简体) ), `address` (数值). 可选 : `mxPref` (默认"10"), `ttl` (默认"1800"). |
| `records[].hostName` | 字符串 | 是的,在每个记录中 | 主机名( 如 root “ @” 、 “ www” 、 “ mail” 、 “ \*” 等通配符) |
| `records[].recordType` | 字符串, enum : `A`, (中文(简体) ), `AAAA`, (中文(简体) ), `CNAME`, (中文(简体) ), `MX`, (中文(简体) ), `TXT`, (中文(简体) ), `URL`, (中文(简体) ), `URL301`, (中文(简体) ), `FRAME` | 是的,在每个记录中 | DNS 记录类型 |
| `records[].address` | 字符串 | 是的,在每个记录中 | 记录值( IP 地址、 主机名或文本内容) |
| `records[].mxPref` | 字符串 | 没有 | MX偏好/ 优先级( 默认 “ 10 ” , 仅针对 MX 记录) |
| `records[].ttl` | 字符串 | 没有 | 以秒计活的时间( 默认" 1800") |

### `namecheapGetDnsRecords`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `domain` | 字符串 | 对 | 完全合格域名(如"example.com") |

## 页:1

启动拒绝缺失 `apiUser`, (中文(简体) ), `apiKey` 或者说 `clientIp` 并通过列出域来检查证书。 客户端IP必须被白列于"名厨"仪表板上. 请使用在 URL 中带有认证和命令参数 .

登记向账户余额收取费用。 技术、管理和计费联系人默认为 `registrant`。Whois Guard 设置默认启用.

DNS 配置替换所有已存在的记录并拒绝空的 `records` 阵列。 检索记录 `namecheapGetDnsRecords` 并包括替换组合中保留的记录。 上市工具转发了 pagination 值,而不执行 schema 描述的最大值 。 工具失败返回 `success: false` 还有一个 `error` 留言.

## 许可证

阿帕奇 - 2.0

## 常见问题

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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