@atcute/atproto

中文文档
4.0.4发布于 2026/08/020BSDES Module近 30 天下载 40.3万

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

中文使用文档
文档目录3 节
  1. 使用量
  2. 与 @atcute/client
  3. 与 @atcute/lex-cli

@ atute/ 原子弹

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

npm install @atcute/atproto

使用量

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个选项之一来登记环境声明

// file: tsconfig.json
{
    "compilerOptions": {
        "types": ["@atcute/atproto"],
    },
}
// file: env.d.ts
/// <reference types="@atcute/atproto" />
// file: index.ts
import type {} from '@atcute/atproto';

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

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 从 此软件包 :

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

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

版本与发布记录

@atcute/atproto 共发布 22 个版本,首次发布于 2025/05/14;过去 12 个月发布了 8 个版本。

版本发布日期距今
4.0.4latest2026/08/023 个月前
4.0.32026/06/294 个月前
4.0.22026/06/015 个月前
4.0.12026/05/265 个月前
4.0.02026/05/095 个月前
3.1.122026/05/086 个月前

关于 @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 和提交记录判断。