---
title: "Installation"
description: "Install Blyp, understand the published subpaths, and match the right peer dependency to your framework."
canonical_url: "https://www.blyp.dev/docs/installation"
markdown_url: "https://www.blyp.dev/docs/installation.md"
last_updated: "2018-10-20"
x_farming_labs_generated_preamble: true
agent:
  task: "Install Blyp and any optional peer required by the selected runtime integration."
  outcome: "The package and selected public subpath resolve during type-checking and runtime startup."
  appliesTo:
    package:
      - "@blyp/core"
  prerequisites:
    - "Choose the target runtime and package manager before installing optional peers."
  files:
    - "package.json"
    - "pnpm-lock.yaml"
    - "bun.lock"
  commands:
    - "pnpm add @blyp/core"
  sideEffects:
    - "The package manager updates the dependency manifest and lockfile."
  verification:
    - "Import the selected public entrypoint and run the application's type-check or build."
  rollback:
    - "Remove @blyp/core and any optional peers added only for this integration."
  failureModes:
    - symptom: "A documented subpath cannot resolve."
      resolution: "Confirm @blyp/core is current and install the optional framework or provider peer named by that guide."
---

# Installation
URL: /docs/installation
LLM index: /llms.txt
Description: Install Blyp, understand the published subpaths, and match the right peer dependency to your framework.
Related: /docs/basic-usage, /docs/configuration, /docs/integrations, /docs/troubleshooting

<!-- farming-labs:agent-contract:start -->
## Agent Contract

Task: Install Blyp and any optional peer required by the selected runtime integration.
Outcome: The package and selected public subpath resolve during type-checking and runtime startup.

### Applies To

- Package: `@blyp/core`

### Prerequisites

- Choose the target runtime and package manager before installing optional peers.

### Files

- `package.json`
- `pnpm-lock.yaml`
- `bun.lock`

### Commands

- `pnpm add @blyp/core`

### Side Effects

- The package manager updates the dependency manifest and lockfile.

### Verification

- Import the selected public entrypoint and run the application's type-check or build.

### Rollback

- Remove @blyp/core and any optional peers added only for this integration.

### Failure Modes

- A documented subpath cannot resolve. — Recovery: Confirm @blyp/core is current and install the optional framework or provider peer named by that guide.
<!-- farming-labs:agent-contract:end -->

# Installation

Install `@blyp/core`, then add only the optional peer required by the chosen integration. Verify the
exact public subpath with the application's type-check and build. Do not install every connector SDK.
Subpath errors usually mean an outdated core package or a missing optional peer.

> **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`.

```bash
# 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

- 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:

| Adapter | Import path | Optional peer |
| --- | --- | --- |
| Elysia | `@blyp/core/elysia` | `elysia` |
| Expo | `@blyp/core/expo` | `expo-network` in your Expo app |
| Hono | `@blyp/core/hono` | `hono` |
| Express | `@blyp/core/express` | `express` |
| Fastify | `@blyp/core/fastify` | `fastify` |
| NestJS | `@blyp/core/nestjs` | `@nestjs/*`, `rxjs` |
| Next.js App Router | `@blyp/core/nextjs` | `next` |
| TanStack Start | `@blyp/core/tanstack-start` | `@tanstack/react-start` |
| SolidStart | `@blyp/core/solid-start` | `@solidjs/start` |
| SvelteKit | `@blyp/core/sveltekit` | `@sveltejs/kit` |
| Cloudflare Workers | `@blyp/core/workers` | none |
| Convex | `@blyp/core/convex` | none |
| Isolate-safe `defineConfig` | `@blyp/core/config` | none |
| Database adapters | `@blyp/core/database` | `@prisma/client` or `drizzle-orm` |

## Published subpaths

These are the package exports covered by the current docs:

- `@blyp/core`
- `@blyp/core/standalone`
- `@blyp/core/client`
- `@blyp/core/database`
- `@blyp/core/betterstack`
- `@blyp/core/posthog`
- `@blyp/core/sentry`
- `@blyp/core/otlp`
- `@blyp/core/elysia`
- `@blyp/core/expo`
- `@blyp/core/hono`
- `@blyp/core/express`
- `@blyp/core/fastify`
- `@blyp/core/nestjs`
- `@blyp/core/nextjs`
- `@blyp/core/tanstack-start`
- `@blyp/core/solid-start`
- `@blyp/core/sveltekit`
- `@blyp/core/workers`
- `@blyp/core/convex`
- `@blyp/core/config`

## CLI

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

- GitHub: [Blyphq/cli](https://github.com/Blyphq/cli)
- npm: [`@blyp/cli`](https://www.npmjs.com/package/@blyp/cli)

The CLI README currently documents these commands:

- `blyp studio [targetPath]`
- `blyp health`
- `blyp skills install [source-or-skill-name] [--force]`
- `blyp db:init`
- `blyp db:migrate`
- `blyp db:generate`
- `blyp help`
- `blyp --version`

## 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](/docs/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:

```bash
npx expo install expo-network
```

## Local development

These commands run inside a cloned `Blyphq/blyp` checkout, not inside an application or this docs repository:

```text
git clone https://github.com/Blyphq/blyp.git
cd blyp
bun install
bun test tests/
bun run build
bun run tsc --noEmit
```

## Migrating from other loggers

- [Winston -> Blyp](/docs/migrations/winston)
- [Pino -> Blyp](/docs/migrations/pino)

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.
Docs-scoped sitemap: [/docs/sitemap.md](/docs/sitemap.md).
Well-known sitemap: [/.well-known/sitemap.md](/.well-known/sitemap.md).