mirror of https://github.com/aaif-goose/goose.git synced 2026-07-03 14:10:03 +02:00

Files

T

History

Filip Kujawa 05033b00e8 feat(acp): deliver per-message usage via message_usage custom notification

New sessionUpdate variant on _goose/unstable/session/update carrying
{messageId?, usage} keyed by the id already used for chunk matching.
Sent live from the prompt stream loop and on session replay after each
message's content chunks, both gated on the client's goose custom
notification capability. Regenerates acp-schema.json and the SDK types.

2026-07-02 17:00:16 -07:00

scripts

fix: goose-sdk release compat check with new schema (#9697 )

2026-06-09 13:53:45 +00:00

src

feat(acp): deliver per-message usage via message_usage custom notification

2026-07-02 17:00:16 -07:00

tests

added recipe handling in new_session (#9935 )

2026-06-22 23:05:19 +00:00

.gitignore

…

generate-schema.ts

added recipe handling in new_session (#9935 )

2026-06-22 23:05:19 +00:00

package.json

chore: pause tui release (#9685 )

2026-06-09 07:06:06 +00:00

README.md

merge goose-acp crate into goose (#8726 )

2026-04-21 20:26:49 +00:00

tsconfig.json

…

tsconfig.test.json

feat: Only send custom notifications when ACP client specifies this capability in the initialization request (#9596 )

2026-06-04 22:39:59 +00:00

README.md

@aaif/goose-sdk

TypeScript client library for the Goose Agent Client Protocol (ACP).

This package provides:

TypeScript types and Zod validators for Goose ACP extension methods
A client for communicating with the Goose ACP server

Installation

npm install @aaif/goose-sdk

The native goose binaries are distributed as optional dependencies and will be automatically installed for your platform.

Development

Prerequisites

Node.js 18+
Rust toolchain
(Optional) Cross-compilation toolchains for building all platforms

Building

# 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

Local Development with npm link

To use this package locally in another project (e.g., @aaif/goose):

# In ui/sdk
npm run build
npm link

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

Schema Generation

The TypeScript types are generated from Rust schemas defined in crates/goose. The build process:

Builds the generate-acp-schema Rust binary
Runs it to generate acp-schema.json and acp-meta.json
Uses @hey-api/openapi-ts to generate TypeScript types and Zod validators
Generates a typed client in src/generated/client.gen.ts

To regenerate schemas after changing Rust types:

npm run build:schema

Native Binary Packages

Platform-specific npm packages for the goose binary are located in ui/goose-binary/:

Package	Platform
`@aaif/goose-binary-darwin-arm64`	macOS Apple Silicon
`@aaif/goose-binary-darwin-x64`	macOS Intel
`@aaif/goose-binary-linux-arm64`	Linux ARM64
`@aaif/goose-binary-linux-x64`	Linux x64
`@aaif/goose-binary-win32-x64`	Windows x64

These are published separately from @aaif/goose-sdk.

Building Native Binaries

# 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

Publishing

Publishing is handled by GitHub Actions. See .github/workflows/publish-npm.yml.

For manual publishing:

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

This will:

Build and publish @aaif/goose-sdk
Publish all native binary packages
Publish @aaif/goose (which depends on the above)

Usage

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

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

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

See the main documentation for more details.