Cyphra

Cyphra is a TypeScript toolkit for Neo4j: a .cyphra schema DSL, Cypher-first queries, a small runtime on the official driver, versioned migrations, and a CLI—similar to how the main prisma package pulls together the Prisma stack.

Install

One dependency installs the whole stack (libraries + CLI); npm/pnpm will also install the scoped packages below.

npm install cyphra
# or: pnpm add cyphra

This package declares a bin entry that delegates to @cyphra/cli (also listed as a dependency), so npx cyphra, pnpm exec cyphra, or ./node_modules/.bin/cyphra work when cyphra is a direct dependency.

What you get

| Piece | Package | Role | | -------------- | ------------------ | -------------------------------------------------- | | Schema | @cyphra/schema | Parse & validate .cyphra, print DDL hints, AST | | Query | @cyphra/query | cypher tagged templates, SelectQuery builder | | Runtime | @cyphra/runtime | CyphraClient, sessions, transactions | | Migrations | @cyphra/migrator | defineMigration, push DDL, tracked migrations | | CLI | @cyphra/cli | init, validate, migrate, push, generate… |

Import from cyphra (re-exports) or, if you prefer explicit boundaries / smaller installs, depend on individual @cyphra/* packages only.

import {
  parseSchema,
  parseSchemaFile,
  cypher,
  CyphraClient,
  defineMigration,
  constraintStatementsFromSchema,
} from "cyphra";

Dependencies

This package lists @cyphra/schema, @cyphra/query, @cyphra/runtime, @cyphra/migrator, and @cyphra/cli as production dependencies so a single npm i cyphra matches the versions published together from the monorepo (fixed versioning via Changesets).

Docs

• Documentation site (source in the monorepo)

License

MIT