---
title: "Overview"
description: "Blyp is a runtime-adaptive logger for standalone apps, browser clients, and modern TypeScript server frameworks."
canonical_url: "https://www.blyp.dev/docs"
markdown_url: "https://www.blyp.dev/docs.md"
last_updated: "2018-10-20"
x_farming_labs_generated_preamble: true
agent:
  task: "Select the correct Blyp surface and complete a minimal logger setup."
  outcome: "The application emits a structured Blyp record through the intended runtime entrypoint."
  appliesTo:
    package:
      - "@blyp/core"
  prerequisites:
    - "Identify whether the target runs on a server"
    - "browser"
    - "Expo"
    - "Worker"
    - "or framework adapter."
  files:
    - "blyp.config.ts"
    - "src/index.ts"
  commands:
    - "pnpm add @blyp/core"
  sideEffects:
    - "The first run may create local config and log output paths."
  verification:
    - "Emit a uniquely named info record and confirm it appears in the configured destination."
  rollback:
    - "Remove the Blyp initialization and restore the previous logging call."
  failureModes:
    - symptom: "An import resolves in development but fails in another runtime."
      resolution: "Use the documented runtime-specific subpath instead of importing a server surface into browser or isolate code."
---

# Overview
URL: /docs
LLM index: /llms.txt
Description: Blyp is a runtime-adaptive logger for standalone apps, browser clients, and modern TypeScript server frameworks.
Related: /docs/installation, /docs/basic-usage, /docs/configuration, /docs/mcp

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

Task: Select the correct Blyp surface and complete a minimal logger setup.
Outcome: The application emits a structured Blyp record through the intended runtime entrypoint.

### Applies To

- Package: `@blyp/core`

### Prerequisites

- Identify whether the target runs on a server
- browser
- Expo
- Worker
- or framework adapter.

### Files

- `blyp.config.ts`
- `src/index.ts`

### Commands

- `pnpm add @blyp/core`

### Side Effects

- The first run may create local config and log output paths.

### Verification

- Emit a uniquely named info record and confirm it appears in the configured destination.

### Rollback

- Remove the Blyp initialization and restore the previous logging call.

### Failure Modes

- An import resolves in development but fails in another runtime. — Recovery: Use the documented runtime-specific subpath instead of importing a server surface into browser or isolate code.
<!-- farming-labs:agent-contract:end -->

# Blyp Logger

Identify the runtime first, install `@blyp/core`, and use the matching documented entrypoint. Start
with one uniquely named record before enabling databases or connectors. If an import fails only in a
browser, Worker, or framework build, replace the server entrypoint with that runtime's dedicated
subpath rather than adding polyfills.

> Grep less. Understand more.

Blyp is a high-performance logger built for Bun-first and Node-compatible TypeScript applications. It gives you one package that covers:

- root application logging
- standalone logger instances
- structured request batches
- framework-aware HTTP logging
- AI tracing across Better Agent, Vercel AI SDK, OpenAI, Anthropic, and OpenRouter-compatible clients
- browser-to-server log ingestion
- structured `BlypError` handling
- NDJSON file logging with rotation and archives
- database-backed primary logging with Prisma and Drizzle adapters

## Stability

| Area | Tier | Guarantee |
| --- | --- | --- |
| Core logger API (`logger.*`, `createStructuredLog`, `createError`) | Stable | No breaking changes without a major version bump |
| Framework adapters (`@blyp/core/hono`, `/nextjs`, etc.) | Stable | Same guarantee |
| Connector APIs | Stable | Same guarantee |
| Studio UI | Beta | May change between minor versions |
| CLI commands | Beta | Commands may be added or changed in a minor version |
| Internal APIs / unexported symbols | Unstable | No guarantees |

