Blyp Docs

Installation

Package name vs project name: The npm package is published as @blyp/core. The project, CLI, and all tooling use the name Blyp. The CLI is @blyp/cli with the blyp command.

Package managers

Install the npm package @blyp/core. The source repository remains Blyphq/blyp.

# Bun (recommended)
bun add @blyp/core

# npm
npm install @blyp/core

# pnpm
pnpm add @blyp/core

# yarn
yarn add @blyp/core

Runtime and language requirements

Optional framework peers

Blyp ships one package, but framework adapters rely on the framework you already use:

AdapterImport pathOptional peer
Elysia@blyp/core/elysiaelysia
Expo@blyp/core/expoexpo-network in your Expo app
Hono@blyp/core/honohono
Express@blyp/core/expressexpress
Fastify@blyp/core/fastifyfastify
NestJS@blyp/core/nestjs@nestjs/*, rxjs
Next.js App Router@blyp/core/nextjsnext
TanStack Start@blyp/core/tanstack-start@tanstack/react-start
SvelteKit@blyp/core/sveltekit@sveltejs/kit
Cloudflare Workers@blyp/core/workersnone
Database adapters@blyp/core/database@prisma/client or drizzle-orm

Published subpaths

These are the package exports covered by the current docs:

CLI

Blyp now also has a separate CLI repository. The CLI package is @blyp/cli, and the executable command is blyp.

The CLI README currently documents these commands:

Bootstrapped local config

When Blyp runs inside an application project, it bootstraps a blyp.config.json file and adds logs to .gitignore if they do not already exist. Blyp can also load blyp.config.ts, blyp.config.mts, blyp.config.cts, blyp.config.js, blyp.config.mjs, and blyp.config.cjs. See Configuration before relying on the defaults in production.

Expo-specific install

If you are using the Expo integration, install the Expo network module in your app:

npx expo install expo-network

Local development

git clone https://github.com/Blyphq/blyp.git
cd blyp
bun install
bun run test
bun run build
bun run type-check