ViteHub is still experimental. Expect bugs and breaking changes.

File conventions

Reference the discovery paths that produce ViteHub Discovered Definitions and Discovery Identity.

File conventions produce Discovered Definitions. Discovery Identity comes from the discovery location, not from arbitrary inline Definition Options.

Definition files

DefinitionCurrent conventionDiscovery Identity
Agent Definitionserver/agents/<agent>.ts or server/agents/<agent>/config.tsAgent File Name or agent folder name.
Auth Definitionserver/auth.ts or server.auth.tsSingle app Auth Definition.
Database Definitionsrc/database.ts or src/<name>.database.tsdefault for database.ts; suffix file name for named databases.
Queue Definitionserver/queues/<name>.ts or src/<name>.queue.tsFile name.
Workflow Definitionserver/workflows/<name>.ts, server/workflows/<name>/index.ts, or src/<name>.workflow.tsFile or folder name.
Schedule Definitionserver/schedules/<name>.ts or src/<name>.schedule.tsFile name.
Sandbox Definitionsrc/<name>.sandbox.tsFile name.
Workspace Definitionserver/workspaces/<name>.ts or package-supported colocated Workspace DefinitionFile name or colocated owner name.

Export shape

First-class discovered definition files should default-export the package-owned Definition Boundary Helper. This keeps Build-Extracted Definition Options limited to the direct discovered default export.

server/queues/welcome-email.ts
import { defineQueue } from '@vite-hub/queue'

export default defineQueue<{ email: string }>(async (job) => {
  await sendWelcomeEmail(job.payload.email)
})

Avoid aggregate named exports for discovered Definitions. The generated Runtime Registry expects one discovered boundary per file convention.

Colocated Workspace files

Agent folders can colocate Workspace content beside the Agent Definition. When a folder contains workspace/, that folder becomes the Workspace Source Root for the colocated Workspace Definition.

File tree
server/
  agents/
    docs/
      config.ts
      workspace/
        README.md
        guides/
          setup.md

Generated files

Generated files live under .vitehub/** and host output directories. They prove discovery and Provider Output, but the source Definition files remain the authoring surface.

Copyright © 2026