Backend Scripts
This guide explains the main Vona script workflows in the Cabloy monorepo.
Shared rule
Even though the underlying backend scripts still live in vona/package.json, contributors should usually start from the root scripts in the monorepo because they are the shared workflow surface.
Root scripts vs Vona CLI
A practical distinction is:
- use root scripts for normal runtime workflows such as install, dev, build, start, test, and typecheck
- use
npm run vona ...when you need backend command discovery, generation, initialization, or backend-specific tool flows
That means Backend CLI and this page are complementary, not redundant.
Development
Start the backend in the root repository:
npm run devThe underlying Vona package also distinguishes multi-worker and single-worker development modes:
cd vona && npm run dev
cd vona && npm run dev:oneBuild
From the root repository:
npm run build
npm run build:dockerThe backend-side build behavior is driven by Vona scripts such as:
buildbuild:docker
Start
From the root repository:
npm run startVona also supports single-process and docker-oriented start modes inside its own package:
cd vona && npm run start
cd vona && npm run start:one
cd vona && npm run start:dockerTest and typecheck
From the root repository:
npm run test
npm run tscThe backend-specific script surface also includes:
covdb:resetplay
Playground
The Playground remains a high-value verification path for fast backend checks.
cd vona && npm run playOr through the CLI wrapper:
npm run vona :bin:play -- --flavor=play --dummyDatabase reset
cd vona && npm run db:resetRelationship to backend essentials
These scripts are part of the backend essentials workflow because they define how contributors actually enter the backend runtime.
A useful split is:
- scripts answer how the monorepo runs backend workflows
- the CLI answers how backend resources are discovered and generated
- modules and suites answer where generated resources belong
For the structural side of that story, also see Backend Essentials and Package Map.
Guidance
When documenting or automating backend scripts:
- prefer root scripts for normal contributor workflows
- drop to
vona/package.jsononly when you need backend-specific detail - verify commands against current scripts before publishing examples