# @aaif/goose-sdk 中文文档

规范地址：https://npmcn.com/package/%40aaif/goose-sdk/

版本：0\.20\.2
npm 元数据更新时间：2026-06-09T16:57:28.852Z
中文译文更新时间：2026-11-06T15:57:33.131Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aaif/goose-sdk
原文对照：https://npmcn.com/package/%40aaif/goose-sdk/?lang=original
项目主页：https://github.com/aaif-goose/goose#readme
源码仓库：https://github.com/aaif-goose/goose

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

- 包体积（解压后）：550 kB，32 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@agentclientprotocol/sdk ^0\.19\.0
- 首次发布：2026-04-15T16:50:19.949Z
- 最新版本发布：2026-06-09T16:57:28.545Z
- 近 30 天下载量：2816（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

鹅AI代理代理客户协议(ACP) SDK

## 安装

```sh
npm install @aaif/goose-sdk
```

也可以使用：`pnpm add @aaif/goose-sdk`、`yarn add @aaif/goose-sdk`、`bun add @aaif/goose-sdk`

## README

# @aaaif/鹅渣

鹅代理客户端协议(ACP)的TypeScript客户端库.

本套件提供:

-   Goose ACP 扩展方法的 Script 类型和 Zod 验证器
-   与 Goose ACP 服务器通信的客户端

## 安装

```bash
npm install @aaif/goose-sdk
```

当地人 `goose` 二进制作为可选的依赖性分布 并自动为您的平台安装.

## 发展

### 先决条件

-   节点.js 18+
-   Rust工具链
-   (备选)用于建设所有平台的跨汇编工具链

### 大楼

```bash
# Build everything (schema + TypeScript)
npm run build

# Build just the schema (requires Rust)
npm run build:schema

# Build just the TypeScript
npm run build:ts

# Build native binary for current platform
npm run build:native

# Build native binaries for all platforms
npm run build:native:all
```

### 本地开发与 npm 链接

在另一个项目(例如, `@aaif/goose`:

```bash
# In ui/sdk
npm run build
npm link

# In ui/text (or another project)
npm link @aaif/goose-sdk
```

### Schema 生成

TypeScript 类型来自定义于 `crates/goose`。 。 。 . 建设过程:

1.  构建 `generate-acp-schema` Rust 二进制
2.  运行它生成 `acp-schema.json` 财务报告和审定财务报表 `acp-meta.json`
3.  用途 `@hey-api/openapi-ts` 生成类型脚本类型和 Zod 校验器
4.  生成一个输入客户端 `src/generated/client.gen.ts`

改变 Rust 类型后再生计划 :

```bash
npm run build:schema
```

## 原生二进制套件

平台专用 npm 软件包 `goose` 二进制位于 `ui/goose-binary/`数字 :

| 软件包 | 平台 |
| --- | --- |
| `@aaif/goose-binary-darwin-arm64` | macOS 苹果硅 |
| `@aaif/goose-binary-darwin-x64` | macOS 英特尔 |
| `@aaif/goose-binary-linux-arm64` | Linux ARM64 软件 |
| `@aaif/goose-binary-linux-x64` | Linux x64 函数 |
| `@aaif/goose-binary-win32-x64` | 视窗 x64 |

这些出版物是单独出版的 `@aaif/goose-sdk`。 。 。 .

### 建设土著二进制

```bash
# Build for current platform
npm run build:native

# Build for all platforms (requires cross-compilation toolchains)
npm run build:native:all

# Build for specific platform(s)
npx tsx scripts/build-native.ts darwin-arm64 linux-x64
```

## 出版

出版由GitHub Actions处理. 见 `.github/workflows/publish-npm.yml`。 。 。 .

手工出版:

```bash
# From repository root
./ui/scripts/publish.sh --real
```

这将:

1.  构建和出版 `@aaif/goose-sdk`
2.  发布全部本地二进制软件包
3.  发布 `@aaif/goose` (这取决于以上)

## 使用量

```typescript
import { GooseClient } from "@aaif/goose-sdk";

const client = new GooseClient({
  // ... configuration
});

// Use the client
const result = await client.someMethod({ ... });
```

见 [主要文件](https://npmcn.com/package/README.md) 更多细节.

## 常见问题

### @aaif/goose-sdk 是什么？

鹅AI代理代理客户协议\(ACP\) SDK

### 如何安装 @aaif/goose-sdk？

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

### @aaif/goose-sdk 支持 TypeScript 吗？

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

### @aaif/goose-sdk 支持 ESM 还是 CommonJS？

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

### @aaif/goose-sdk 可以商用吗？

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

### @aaif/goose-sdk 的下载量有多少？

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

### @aaif/goose-sdk 还在维护吗？

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