@aaaif/鹅渣
鹅代理客户端协议(ACP)的TypeScript客户端库.
本套件提供:
- Goose ACP 扩展方法的 Script 类型和 Zod 验证器
- 与 Goose ACP 服务器通信的客户端
安装
npm install @aaif/goose-sdk
当地人 goose 二进制作为可选的依赖性分布
并自动为您的平台安装.
发展
先决条件
- 节点.js 18+
- Rust工具链
- (备选)用于建设所有平台的跨汇编工具链
大楼
# 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:
# In ui/sdk
npm run build
npm link
# In ui/text (or another project)
npm link @aaif/goose-sdk
Schema 生成
TypeScript 类型来自定义于 crates/goose。 。 。 .
建设过程:
- 构建
generate-acp-schemaRust 二进制 - 运行它生成
acp-schema.json财务报告和审定财务报表acp-meta.json - 用途
@hey-api/openapi-ts生成类型脚本类型和 Zod 校验器 - 生成一个输入客户端
src/generated/client.gen.ts
改变 Rust 类型后再生计划 :
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。 。 。 .
建设土著二进制
# 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。 。 。 .
手工出版:
# From repository root
./ui/scripts/publish.sh --real
这将:
- 构建和出版
@aaif/goose-sdk - 发布全部本地二进制软件包
- 发布
@aaif/goose(这取决于以上)
使用量
import { GooseClient } from "@aaif/goose-sdk";
const client = new GooseClient({
// ... configuration
});
// Use the client
const result = await client.someMethod({ ... });
见 主要文件 更多细节.