Installation

pipedog is split into packages, like Pipecat's optional extras. They are published on npm under the @pipedog scope and released together at one version: upgrade them together.

To start a project from a template instead, run bunx @pipedog/cli init (see CLI): it writes a bot with the packages below already in its package.json.

Where Python installs pipecat-ai[deepgram,openai], you add @pipedog/core plus @pipedog/deepgram and @pipedog/openai. Services lists every provider and its package, and Transports the transports.

Package managersCopy Anchor Link

bun add @pipedog/core @pipedog/asyncio

RequirementsCopy Anchor Link

• Bun, Node.js 22 or later, Deno, or Cloudflare Workers (with the nodejs_compat compatibility flag, which provides AsyncLocalStorage).
• The npm packages ship compiled JavaScript (ES modules) with .d.ts types, so every runtime and bundler loads them as they are.
• From source, the packages are TypeScript written with erasable syntax only (no enum, namespace or parameter properties), so Bun and Deno run them directly and Node runs them with its built-in type stripping. If you type-check against the sources with tsc, use "moduleResolution": "Bundler" (or "NodeNext") and "allowImportingTsExtensions": true.

ImportsCopy Anchor Link

Modules are imported by their upstream path, so a Pipecat import translates directly:

from pipecat.pipeline.pipeline import Pipeline
from pipecat.pipeline.worker import PipelineParams, PipelineWorker
from pipecat.workers.runner import WorkerRunner

import { Pipeline } from "@pipedog/core/pipeline/pipeline";
import { PipelineParams, PipelineWorker } from "@pipedog/core/pipeline/worker";
import { WorkerRunner } from "@pipedog/core/workers/runner";

From sourceCopy Anchor Link

To work on pipedog itself, or to run unreleased changes: pipedog is a Bun monorepo. Clone it, install, and add your app as a workspace (for example under examples/), depending on the packages with workspace:*:

bun install
bun test            # the ported upstream test suite
bun run typecheck   # tsc over every package

{
  "name": "my-bot",
  "private": true,
  "type": "module",
  "dependencies": {
    "@pipedog/asyncio": "workspace:*",
    "@pipedog/core": "workspace:*"
  }
}

Then continue with the Quickstart.