valv library

Installation

Install an adapter for your database. Each adapter pulls in @valv/core, so you don’t install core directly. valv ships as ESM and targets current Node.js runtimes.

ClickHouse

Install the ClickHouse adapter alongside the official client:

npm i @valv/clickhouse @clickhouse/client

You connect with a @clickhouse/client instance and pass a database name when you create valv. See Schema for connection details.

Prisma

The Prisma adapter covers every Prisma-supported relational database: Postgres, MySQL, SQLite, and CockroachDB. Install it alongside your Prisma client:

npm i @valv/prisma @prisma/client

valv reads the schema from your generated Prisma client, so no extra schema configuration is needed.

Coding agents

To expose a database to a coding agent like Claude Code, you don’t add anything to a project. Run the MCP server on demand, and optionally add the /valv charting skill:

npx @valv/mcp init                                # MCP server
npx skills add https://github.com/valv-dev --skill valv   # /valv charting skill

See MCP server for the guided setup and the skill.

Next steps

  • Quickstart: wire valv to an agent in a few lines.
  • Schema: introspect a live schema or define one by hand.