| title | Development server |
|---|---|
| description | Start a VitNode app, API app or plugin package in development with vitnode dev, including database setup, ports, hosts and keyboard shortcuts. |
| icon | Play |
vitnode dev starts whatever the current folder is: an app gets a Vite dev server, an API app gets a watching Node or Bun process, and a plugin package gets tsdown and the type checker in watch mode. Run it from the project's folder, usually through the dev script:
pnpm devIn a Turborepo workspace, pnpm dev at the root builds every plugin, prepares the database (db:prepare) and then starts each app's and plugin's own dev script, so one command starts everything.
◆ VitNode
Development
✓ Loading configuration 31ms
✓ Checking database schema 1.2s
✓ Database connected up to date
✓ 2 plugins loaded
✓ Starting dev server 2.6s
Web http://localhost:3000
AdminCP http://localhost:3000/admin
API http://localhost:3000/api
────────────────────────────────────────
GET / 200 180ms
GET /api/@vitnode/core/users/session 200 6ms
HMR src/routes/_main/index.tsxBelow the line, the CLI logs page loads, API calls, server functions and every non-GET request, plus each hot update (HMR). Requests for scripts, styles and images are left out so the log stays readable.
The URLs are the ones Vite actually bound. The API row appears when the app also serves the API.
The port is the first one set of: --port, the PORT variable, server.port in vite.config.ts, then 3000.
vitnode dev --port 4000
vitnode dev --host # listen on every address
vitnode dev --host 127.0.0.1 # listen on one addressWith --host, a Network row shows the address other devices on your network can open, which is handy for testing on a phone.
In an interactive terminal, type a key and press Enter:
| Key | Action |
|---|---|
o |
Open the site |
a |
Open AdminCP |
r |
Restart |
q |
Quit |
Ctrl+C closes the dev server and every watcher it started.
When the app owns the database (it has both a drizzle.config.ts and src/vitnode.api.config.ts), vitnode dev prepares the database before anything serves a request:
- It compares your schema with the last migration and generates a migration when they differ.
- It applies pending migrations.
- It seeds the data every installation needs: languages, roles and permissions.
The server starts only after this finishes, so your first page load never hits a half-built schema. When the terminal is not interactive and drizzle-kit needs to ask whether a column was renamed, the CLI skips generation with a warning. Run vitnode db generate yourself to answer it. See Database commands.
In a folder with src/vitnode.api.config.ts and no Vite config, vitnode dev runs your API with a file watcher:
API http://localhost:8000/api
Runtime Node (tsx watch)The port is --port, then PORT, then 8000. The CLI passes it to your API as PORT. --host is passed as HOST, and a bare --host means 0.0.0.0. Generated API apps read both variables.
The API runs on Bun, with bun --hot, when any of these is true:
package.jsondeclares"vitnode": { "runtime": "bun" }("node"there forces Node, whatever else says Bun)- you started the script with Bun (
bun run dev) - the nearest
packageManagerfield saysbun@... - the nearest lockfile is
bun.lockorbun.lockb
Otherwise it runs on Node with tsx watch.
In a plugin package, vitnode dev regenerates the plugin's API registry (types/api-registry.gen.d.ts, when the plugin has a src/config.api.ts) and its manifest (src/manifest.gen.ts), then watches src with tsdown and runs tsc in watch mode to report type errors. Apps that use the plugin import its dist folder, so they reload as you save.
◆ VitNode
Plugin development - site-notes
✓ API registry generated
✓ Plugin manifest generated
● Watching sources - apps using this plugin reload as dist/ changes
tsdown js Rebuilt in 71ms.
tsdown types Rebuilt in 4493ms.The JavaScript (tsdown js) is rebuilt within milliseconds of a save. Declarations (tsdown types) follow once TypeScript catches up, so your editor sees new types a few seconds later. A syntax error is printed and the next save rebuilds. If a watcher fails to start, for example because tsdown is not installed, the CLI stops the others and exits with code 1.
Build and watch a plugin covers added and deleted files, assets and what your app sees while a rebuild is written.