Skip to content

/packages/

Packages

Most deployments run the Docker image and use one of the client packages. Reach for @vol-a/server to embed vola in your own Fastify application, or to run the server on one SQLite file without Docker.

PackageVersionOn npmUses
@vol-a/coreZod schemas, inferred types and helpers shared by server, CLI and clients.1.1.0not on npm yetNone
@vol-a/lookupsControlled vocabularies from YAML (file kinds, processing statuses and kinds, share scopes, OCR languages, encryption modes), CSV translations, candidate recording and TypeScript/Zod codegen.1.1.0not on npm yetNone
@vol-a/serverFastify plugin and standalone server, Drizzle on PostgreSQL or SQLite, Redis, tenant isolation, API key auth, UDC collections.1.1.0not on npm yet@vol-a/core@vol-a/lookups
@vol-a/cliTenants, API keys, migrations and the lookups vocabulary for @vol-a/server.1.1.0not on npm yet@vol-a/client@vol-a/core@vol-a/lookups@vol-a/server
@vol-a/clientA fetch-based, dependency-light client for the @vol-a/server API — files, folders, resumable uploads, shares, keyrings, stats — for Node 24+ and browsers.1.1.0not on npm yet@vol-a/core
@vol-a/reactVolaProvider, a live file browser on @jsudc/react, uploads with resumable progress, thumbnails, the keyring PIN gate with auto-lock, and the share dialog.1.1.0not on npm yet@vol-a/client@vol-a/core

Read from packages/*/package.json when this site was built (): one version, 1.1.0, for all 6. Licence: MIT. On npm: the npm registry, asked in the same build: the newest version of each package and when it was published; none is on npm yet.

You are Install
Calling a vola server from a backend or a browser @vol-a/client
Drawing files in a React app @vol-a/react, @vol-a/client and their peers
Mounting vola inside Fastify @vol-a/server, @vol-a/core
Running the server on one SQLite file, without Docker (how) @vol-a/server, @vol-a/cli
Sharing types with your own HTTP client @vol-a/core

The vola command line (@vol-a/cli) is already inside the image, and @vol-a/lookups is what the server uses for its controlled vocabulary.

ghcr.io/digital-cube/jsvola holds the server, the worker, the command line, the examples site and the tools the worker needs. The tags and every setting are in the deployment guide.

What changed in each release: Changelog. SQLite as a database came in 1.1.0; @vol-a/server 1.0.1 runs on PostgreSQL only.

v1.1.0released built 402bea0