Quickstart

Define and use a local ViteHub workspace.

Install and register the integration:

vite.config.ts

import { defineConfig } from 'vite'
import { hubWorkspace } from '@vitehub/workspace/vite'

export default defineConfig({
  plugins: [hubWorkspace()],
  workspace: {},
})

Create src/docs.workspace.ts for Vite or server/workspaces/docs.ts for Nitro:

import { defineWorkspace, source } from '@vitehub/workspace'

export default defineWorkspace({
  store: {
    provider: 'local',
    root: '.vitehub/workspaces/docs',
  },
  sources: {
    docs: source.file('README.md'),
  },
})

Use it from a server route:

import { useWorkspace } from '@vitehub/workspace'

const workspace = useWorkspace('docs', { mode: "write" })

await workspace.fs.writeFile('generated/notes.md', 'Generated notes')

return {
  files: await workspace.fs.list('', { recursive: true }),
}