For the full compatibility policy, deprecation window, and Bun vs Node support contract, see [`Blyphq/blyp/STABILITY.md`](https://github.com/Blyphq/blyp/blob/main/STABILITY.md). For vulnerability disclosure and maintainer response expectations, see [`Blyphq/blyp/SECURITY.md`](https://github.com/Blyphq/blyp/blob/main/SECURITY.md).

## Studio

Blyp includes a local developer UI called **Studio**, launched via the CLI. Studio runs at `http://localhost:3003` and lets you inspect your project, work with logs, and manage AI assistant workflows tied to your codebase.

To launch it:

```bash
bunx @blyp/cli studio
```

See the [CLI docs](/docs/cli) for full Studio usage.

Blyp also now has a separate CLI project for local developer workflows, documented in `Blyphq/cli` as `@blyp/cli` with the `blyp` command.

## What Blyp exports

| Area | Import path | What you get |
| --- | --- | --- |
| Core logger + errors | `@blyp/core` | `logger`, `createStandaloneLogger`, `createStructuredLog`, `createError`, `HTTP_CODES`, `parseError`, `readLogFile`, config/runtime helpers |
| Browser logger | `@blyp/core/client` | `createClientLogger`, browser-safe `parseError`, `ClientLogger` types |
| AI tracing | `@blyp/core/ai/better-agent`, `@blyp/core/ai/vercel`, `@blyp/core/ai/openai`, `@blyp/core/ai/anthropic`, `@blyp/core/ai/fetch` | Better Agent plugins and manual trackers, middleware, model wrappers, provider wrappers, transport tracing, and AI trace types |
| Database adapters | `@blyp/core/database` | `createPrismaDatabaseAdapter`, `createDrizzleDatabaseAdapter`, and database config types |
| Connector helpers | `@blyp/core/betterstack`, `@blyp/core/posthog`, `@blyp/core/databuddy`, `@blyp/core/sentry`, `@blyp/core/otlp` | manual connector loggers, structured connector helpers, and provider-specific exception capture |
| Framework adapters | `@blyp/core/<framework>` | `createLogger()` or equivalent framework factory plus framework-specific types |
| Workers | `@blyp/core/workers` | `initWorkersLogger`, `createWorkersLogger`, Workers-specific request logger types |
| Convex | `@blyp/core/convex` | `logger`, `configureConvexLogger`, `createConvexLogger`, Convex isolate logger types |
| Isolate-safe config | `@blyp/core/config` | `defineConfig` for `blyp.config.ts` files that Convex can import |

## Quick start

```bash
bun add @blyp/core
```

> The published npm package is `@blyp/core`. The project, org, and tooling all use the name **Blyp**.

```ts
import { logger, createError } from "@blyp/core";

logger.info("server started");
logger.success("cache warmed");

throw createError({
  status: 404,
  message: "User not found",
});
```

## Supported integrations

- `@blyp/core/elysia`
- `@blyp/core/expo`
- `@blyp/core/hono`
- `@blyp/core/express`
- `@blyp/core/fastify`
- `@blyp/core/nestjs`
- `@blyp/core/nextjs`
- `@blyp/core/react-router`
- `@blyp/core/tanstack-start`
- `@blyp/core/solid-start`
- `@blyp/core/sveltekit`
- `@blyp/core/astro`
- `@blyp/core/nuxt`
- `@blyp/core/workers`
- `@blyp/core/convex`
- `@blyp/core/config`

## Recommended reading order

- [Installation](/docs/installation) for package managers, peer dependencies, and exported subpaths.
- [CLI](/docs/cli) for the `blyp` command, Studio launch flow, health checks, and skill installation.
- [Changelog](/docs/changelog) for the consolidated `@blyp/core` and `@blyp/cli` release history.
- [Docs MCP](/docs/mcp) to connect Claude Code, Cursor, Codex, or another MCP client directly to these docs.
- [Basic Usage](/docs/basic-usage) for logger methods, child loggers, and standalone instances.
- [Configuration](/docs/configuration) for `blyp.config.*`, connector setup, `ignorePaths`, and client ingestion config.
- [Database](/docs/database) for required schemas, Prisma and Drizzle adapters, delivery, and CLI-assisted setup.
- [Schema Contract](/docs/database/schema) for the required `blyp_logs` table, indexes, and naming contract.
- [AI](/docs/ai) for AI tracing concepts, provider coverage, and request-scoped correlation.
- [AI Tracing](/docs/ai/tracing) for setup with Better Agent, Vercel AI SDK, OpenAI, Anthropic, OpenRouter, and low-level fetch tracing.
- [Working With Blyp](/docs/working-with-blyp) for grouped development and production guides.
- [Production](/docs/working-with-blyp/production) for deployment guidance covering durability, flush boundaries, connectors at scale, and serverless runtimes.
- [Request Tracing](/docs/working-with-blyp/request-tracing) for `x-blyp-trace-id`, browser correlation, and end-to-end trace propagation.
- [Structured Logs](/docs/structured-logs) for `createStructuredLog()`, typed fields, and request-scoped batch emission.
- [Errors](/docs/errors) for `createError()`, `parseError()`, and `BlypError` behavior.
- [Skills](/docs/skills) for copy-pasteable AI agent presets that help tools install and wire Blyp correctly.
- [Integrations](/docs/integrations) for browser, framework, and runtime-specific guides.
- [Connectors](/docs/connectors) for Better Stack, PostHog, Databuddy, Sentry, OTLP, and client/expo forwarding.
- [Client](/docs/integrations/client) for browser logging and `/inngest` ingestion.
- [Expo](/docs/integrations/expo) if you are shipping a mobile app and need remote client log sync from Expo.
- [Configuration](/docs/configuration) for `blyp.config.*`, connector setup, `ignorePaths`, and client ingestion config.
- [Troubleshooting](/docs/troubleshooting) for Studio connection problems, missing logs, connector auth issues, file logging failures, and TypeScript import errors.
- [Type Surfaces](/docs/types) for standalone, server-side, and browser-facing types.

## 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).