Skip to content

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 The single dbx CLI: workspace lifecycle, Model Serving proxy, AppKit env, and a gated public tunnel.
@dbx-tools/cli-appkit-env CLI Tools CLI and formatting helpers for exporting AppKit auto-configuration results.
@dbx-tools/cli-model-proxy CLI Tools Local OpenAI-compatible proxy for Databricks Model Serving.
@dbx-tools/cli-tunnel CLI Tools Wrap any command in a public Portr, FRP, or combined tunnel fronted by @dbx-tools/auth email OTP and passkeys.
@dbx-tools/appkit Node and AppKit Node-side helpers for Databricks AppKit apps.
@dbx-tools/appkit-mastra Node and AppKit AppKit plugin and server-side toolkit for hosting Mastra agents inside a Databricks App.
@dbx-tools/appkit-web-search Node and AppKit Server-side web-search runtime, Mastra tools, and AppKit plugin.
@dbx-tools/auth Node and AppKit Passwordless authentication runtime built on Better Auth, email OTP, passkeys, and caller-provided identity policy and delivery.
@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 Generic Node-side Databricks workspace and cloud infrastructure helpers.
@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 owns 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/model Node and AppKit Workspace-aware Databricks Model Serving selection.
@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, in-process.
@dbx-tools/shared-auth Shared Contracts Browser-safe schemas and types for the dbx-tools passwordless authentication gate.
@dbx-tools/shared-core Shared Contracts Browser-safe utility base for @dbx-tools/* packages.
@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-mastra Shared Contracts Browser-safe contract for the AppKit Mastra plugin.
@dbx-tools/shared-model Shared Contracts Browser-safe model-selection contract and classifier.
@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-appkit React UI Shared React and Tailwind foundation for AppKit-oriented UI packages.
@dbx-tools/ui-auth React UI React passwordless authentication surfaces for @dbx-tools/auth.
@dbx-tools/ui-branding React UI Portable dbx tools brand assets and React/browser bindings for a validated BrandContext from @dbx-tools/shared-core.
@dbx-tools/ui-email React UI React email surfaces for AppKit chat and admin workflows.
@dbx-tools/ui-mastra React UI React chat UI for the AppKit-Mastra plugin.
@dbx-tools/ui-search React UI React search box and results for Databricks AI Search.
@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.
dbx-tools-core Python Dependency-free Python configuration and identity helpers shared by dbx-tools packages.
dbx-tools-graphiti Python Native launcher for Graphiti with local Neo4j and LiteLLM processes configured for Databricks Model Serving. It runs directly on the host without Docker, Podman, or another container runtime.
dbx-tools-litellm Python Thin LiteLLM integration for Databricks Model Serving. It adds live endpoint discovery, loose model-name resolution, and a small set of documented serving compatibility guards, then delegates to LiteLLM’s built-in Databricks provider.
dbx-tools-model Python Python contracts and runtime helpers for Databricks Model Serving. This package mirrors the reusable parts of @dbx-tools/shared-model and @dbx-tools/model without AppKit cache or Mastra dependencies.
dbx-tools-postgres Python Python Lakebase/Postgres connection setup, advisory locks, and topic fan-out for services that already hold a Databricks WorkspaceClient. This package is the Python counterpart to @dbx-tools/postgres plus @dbx-tools/appkit’s address parsing.