Skip to main content

Install

GoatDB Installation​

GoatDB runs on both Deno and Node.js as fully supported, first-class runtimes. Deno is recommended for its cross-compilation support (compile once, deploy anywhere), but Node.js is equally capable for production use.

  1. Add GoatDB to your project:

    deno add jsr:@goatdb/goatdb

  2. Scaffold a new project (optional, for new apps):

    deno run -A jsr:@goatdb/goatdb init

    This creates a complete project — React client, GoatDB server, shared schema, and dev tooling — then installs all dependencies. Skip this step if you're adding GoatDB to an existing project.

    See the CLI & Build Tools for the generated file structure, all options, and Node.js usage.

Node.js Installation​

Requires Node.js 24 or later.

Install using one of the following package managers:

Building Standalone Executables

To compile Node.js applications to standalone executables using SEA (Single Executable Applications), GoatDB uses postject, which is installed automatically as an optional dependency. No manual setup required. See Node.js SEA docs.

npm:

npx jsr add @goatdb/goatdb

Yarn:

yarn dlx jsr add @goatdb/goatdb

pnpm:

pnpm dlx jsr add @goatdb/goatdb

Scaffold a new project (optional, for new apps):

npx -y @goatdb/goatdb init
npx -y @goatdb/goatdb init ./my-app   # optional target directory

See the CLI & Build Tools for details and generated file structure.