---
title: Installation
description: Get started with VibORM in your project
icon: download
---

## Prerequisites

- Node.js 22+ or Bun
- TypeScript 5.9+ (on 5.8, nested includes over a large schema can fail with TS2589)
- A supported database (PostgreSQL, MySQL, or SQLite)

## Install VibORM

```bash
npm install viborm
```

Or with other package managers:

```bash
pnpm add viborm
yarn add viborm
bun add viborm
```

## Database Drivers

Install the driver for your database:

**PostgreSQL**

```bash
npm install pg
npm install -D @types/pg
```

**MySQL**

```bash
npm install mysql2
```

**SQLite**

```bash
npm install better-sqlite3
npm install -D @types/better-sqlite3
```

## TypeScript Configuration

Use strict mode for full type inference:

```json title="tsconfig.json"
{
  "compilerOptions": {
    "strict": true,
    "skipLibCheck": true,
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "allowImportingTsExtensions": true,
    "noEmit": true
  }
}
```

`skipLibCheck` keeps the compiler from re-checking every installed declaration
file, VibORM's included; without it the first check of a small project is
several times slower. The driver's `@types` package above types the driver
options. `allowImportingTsExtensions` and `noEmit` suit a project that runs its
TypeScript directly, with `tsx` or a bundler, and lets relative imports name
their `.ts` file as the [Quick Start](/docs/getting-started/quick-start) does.
A project that compiles with `tsc` drops both and imports `./schema.js`
instead.

### CommonJS projects

VibORM publishes ESM only, with ESM declarations. A CommonJS application can
`require("viborm")` through Node.js's `require(esm)` on Node.js 22.12+ or 24.
Two TypeScript settings type such a project:

| `moduleResolution` | Use it when |
|---|---|
| `"nodenext"` (with `"module": "nodenext"`) | Node.js runs the CommonJS output, or the file is a `.cts`. Needs TypeScript 5.9+. |
| `"bundler"` (with `"module": "preserve"` or `"esnext"`) | A bundler produces the CommonJS output. |

`"node16"` reports `TS1479` on every VibORM import, and `"node10"` (`"node"`)
cannot resolve the subpath entries such as `viborm/sqlite3` (`TS2307`). VibORM
ships no `.d.cts` declarations for them. Node.js 22.0 to 22.11 need a flag for
`require(esm)`.

## Project Structure

A typical VibORM project structure:

```
src/
├── db/
│   ├── schema.ts      # Model definitions
│   ├── client.ts      # Client initialization
│   └── index.ts       # Re-exports
├── ...
```

## Next Steps

**[Compare Drivers](/docs/drivers)**

Choose the right driver for your database and runtime

**[Quick Start Tutorial](/docs/getting-started/quick-start)**

Build a schema, create its tables, and run your first query
