Skip to content

About this page

On this page

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.yml for Yarn, pnpm-workspace.yaml for pnpm, and .npmrc/package.json fields for npm or Bun. The trees below show Yarn.

Offline project templates ​

project ​

    • TSvite.config.tsVite+ plugin + Oxc defaults
    • JSONpackage.json
      • TSindex.ts
      • TSindex.test.ts
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.ymlcatalog

application ​

    • TSvite.config.tsVite+ plugin + Oxc defaults
    • JSONpackage.json
    • HTMLindex.html
      • TSmain.ts
      • TSindex.ts
      • TSindex.test.ts
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.ymlcatalog

folder ​

    • MDREADME.md

monorepo ​

    • TSvite.config.tsVite+ plugin + Oxc defaults
    • JSONpackage.jsonworkspaces + run scripts
    • JSONtsconfig.base.json
    • JSONtsconfig.workspaces.jsonroot paths + references
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.ymlcatalog

monorepo-example ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.workspaces.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
        • TSvite.config.ts
        • JSONpackage.json
          • TSindex.ts
          • TSindex.test.ts
        • JSONtsconfig.default.json
        • JSONtsconfig.build.json
        • JSONtsconfig.json

workspace ​

dbx create --template workspace --name core writes the workspace package into the nearest workspace directory (here packages/core).

      • TSvite.config.ts
      • JSONpackage.json
        • TSindex.ts
        • TSindex.test.ts
      • JSONtsconfig.default.json
      • JSONtsconfig.build.json
      • JSONtsconfig.json

Quality-of-life builtins ​

These templates layer a working app over the project/application scaffold. Highlighted files are the template-specific ones.

vitepress ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • MDindex.md
        • MDgetting-started.md
        • TSconfig.ts
      • TSconfig.test.ts

express ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSapp.ts
      • TSindex.ts
      • TSapp.test.ts

bun ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.jsonnode + bun types
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSapp.ts
      • TSindex.ts
      • TSapp.test.ts

fastify ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSapp.ts
      • TSindex.ts
      • TSapp.test.ts

orpc ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSplanets.ts
      • TSrouter.ts
      • TSindex.ts
      • TSplanets.test.ts

file-server ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • HTMLindex.html
      • TSserver.ts
      • TSindex.ts
      • TSserver.test.ts

file-server-s3 ​

    • TSvite.config.ts
    • JSONpackage.json
    • ENV.env.exampleS3_BUCKET / S3_REGION / credentials
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSserver.ts
      • TSindex.ts
      • TSserver.test.ts

file-server-bun-s3 ​

    • TSvite.config.ts
    • JSONpackage.json
    • ENV.env.example
    • JSONtsconfig.base.json
    • JSONtsconfig.default.jsonnode + bun types
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSapp.ts
      • TSindex.ts
      • TSapp.test.ts

file-server-minio ​

    • TSvite.config.ts
    • JSONpackage.json
    • ENV.env.examplelocal MinIO defaults
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSserver.ts
      • TSindex.ts
      • TSserver.test.ts

file-server-rclone ​

    • TSvite.config.ts
    • JSONpackage.json
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSserver.ts
      • TSindex.ts
      • TSserver.test.ts

ollama-chat ​

    • TSvite.config.ts
    • JSONpackage.json
    • HTMLindex.html
    • JSONtsconfig.base.json
    • JSONtsconfig.default.json
    • JSONtsconfig.build.json
    • JSONtsconfig.json
    • GIT.gitignore
    • MDREADME.md
    • YML.yarnrc.yml
      • TSmain.ts
      • TSollama.ts
      • CSSstyle.css
      • TSollama.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) ​

    • JSONpackage.json
    • YAMLpnpm-workspace.yaml
    • MDREADME.md
    • JSONtsconfig.json
    • TSvite.config.ts
    • GIT.gitignore
    • YML.yarnrc.yml
    • packagescreated by the workspace template

vite-plus-application (vite:application) ​

    • GIT.gitignore
    • HTMLindex.html
    • JSONpackage.json
    • public
      • TSmain.ts
      • CSSstyle.css
    • JSONtsconfig.json
    • TSvite.config.ts

vite-plus-library (vite:library) ​

    • GIT.gitignore
    • MDREADME.md
    • JSONpackage.json
      • TSindex.ts
    • JSONtsconfig.json
    • TSvite.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.

      • JSONpackage.json
      • MDREADME.md
      • JSONtsconfig.json
        • TSindex.tsrunTemplateCLI entry
        • TStemplate.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.

      • JSONtemplate.jsoninputs, actions, ignore
      • MJSaction.mjsoptional module action (not copied)
      • MDREADME.md
        • TS{{name}}.tsresolved while copying

Register it project-locally or globally:

        • JSONregistries.jsonproject template/provider paths
      • 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.

        • JSONregistries.json
            • JSONproviders.jsonprovider descriptors
        • MJSindex.mjsbinary the provider forwards to

Typical providers.json content:

.dbx/toolchain/.registry/providers/providers.json
json
[
    {
        "id": "echo",
        "name": "Echo",
        "binary": "node",
        "commands": [
            {
                "name": "echo:version",
                "subcommand": "--version",
                "description": "Print the Node version"
            }
        ]
    }
]

Registries ​

Project registry ​

        • JSONregistries.jsontemplates + providers arrays
          • templatesimplicit local registry
          • providersimplicit local registry

Global registry ​

          • JSONconfig.jsonregistrySearchPaths + providerRegistrySearchPaths
          • 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).

    • JSONdbx-templates.json{ sources: [...] } or [...]

npm organization registry (Vite+) ​

Vite+ also accepts an @org/create package whose package.json declares createConfig.templates:

    • JSONpackage.jsoncreateConfig.templates
    • MDREADME.md
        • JSONpackage.json
        • src
        • JSONpackage.json
        • src