Skip to main content

Documentation Index

Fetch the complete documentation index at: https://zenbulabs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Packages

PackageDescription
@zenbujs/core/runtimeService base class and runtime.
@zenbujs/core/servicesBuilt-in core services (Window, DB, RPC, HTTP, etc).
@zenbujs/core/configdefineConfig, definePlugin, defineBuildConfig.
@zenbujs/core/dbDatabase schema authoring (createSchema, z).
@zenbujs/core/adviceAdvice types and helpers.
@zenbujs/core/reactReact hooks for the renderer.
create-zenbu-appCLI scaffolding tool.

Runtime

import { Service } from "@zenbujs/core/runtime"

Config

import {
  defineConfig,
  definePlugin,
  defineBuildConfig,
} from "@zenbujs/core/config"

Database

import { createSchema, z } from "@zenbujs/core/db"

React hooks

import {
  useDb,
  useDbClient,
  useCollection,
  useRpc,
  useEvents,
  useViewArgs,
} from "@zenbujs/core/react"

CLI

# Create a new app
npx create-zenbu-app

# Dev server with hot reload
pnpm run dev

# Regenerate types
pnpm run link

# Generate a database migration
pnpm run db:generate

# Build for production
pnpm run build:source
pnpm run build:electron