Template and registry structures
These trees show the files each builtin template produces and how the Vite+ provider templates, custom templates, providers and registries are laid out.
The package-manager catalog file depends on the chosen manager:
.yarnrc.ymlfor Yarn,pnpm-workspace.yamlfor pnpm, and.npmrc/package.jsonfields for npm or Bun. The trees below show Yarn.
Offline project templates
project
- myappproject
- vite.config.tsVite+ plugin + Oxc defaults
- package.json
- src1 file
- index.ts
- tests1 file
- index.test.ts
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.ymlcatalog
application
- myappapplication
- vite.config.tsVite+ plugin + Oxc defaults
- package.json
- index.html
- src2 files
- main.ts
- index.ts
- tests1 file
- index.test.ts
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.ymlcatalog
folder
- scratchfolder
- README.md
monorepo
- myappmonorepo root
- vite.config.tsVite+ plugin + Oxc defaults
- package.jsonworkspaces + run scripts
- tsconfig.base.json
- tsconfig.workspaces.jsonroot paths + references
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.ymlcatalog
monorepo-example
- myappmonorepo + example workspace
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.workspaces.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- packages1 folder
- core2 folders, 5 files
- vite.config.ts
- package.json
- src1 file
- index.ts
- tests1 file
- index.test.ts
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
workspace
dbx create --template workspace --name core writes the workspace package into the nearest workspace directory (here packages/core).
- packages1 folder
- coreworkspace package
- vite.config.ts
- package.json
- src1 file
- index.ts
- tests1 file
- index.test.ts
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
Quality-of-life builtins
These templates layer a working app over the project/application scaffold. Highlighted files are the template-specific ones.
vitepress
- myappVitePress docs
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- docs2 folders, 1 file
- index.md
- guide1 file
- getting-started.md
- .vitepress1 file
- config.ts
- tests1 file
- config.test.ts
express
- myappExpress 5 API
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- app.ts
- index.ts
- tests1 file
- app.test.ts
bun
- myappBun HTTP server
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.jsonnode + bun types
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- app.ts
- index.ts
- tests1 file
- app.test.ts
fastify
- myappFastify 5 API
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- app.ts
- index.ts
- tests1 file
- app.test.ts
orpc
- myappoRPC + Zod API
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src3 files
- planets.ts
- router.ts
- index.ts
- tests1 file
- planets.test.ts
file-server
- myappdependency-free file server
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- public1 file
- index.html
- src2 files
- server.ts
- index.ts
- tests1 file
- server.test.ts
file-server-s3
- myappAWS S3 file server
- vite.config.ts
- package.json
- .env.exampleS3_BUCKET / S3_REGION / credentials
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- server.ts
- index.ts
- tests1 file
- server.test.ts
file-server-bun-s3
- myappBun S3 file server
- vite.config.ts
- package.json
- .env.example
- tsconfig.base.json
- tsconfig.default.jsonnode + bun types
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- app.ts
- index.ts
- tests1 file
- app.test.ts
file-server-minio
- myappMinIO / S3-compatible file server
- vite.config.ts
- package.json
- .env.examplelocal MinIO defaults
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- server.ts
- index.ts
- tests1 file
- server.test.ts
file-server-rclone
- myapprclone-backed file server
- vite.config.ts
- package.json
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src2 files
- server.ts
- index.ts
- tests1 file
- server.test.ts
ollama-chat
- myappOllama chat UI
- vite.config.ts
- package.json
- index.html
- tsconfig.base.json
- tsconfig.default.json
- tsconfig.build.json
- tsconfig.json
- .gitignore
- README.md
- .yarnrc.yml
- src3 files
- main.ts
- ollama.ts
- style.css
- tests1 file
- ollama.test.ts
Vite+ provider templates
These are delegated to vp create; the exact files can change between Vite+ versions. The trees below show the current built-in layouts.
vite-plus (interactive)
vite-plus runs vp create with no fixed template id, so the tree is whichever Vite+ template you pick interactively. Use one of the fixed entries below for a stable shape.
vite-plus-monorepo (vite:monorepo)
- myappVite+ monorepo
- package.json
- pnpm-workspace.yaml
- README.md
- tsconfig.json
- vite.config.ts
- .gitignore
- .yarnrc.yml
- packagescreated by the workspace template
vite-plus-application (vite:application)
- myappVite+ application
- .gitignore
- index.html
- package.json
- public
- src2 files
- main.ts
- style.css
- tsconfig.json
- vite.config.ts
vite-plus-library (vite:library)
- myappVite+ library
- .gitignore
- README.md
- package.json
- src1 file
- index.ts
- tsconfig.json
- vite.config.ts
vite-plus-generator (vite:generator)
Requires a Vite+ monorepo. The generator is placed in generators/ or tools/ when such a parent exists and is registered in the root create.templates.
- generators1 folder
- my-generatorVite+ Bingo generator
- package.json
- README.md
- tsconfig.json
- bin1 file
- index.tsrunTemplateCLI entry
- src1 file
- template.tscreateTemplate + Zod options + produce()
Custom templates
A local template is any directory with a template.json. Files and directory names may use {{ token }} placeholders; actions can be builtin, a JS module or a shell command.
- templates1 folder
- myapp-servicecustom template
- template.jsoninputs, actions, ignore
- action.mjsoptional module action (not copied)
- README.md
- src1 file
- {{name}}.tsresolved while copying
Register it project-locally or globally:
- myapp2 folders
- .dbx1 folder
- toolchain1 file
- registries.jsonproject template/provider paths
- templates1 file
- myapp-servicesource registered above
Custom providers
A provider registry is a JSON file (or a directory of *.json files, or an http(s) URL). Project paths are searched before global paths.
- myappproject
- .dbx1 folder
- toolchain1 folder, 1 file
- registries.json
- .registry1 folder
- providers1 file
- providers.jsonprovider descriptors
- tools1 folder
- echo-provider1 file
- index.mjsbinary the provider forwards to
Typical providers.json content:
[
{
"id": "echo",
"name": "Echo",
"binary": "node",
"commands": [
{
"name": "echo:version",
"subcommand": "--version",
"description": "Print the Node version"
}
]
}
]Registries
Project registry
- myapp1 folder
- .dbx1 folder
- toolchain1 folder, 1 file
- registries.jsontemplates + providers arrays
- .registry2 files
- templatesimplicit local registry
- providersimplicit local registry
Global registry
- ~home
- .dbx1 folder
- toolchain2 folders
- cli1 file
- config.jsonregistrySearchPaths + providerRegistrySearchPaths
- .registry2 files
- templates
- providers
Remote registry
A remote registry is a JSON document with a sources array (or a bare array). Each source is resolved by its own type (local, npm, git, remote).
- https://example.com1 file
- dbx-templates.json{ sources: [...] } or [...]
npm organization registry (Vite+)
Vite+ also accepts an @org/create package whose package.json declares createConfig.templates:
- @org/create1 folder, 2 files
- package.jsoncreateConfig.templates
- README.md
- templates2 folders
- web2 files
- package.json
- src
- library2 files
- package.json
- src