Skip to main content
⚠️ AppKit is in an early development phase and is subject to change without notice. DO NOT use in production environments.

# Getting started

Learn how to get started with AppKit.

## Introduction​

AppKit is a TypeScript SDK for building production-ready Databricks applications with a plugin-based architecture. It provides opinionated defaults, built-in observability, and seamless integration with Databricks services.

AppKit simplifies building data applications on Databricks by providing:

- Plugin architecture: Modular design with built-in server and analytics plugins
- Type safety: End-to-end TypeScript with automatic query type generation
- Production-ready features: Built-in caching, telemetry, retry logic, and error handling
- Developer experience: Remote hot reload, file-based queries, optimized for AI-assisted development
- Databricks native: Seamless integration with SQL Warehouses, Unity Catalog, and other workspace resources

## Prerequisites​

- Node.js v22+ environment with `npm`
- Databricks CLI (v0.287.0 or higher): install and configure it according to the official tutorial.

## Quick start​

Learn how to create and deploy a sample Databricks application that uses AppKit with the Databricks CLI.

### Bootstrap a new Databricks app​

Run the following command to bootstrap the new Databricks app with AppKit:

    databricks apps init

Follow the prompts to bootstrap the app codebase in the current working directory.

The command will guide you through the process of:

- creating a new Databricks app
- scaffolding the app codebase with selected features
- installing dependencies
- (optionally) deploying the app to Databricks
- (optionally) running the app in development mode

Learn more about the various development flows available with AppKit.

### Deploy the app to Databricks​

Run the following command to deploy the app to Databricks:

    databricks apps deploy

This deploys the sample app to Databricks.

## Next steps​

- App management: Manage your AppKit application throughout its lifecycle using the Databricks CLI
- API reference: Explore the complete API documentation
- Core concepts: Learn about AppKit's design principles and architecture