Installation

Orveth publishes scoped packages under @orveth/* and an optional unscoped orveth meta-package. Install only the modules your service needs.

Requirements

Requirement	Version
Node.js	`>= 20.10.0`
TypeScript	5.x with `strict` enabled (recommended)
`@types/node`	Required when compiling server code in TypeScript

Recommended: scoped server install

Most HTTP APIs need the server runtime and its error/HTTP dependencies. npm installs them transitively; listing @orveth/errors explicitly documents intent.

npm

terminal

npm install @orveth/server @orveth/errors

pnpm

terminal

pnpm add @orveth/server @orveth/errors

Yarn

terminal

yarn add @orveth/server @orveth/errors

Meta-package (all modules)

terminal

npm install orveth

The orveth package re-exports every published @orveth/* entrypoint at a single version. Use it for prototypes; prefer scoped packages in production to keep the install graph smaller.

Optional integration packages

Package	Install when	Peer / notes
`@orveth/https`	Node terminates TLS with PEM certificate files.	—
`@orveth/jwt`	You issue or verify HS256 tokens with a shared secret.	Uses `jose` at runtime.
`@orveth/prisma`	You want DB health routes or graceful Prisma shutdown.	Peer: `@prisma/client` (your app runs `prisma generate`).

Verify the install

src/main.ts

import { Orveth } from "@orveth/server";

const app = new Orveth();
app.get("/health", (ctx) => ctx.ok({ status: "ok" }));

await app.listen(Number(process.env.PORT ?? 3000));

See Getting started for module entry requirements and monorepo contributor setup.