Skip to content
BirdDog0.3.0
Install

Install

Durable addressed agent mail over generic Watchdog work

For a published npm release:

TERMINAL
npm install @fungi.computer/bird-dog

pnpm, Yarn and Bun work the same way.

Entrypoints

Section titled “Entrypoints”
  • @fungi.computer/bird-dog
  • @fungi.computer/bird-dog/effect

What comes with it

Section titled “What comes with it”

Installing @fungi.computer/bird-dog also installs @fungi.computer/carrier, @fungi.computer/watchdog, effect.

Install or set up

Section titled “Install or set up”
TERMINAL
npm install @fungi.computer/bird-dog

BirdDog is ESM-only. It depends on @fungi.computer/watchdog, @fungi.computer/carrier and effect, which npm installs for you. It does no I/O of its own, so it runs in Node, Cloudflare Workers or any runtime that can give it an outbox and a post function.

Entrypoints:

  • @fungi.computer/bird-dog: the Promise API on BirdDog and its types.
  • @fungi.computer/bird-dog/effect: the Effect-native mail room (make), settlementReplies, the Effect Schema parsers and BirdDogError. settlementReplies builds the same reply envelopes for a host-owned Post transport.