Package Reference

These pages are generated from package READMEs. Edit the package README, then rerun the docs generator.

Package	Area	Summary
@dbx-tools/cli	CLI Tools	Use one CLI to authenticate with Databricks, connect local PostgreSQL tools to Lakebase, serve Databricks models to coding agents, run graph memory, and share applications through a gated public URL.
@dbx-tools/cli-args	CLI Tools	Generate Commander flags from a Zod object schema so any CLI can share one argument, help, and layered-config path without installing the full dbx package.
@dbx-tools/cli-service	CLI Tools	Add desktop-service installation, lifecycle commands, optional uv-managed Python dependencies, and a tray menu to a Commander CLI. Users can keep your command running after their terminal closes and manage it through the same service commands on macOS, Linux, and Windows.
@dbx-tools/appkit	Node and AppKit	Node-side helpers for Databricks AppKit apps.
@dbx-tools/appkit-graphiti	Node and AppKit	Run Graphiti as an AppKit plugin or supervise the same Python runtime directly from Node. The package root exposes the plugin; the runtime and options subpaths expose the underlying lifecycle and configuration contracts.
@dbx-tools/appkit-mastra	Node and AppKit	AppKit plugin and server-side toolkit for hosting Mastra agents inside a Databricks App.
@dbx-tools/appkit-model-gateway	Node and AppKit	Give OpenAI-, Anthropic-, and Codex-compatible clients one endpoint for the models available in a Databricks workspace. The AppKit plugin discovers the workspace catalogue, exposes familiar model APIs, and chooses a compatible Databricks route for each request.
@dbx-tools/appkit-sandbox	Node and AppKit	AppKit integration for Databricks Sandboxes. It manages assigned machines, executes SSH commands, provisions browser services, and persists isolated Projects in Lakebase.
@dbx-tools/appkit-web-search	Node and AppKit	Server-side web-search runtime, Mastra tools, and AppKit plugin.
@dbx-tools/auth	Node and AppKit	Databricks profile resolution and token or authentication-header production for Node.js and Bun.
@dbx-tools/auth-gate	Node and AppKit	Passwordless authentication runtime built on Better Auth, email OTP, passkeys, and caller-provided identity policy and delivery.
@dbx-tools/cache	Node and AppKit	Memory-first caching for Node.js and Bun, built on Cacheable v2 and Keyv.
@dbx-tools/core	Node and AppKit	Node-only core helpers for layered configuration, binary installation, process execution, locking, and project discovery.
@dbx-tools/databricks	Node and AppKit	Databricks workspace, filesystem, cloud, and network utilities.
@dbx-tools/databricks-zerobus	Node and AppKit	Region-aware Zerobus ingest helpers for Databricks workspaces.
@dbx-tools/email	Node and AppKit	Server-side email runtime, agent tools, and AppKit plugin.
@dbx-tools/fs	Node and AppKit	Node local-disk FileSystem implementation of the @dbx-tools/shared-fs contract. Built on BaseFileSystem, so this package only implements host separator conversion (toBackendPath), Node I/O, symlink containment (preparePath), and errno mapping.
@dbx-tools/genie	Node and AppKit	Server-side Databricks Genie chat drivers.
@dbx-tools/lakebase	Node and AppKit	Resolve a Databricks Lakebase target into the host, database, and user a PostgreSQL client needs, then request a short-lived database credential. The package gives Node and Bun applications one profile-aware path from a project name or resource URL to connection-ready values. When the target is a Lakebase path or URL without a chosen database, discovery picks the branch default (status.default, then Lakebase’s provisioned databricks_postgres) instead of PostgreSQL’s generic postgres database.
@dbx-tools/model	Node and AppKit	Workspace-aware Databricks Model Serving selection.
@dbx-tools/model-protocol	Node and AppKit	Shared Vercel AI SDK providers and protocol transforms for Databricks model traffic.
@dbx-tools/path	Node and AppKit	Node filesystem path toolkit for discovery, matching, ignoring, scanning, and watching.
@dbx-tools/postgres	Node and AppKit	Connection-correct PostgreSQL primitives for Node.js: advisory locks that hold the connection they lock, and a structured topic bus over LISTEN/NOTIFY.
@dbx-tools/search	Node and AppKit	Extensions for AppKit’s beta AI Search plugin: agent tools, federated search, index lifecycle helpers, and an AppKit-compatible Lakebase full-text provider.
@dbx-tools/teams	Node and AppKit	Server-side Microsoft Teams Adaptive Card runtime, agent tool, and AppKit plugin.
@dbx-tools/tunnel	Node and AppKit	Front an app with a public Portr and/or FRP tunnel and the passwordless @dbx-tools/auth-gate gate, in-process.
dbx-tools-graphiti	Python	Run Graphiti REST, MCP, model routing, and PostgreSQL-backed graph memory from one Python runtime. It can use embedded PostgreSQL for local persistence or an external PostgreSQL/Lakebase database.
dbx-tools-node-runtime	Python	Run PythonMonkey-based packages in managed Python environments that do not provide system Node.js or npm.
@dbx-tools/shared-auth	Shared Contracts	Keep passwordless sign-in, passkey controls, and Databricks profile selectors consistent across browser and server packages. The package provides shared schemas for validating responses at the network boundary plus browser helpers that work with @dbx-tools/auth-gate.
@dbx-tools/shared-core	Shared Contracts	Browser-safe utility base for @dbx-tools/* packages.
@dbx-tools/shared-databricks-sandbox	Shared Contracts	Browser-safe Zod contracts for Databricks Sandbox machines, services, commands, and persisted Projects.
@dbx-tools/shared-email	Shared Contracts	Browser-safe email sending schemas and inferred types.
@dbx-tools/shared-email-template	Shared Contracts	Universal React Email presentation shared by dbx-tools server and browser email surfaces.
@dbx-tools/shared-fs	Shared Contracts	Browser-safe filesystem contract and abstract base for rooted storage backends.
@dbx-tools/shared-genie	Shared Contracts	Browser-safe Genie schemas, event vocabulary, and snapshot diff helpers.
@dbx-tools/shared-genie-code	Shared Contracts	Browser-safe configuration for the managed Genie Code CLI and its local model-gateway sidecar.
@dbx-tools/shared-graphiti	Shared Contracts	Use the same browser-safe Graphiti options from Node, AppKit, browser tools, and other JavaScript callers. The package applies defaults, validates values, and parses environment-shaped records.
@dbx-tools/shared-mastra	Shared Contracts	Browser-safe contract for the AppKit Mastra plugin.
@dbx-tools/shared-model	Shared Contracts	Browser-safe model-selection contracts let UIs, routes, tools, and tests validate model lookups and type ranked model responses without importing Databricks clients. Server-side normalization, classification, ranking, and fuzzy resolution live in @dbx-tools/model.
@dbx-tools/shared-model-gateway	Shared Contracts	Discover the models exposed by a dbx-tools model gateway from browser, edge, or shared application code. The package validates successful and error responses at the network boundary and provides the protocol contracts needed to build model pickers without importing Node or AppKit runtime code.
@dbx-tools/shared-search	Shared Contracts	Browser-safe schemas and extension types for AppKit-compatible AI Search providers.
@dbx-tools/shared-teams	Shared Contracts	Browser-safe Adaptive Card and Bot Framework activity schemas (plus inferred types) for the Teams add-on.
@dbx-tools/ui	React UI	Use one tree-shakeable React package for the shared AppKit UI foundation, branding, passwordless authentication, email surfaces, and AI Search controls. Mastra chat and Teams Adaptive Cards remain separate packages because they have larger optional dependency families.
@dbx-tools/ui-databricks-sandbox	React UI	React controls for assigned Databricks Sandboxes and persisted Projects.
@dbx-tools/ui-mastra	React UI	React chat UI for the AppKit-Mastra plugin.
@dbx-tools/ui-teams	React UI	React surface for the Teams add-on: render Microsoft Teams Adaptive Cards in the browser with the adaptivecards JavaScript renderer.