Skip to content

@nextvm/cli

The nextvm command-line tool. A thin wrapper over @nextvm/build, @nextvm/db, @nextvm/registry, and @nextvm/migration.

Install

bash
pnpm add -D @nextvm/cli

This adds a nextvm binary to node_modules/.bin/. Use it directly in your scripts:

json
{
  "scripts": {
    "dev": "nextvm dev",
    "build": "nextvm build",
    "test": "vitest run",
    "validate": "nextvm validate"
  }
}

Commands

CommandStatusSee
nextvm create <name>✅ fullcreate
nextvm add <name> [--full|--blank]✅ fulladd
nextvm validate✅ fullvalidate
nextvm docs✅ fulldocs
nextvm build✅ fullbuild
nextvm dev✅ fulldev
nextvm db:migrate✅ fulldb
nextvm db:rollback✅ fulldb
nextvm db:generate⚠ stubdb
nextvm db:seed⚠ stubdb
nextvm migrate:from esx|qbcore✅ fullmigrate-from
nextvm registry:search <query>✅ fullregistry
nextvm registry:publish✅ fullregistry
nextvm deploy⚠ stubdeploy
nextvm perf⚠ stubperf

The stubs (db:generate, db:seed, deploy, perf) print clear "not yet implemented" messages with the reason — they're either deferred to (SaaS hosting) or pending sub-features that need backend services.

Programmatic API

The CLI also exports createCli() and runCli() for embedding:

typescript
import { createCli, runCli } from '@nextvm/cli'

// Run with custom argv
await runCli(['nextvm', 'build', '--quiet'])

// Or build the commander Program for further customization
const program = createCli()
program.addCommand(myCustomCommand)
program.parseAsync()

See also

Released under the LGPL-3.0 License.