# @atcute/atproto 中文文档

规范地址：https://npmcn.com/package/%40atcute/atproto/

版本：4\.0\.4
npm 元数据更新时间：2026-08-02T10:49:22.328Z
中文译文更新时间：2026-11-07T01:49:31.475Z
软件包许可：0BSD

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

原始 npm 页面：https://www.npmjs.com/package/%40atcute/atproto
原文对照：https://npmcn.com/package/%40atcute/atproto/?lang=original
源码仓库：https://tangled.org/did:plc:pljn5qch4tgadongtc7i6qij

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

- 包体积（解压后）：236 kB，197 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：@atcute/lexicons ^2\.0\.0
- 首次发布：2025-05-14T01:42:34.311Z
- 最新版本发布：2026-08-02T10:49:22.193Z
- 近 30 天下载量：403464（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 8 个）

## 中文简介

AT 议定书(com.atproto.\*) 计划定义

## 安装

```sh
npm install @atcute/atproto
```

也可以使用：`pnpm add @atcute/atproto`、`yarn add @atcute/atproto`、`bun add @atcute/atproto`

## README

# @ atute/ 原子弹

[AT 议定书](https://atproto.com/) (com.atproto.\*) 计划定义

```sh
npm install @atcute/atproto
```

## 使用量

```ts
import { ComAtprotoLabelDefs } from '@atcute/atproto';
import { is } from '@atcute/lexicons';

const label: ComAtprotoLabelDefs.Label = {
    cts: '2024-11-13T04:46:40.254Z',
    neg: false,
    src: 'did:plc:wkoofae5uytcm7bjncmev6n6',
    uri: 'did:plc:ia76kvnndjutgedggx2ibrem',
    val: 'she-it',
    ver: 1,
};

is(ComAtprotoLabelDefs.labelSchema, label);
// -> true
```

### 与 `@atcute/client`

选择这3个选项之一来登记环境声明

```jsonc
// file: tsconfig.json
{
    "compilerOptions": {
        "types": ["@atcute/atproto"],
    },
}
```

```ts
// file: env.d.ts
/// <reference types="@atcute/atproto" />
```

```ts
// file: index.ts
import type {} from '@atcute/atproto';
```

现在所有 XRPC 操作都应该在客户端可见

```ts
import { Client, simpleFetchHandler } from '@atcute/client';

const client = new Client({ handler: simpleFetchHandler({ service: 'https://bsky.social' }) });

const response = await client.get('com.atproto.server.describeServer');
// ...
```

### 与 `@atcute/lex-cli`

在创建自己的参考 AT 协议类型的词典时,配置 lex-cli 从 此软件包 :

```ts
// file: lex.config.js
import { defineLexiconConfig } from '@atcute/lex-cli';

export default defineLexiconConfig({
    files: ['lexicons/**/*.json'],
    outdir: 'src/lexicons/',
    imports: ['@atcute/atproto'],
});
```

## 常见问题

### @atcute/atproto 是什么？

AT 议定书\(com\.atproto\.\*\) 计划定义

### 如何安装 @atcute/atproto？

在项目目录运行 npm install @atcute/atproto，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@atcute/lexicons（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atcute/atproto 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/atcute\_\_atproto 是否存在。

### @atcute/atproto 支持 ESM 还是 CommonJS？

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

### @atcute/atproto 可以商用吗？

@atcute/atproto 使用 0BSD 许可。几乎没有限制：可自由使用、修改和分发，连保留版权声明也不要求。以上为概括，不构成法律意见，请以许可原文为准。

### @atcute/atproto 的下载量有多少？

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

### @atcute/atproto 还在维护吗？

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