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

# App management

Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps.

## Prerequisites​

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

## Create app​

See the Quick start section to create a new Databricks app with AppKit installed.

## Configuration​

Before deploying your app, you need to configure it. See the Configuration guide for details on:

- `app.yaml` configuration and command specification
- Environment variables and SQL warehouse binding
- Local development authentication options

## Deploy app​

Deploy your AppKit application using the automated deployment pipeline:

    databricks apps deploy

This command runs a complete deployment pipeline:

1. Builds the frontend (`npm run build`)
2. Deploys the bundle to the workspace
3. Runs the app

note

For all available options, run:

    databricks apps deploy --help

### Examples​

- Deploy to a specific target:

      databricks apps deploy --target prod

- Deploy with custom variables:

      databricks apps deploy --var="warehouse_id=abc123"

- Skip the build step for faster iteration:

      databricks apps deploy --skip-build

- Force deploy (override Git branch validation):

      databricks apps deploy --force

## Start app​

To start a stopped app, run:

    databricks apps start {name}

## Stop app​

Stop a running app without deleting it:

    databricks apps stop {name}

## List all apps​

    databricks apps list

## Get detailed app information​

    databricks apps get {name}

## Stream app Logs​

Stream application logs in real-time:

    databricks apps logs {name}

By default, this shows the most recent 200 log lines and exits.

> Note: For all available options, run `databricks apps logs --help`

### Examples​

- Show the last 50 log lines:

      databricks apps logs my-app --tail-lines 50

- Follow logs with a search filter:

      databricks apps logs my-app --follow --search ERROR

- Filter logs by source:

      databricks apps logs my-app --follow --source APP

- Save logs to a file:

      databricks apps logs my-app --follow --output-file app.log

- Stream logs for 5 minutes:

      databricks apps logs my-app --follow --timeout 5m

## Delete app​

Permanently delete an app:

    databricks apps delete {name}

⚠️ Warning: This action cannot be undone. All app data and configurations will be removed.

## See also​

For more information about Databricks Apps, including platform architecture, use cases, security, and advanced features, see the Databricks Apps documentation.