Blyp Docs

Installation

Package managers

Install the npm package blyp-js. The source repository remains Blyphq/blyp.

bun add blyp-js
npm install blyp-js
yarn add blyp-js
pnpm add blyp-js

Runtime and language requirements

  • Bun 1.2+ or Node.js 18+
  • TypeScript 5+

Optional framework peers

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

AdapterImport pathOptional peer
Elysiablyp-js/elysiaelysia
Expoblyp-js/expoexpo-network in your Expo app
Honoblyp-js/honohono
Expressblyp-js/expressexpress
Fastifyblyp-js/fastifyfastify
NestJSblyp-js/nestjs@nestjs/*, rxjs
Next.js App Routerblyp-js/nextjsnext
TanStack Startblyp-js/tanstack-start@tanstack/react-start
SvelteKitblyp-js/sveltekit@sveltejs/kit
Cloudflare Workersblyp-js/workersnone

Published subpaths

These are the package exports exposed by blyp-js@0.1.0:

  • blyp-js
  • blyp-js/standalone
  • blyp-js/client
  • blyp-js/elysia
  • blyp-js/expo
  • blyp-js/hono
  • blyp-js/express
  • blyp-js/fastify
  • blyp-js/nestjs
  • blyp-js/nextjs
  • blyp-js/tanstack-start
  • blyp-js/sveltekit
  • blyp-js/workers

Bootstrapped local config

When Blyp runs inside an application project, it will bootstrap a blyp.config.json file and add logs to .gitignore if they do not already exist. 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

On this page

No Headings