@databricks/appkit-ui 0.5.3 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. package/CLAUDE.md +2 -2
  2. package/dist/react/charts/area/index.d.ts +2 -2
  3. package/dist/react/charts/bar/index.d.ts +2 -2
  4. package/dist/react/charts/base.d.ts +2 -2
  5. package/dist/react/charts/base.d.ts.map +1 -1
  6. package/dist/react/charts/create-chart.d.ts +2 -2
  7. package/dist/react/charts/create-chart.d.ts.map +1 -1
  8. package/dist/react/charts/heatmap/index.d.ts +2 -2
  9. package/dist/react/charts/line/index.d.ts +2 -2
  10. package/dist/react/charts/options.d.ts.map +1 -1
  11. package/dist/react/charts/pie/index.d.ts +3 -3
  12. package/dist/react/charts/radar/index.d.ts +2 -2
  13. package/dist/react/charts/scatter/index.d.ts +2 -2
  14. package/dist/react/charts/wrapper.d.ts +2 -2
  15. package/dist/react/charts/wrapper.d.ts.map +1 -1
  16. package/dist/react/table/data-table.d.ts +2 -2
  17. package/dist/react/table/data-table.d.ts.map +1 -1
  18. package/dist/react/ui/accordion.d.ts +5 -5
  19. package/dist/react/ui/accordion.d.ts.map +1 -1
  20. package/dist/react/ui/alert-dialog.d.ts +12 -12
  21. package/dist/react/ui/alert-dialog.d.ts.map +1 -1
  22. package/dist/react/ui/alert.d.ts +4 -4
  23. package/dist/react/ui/alert.d.ts.map +1 -1
  24. package/dist/react/ui/aspect-ratio.d.ts +2 -2
  25. package/dist/react/ui/avatar.d.ts +4 -4
  26. package/dist/react/ui/badge.d.ts +2 -2
  27. package/dist/react/ui/breadcrumb.d.ts +8 -8
  28. package/dist/react/ui/button-group.d.ts +4 -4
  29. package/dist/react/ui/button.d.ts +2 -2
  30. package/dist/react/ui/calendar.d.ts +3 -3
  31. package/dist/react/ui/card.d.ts +8 -8
  32. package/dist/react/ui/carousel.d.ts +6 -6
  33. package/dist/react/ui/chart.d.ts +5 -5
  34. package/dist/react/ui/checkbox.d.ts +2 -2
  35. package/dist/react/ui/collapsible.d.ts +4 -4
  36. package/dist/react/ui/command.d.ts +10 -10
  37. package/dist/react/ui/context-menu.d.ts +16 -16
  38. package/dist/react/ui/dialog.d.ts +11 -11
  39. package/dist/react/ui/drawer.d.ts +11 -11
  40. package/dist/react/ui/drawer.d.ts.map +1 -1
  41. package/dist/react/ui/dropdown-menu.d.ts +16 -16
  42. package/dist/react/ui/empty.d.ts +7 -7
  43. package/dist/react/ui/field.d.ts +11 -11
  44. package/dist/react/ui/form.d.ts +7 -7
  45. package/dist/react/ui/hover-card.d.ts +4 -4
  46. package/dist/react/ui/input-group.d.ts +7 -7
  47. package/dist/react/ui/input-otp.d.ts +5 -5
  48. package/dist/react/ui/input.d.ts +2 -2
  49. package/dist/react/ui/item.d.ts +11 -11
  50. package/dist/react/ui/kbd.d.ts +3 -3
  51. package/dist/react/ui/label.d.ts +2 -2
  52. package/dist/react/ui/menubar.d.ts +17 -17
  53. package/dist/react/ui/navigation-menu.d.ts +9 -9
  54. package/dist/react/ui/pagination.d.ts +8 -8
  55. package/dist/react/ui/popover.d.ts +5 -5
  56. package/dist/react/ui/progress.d.ts +2 -2
  57. package/dist/react/ui/radio-group.d.ts +3 -3
  58. package/dist/react/ui/resizable.d.ts +4 -4
  59. package/dist/react/ui/scroll-area.d.ts +3 -3
  60. package/dist/react/ui/select.d.ts +11 -11
  61. package/dist/react/ui/separator.d.ts +2 -2
  62. package/dist/react/ui/sheet.d.ts +9 -9
  63. package/dist/react/ui/sidebar.d.ts +24 -24
  64. package/dist/react/ui/skeleton.d.ts +2 -2
  65. package/dist/react/ui/slider.d.ts +2 -2
  66. package/dist/react/ui/sonner.d.ts +2 -2
  67. package/dist/react/ui/spinner.d.ts +2 -2
  68. package/dist/react/ui/switch.d.ts +2 -2
  69. package/dist/react/ui/table.d.ts +9 -9
  70. package/dist/react/ui/tabs.d.ts +5 -5
  71. package/dist/react/ui/textarea.d.ts +2 -2
  72. package/dist/react/ui/toggle-group.d.ts +3 -3
  73. package/dist/react/ui/toggle.d.ts +2 -2
  74. package/dist/react/ui/tooltip.d.ts +5 -5
  75. package/dist/react/ui/tooltip.d.ts.map +1 -1
  76. package/docs/docs/api/appkit/Class.AppKitError/index.html +2 -2
  77. package/docs/docs/api/appkit/Class.AuthenticationError/index.html +2 -2
  78. package/docs/docs/api/appkit/Class.ConfigurationError/index.html +2 -2
  79. package/docs/docs/api/appkit/Class.ConnectionError/index.html +2 -2
  80. package/docs/docs/api/appkit/Class.ExecutionError/index.html +2 -2
  81. package/docs/docs/api/appkit/Class.InitializationError/index.html +2 -2
  82. package/docs/docs/api/appkit/Class.Plugin/index.html +2 -2
  83. package/docs/docs/api/appkit/Class.ServerError/index.html +2 -2
  84. package/docs/docs/api/appkit/Class.TunnelError/index.html +2 -2
  85. package/docs/docs/api/appkit/Class.ValidationError/index.html +2 -2
  86. package/docs/docs/api/appkit/Function.appKitTypesPlugin/index.html +2 -2
  87. package/docs/docs/api/appkit/Function.createApp/index.html +2 -2
  88. package/docs/docs/api/appkit/Function.getExecutionContext/index.html +2 -2
  89. package/docs/docs/api/appkit/Function.isSQLTypeMarker/index.html +2 -2
  90. package/docs/docs/api/appkit/Interface.BasePluginConfig/index.html +2 -2
  91. package/docs/docs/api/appkit/Interface.CacheConfig/index.html +2 -2
  92. package/docs/docs/api/appkit/Interface.ITelemetry/index.html +2 -2
  93. package/docs/docs/api/appkit/Interface.StreamExecutionSettings/index.html +2 -2
  94. package/docs/docs/api/appkit/Interface.TelemetryConfig/index.html +2 -2
  95. package/docs/docs/api/appkit/TypeAlias.IAppRouter/index.html +2 -2
  96. package/docs/docs/api/appkit/Variable.sql/index.html +2 -2
  97. package/docs/docs/api/appkit/index.html +2 -2
  98. package/docs/docs/api/appkit-ui/data/AreaChart/index.html +2 -2
  99. package/docs/docs/api/appkit-ui/data/BarChart/index.html +2 -2
  100. package/docs/docs/api/appkit-ui/data/DataTable/index.html +2 -2
  101. package/docs/docs/api/appkit-ui/data/DonutChart/index.html +2 -2
  102. package/docs/docs/api/appkit-ui/data/HeatmapChart/index.html +2 -2
  103. package/docs/docs/api/appkit-ui/data/LineChart/index.html +2 -2
  104. package/docs/docs/api/appkit-ui/data/PieChart/index.html +2 -2
  105. package/docs/docs/api/appkit-ui/data/RadarChart/index.html +2 -2
  106. package/docs/docs/api/appkit-ui/data/ScatterChart/index.html +2 -2
  107. package/docs/docs/api/appkit-ui/index.html +2 -2
  108. package/docs/docs/api/appkit-ui/styling/index.html +2 -2
  109. package/docs/docs/api/appkit-ui/ui/Accordion/index.html +2 -2
  110. package/docs/docs/api/appkit-ui/ui/Alert/index.html +2 -2
  111. package/docs/docs/api/appkit-ui/ui/AlertDialog/index.html +2 -2
  112. package/docs/docs/api/appkit-ui/ui/AspectRatio/index.html +2 -2
  113. package/docs/docs/api/appkit-ui/ui/Avatar/index.html +2 -2
  114. package/docs/docs/api/appkit-ui/ui/Badge/index.html +2 -2
  115. package/docs/docs/api/appkit-ui/ui/Breadcrumb/index.html +2 -2
  116. package/docs/docs/api/appkit-ui/ui/Button/index.html +2 -2
  117. package/docs/docs/api/appkit-ui/ui/ButtonGroup/index.html +2 -2
  118. package/docs/docs/api/appkit-ui/ui/Calendar/index.html +2 -2
  119. package/docs/docs/api/appkit-ui/ui/Card/index.html +2 -2
  120. package/docs/docs/api/appkit-ui/ui/Carousel/index.html +2 -2
  121. package/docs/docs/api/appkit-ui/ui/ChartContainer/index.html +2 -2
  122. package/docs/docs/api/appkit-ui/ui/Checkbox/index.html +2 -2
  123. package/docs/docs/api/appkit-ui/ui/Collapsible/index.html +2 -2
  124. package/docs/docs/api/appkit-ui/ui/Command/index.html +2 -2
  125. package/docs/docs/api/appkit-ui/ui/ContextMenu/index.html +2 -2
  126. package/docs/docs/api/appkit-ui/ui/Dialog/index.html +2 -2
  127. package/docs/docs/api/appkit-ui/ui/Drawer/index.html +2 -2
  128. package/docs/docs/api/appkit-ui/ui/DropdownMenu/index.html +2 -2
  129. package/docs/docs/api/appkit-ui/ui/Empty/index.html +2 -2
  130. package/docs/docs/api/appkit-ui/ui/Field/index.html +2 -2
  131. package/docs/docs/api/appkit-ui/ui/FormControl/index.html +2 -2
  132. package/docs/docs/api/appkit-ui/ui/HoverCard/index.html +2 -2
  133. package/docs/docs/api/appkit-ui/ui/Input/index.html +2 -2
  134. package/docs/docs/api/appkit-ui/ui/InputGroup/index.html +2 -2
  135. package/docs/docs/api/appkit-ui/ui/InputOTP/index.html +2 -2
  136. package/docs/docs/api/appkit-ui/ui/Item/index.html +2 -2
  137. package/docs/docs/api/appkit-ui/ui/Kbd/index.html +2 -2
  138. package/docs/docs/api/appkit-ui/ui/Label/index.html +2 -2
  139. package/docs/docs/api/appkit-ui/ui/Menubar/index.html +2 -2
  140. package/docs/docs/api/appkit-ui/ui/NavigationMenu/index.html +2 -2
  141. package/docs/docs/api/appkit-ui/ui/Pagination/index.html +2 -2
  142. package/docs/docs/api/appkit-ui/ui/Popover/index.html +2 -2
  143. package/docs/docs/api/appkit-ui/ui/Progress/index.html +2 -2
  144. package/docs/docs/api/appkit-ui/ui/RadioGroup/index.html +2 -2
  145. package/docs/docs/api/appkit-ui/ui/ResizableHandle/index.html +2 -2
  146. package/docs/docs/api/appkit-ui/ui/ScrollArea/index.html +2 -2
  147. package/docs/docs/api/appkit-ui/ui/Select/index.html +2 -2
  148. package/docs/docs/api/appkit-ui/ui/Separator/index.html +2 -2
  149. package/docs/docs/api/appkit-ui/ui/Sheet/index.html +2 -2
  150. package/docs/docs/api/appkit-ui/ui/Sidebar/index.html +2 -2
  151. package/docs/docs/api/appkit-ui/ui/Skeleton/index.html +2 -2
  152. package/docs/docs/api/appkit-ui/ui/Slider/index.html +2 -2
  153. package/docs/docs/api/appkit-ui/ui/Spinner/index.html +2 -2
  154. package/docs/docs/api/appkit-ui/ui/Switch/index.html +2 -2
  155. package/docs/docs/api/appkit-ui/ui/Table/index.html +2 -2
  156. package/docs/docs/api/appkit-ui/ui/Tabs/index.html +2 -2
  157. package/docs/docs/api/appkit-ui/ui/Textarea/index.html +2 -2
  158. package/docs/docs/api/appkit-ui/ui/Toaster/index.html +2 -2
  159. package/docs/docs/api/appkit-ui/ui/Toggle/index.html +2 -2
  160. package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html +2 -2
  161. package/docs/docs/api/appkit-ui/ui/Tooltip/index.html +2 -2
  162. package/docs/docs/api/index.html +2 -2
  163. package/docs/docs/app-management/index.html +3 -3
  164. package/docs/docs/app-management.md +1 -1
  165. package/docs/docs/architecture/index.html +2 -2
  166. package/docs/docs/category/development/index.html +3 -3
  167. package/docs/docs/category/development.md +1 -1
  168. package/docs/docs/configuration/index.html +2 -2
  169. package/docs/docs/core-principles/index.html +2 -2
  170. package/docs/docs/development/ai-assisted-development/index.html +7 -35
  171. package/docs/docs/development/ai-assisted-development.md +3 -52
  172. package/docs/docs/development/index.html +4 -4
  173. package/docs/docs/development/llm-guide/index.html +2 -2
  174. package/docs/docs/development/local-development/index.html +5 -5
  175. package/docs/docs/development/local-development.md +2 -2
  176. package/docs/docs/development/project-setup/index.html +2 -2
  177. package/docs/docs/development/remote-bridge/index.html +3 -3
  178. package/docs/docs/development/remote-bridge.md +1 -1
  179. package/docs/docs/development/type-generation/index.html +2 -2
  180. package/docs/docs/development.md +2 -2
  181. package/docs/docs/index.html +4 -19
  182. package/docs/docs/plugins/index.html +2 -2
  183. package/docs/docs.md +1 -32
  184. package/llms.txt +2 -2
  185. package/package.json +1 -1
package/docs/docs/app-management/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">App management | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/app-management"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="App management | AppKit"><meta data-rh="true" name="description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><meta data-rh="true" property="og:description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/app-management"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App management","item":"https://databricks.github.io/appkit/docs/app-management"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -19,7 +19,7 @@
19
19
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
20
20
  </ul>
21
21
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="create-app">Create app<a href="#create-app" class="hash-link" aria-label="Direct link to Create app" title="Direct link to Create app" translate="no">​</a></h2>
22
- <p>See the <a class="" href="/appkit/docs/#quick-start-options">Quick start</a> section to create a new Databricks app with AppKit installed.</p>
22
+ <p>See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> section to create a new Databricks app with AppKit installed.</p>
23
23
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="configuration">Configuration<a href="#configuration" class="hash-link" aria-label="Direct link to Configuration" title="Direct link to Configuration" translate="no">​</a></h2>
24
24
  <p>Before deploying your app, you need to configure it. See the <a class="" href="/appkit/docs/configuration">Configuration guide</a> for details on:</p>
25
25
  <ul>
package/docs/docs/app-management.md CHANGED
@@ -9,7 +9,7 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
9
9
 
10
10
  ## Create app[​](#create-app "Direct link to Create app")
11
11
 
12
- See the [Quick start](/appkit/docs.md#quick-start-options) section to create a new Databricks app with AppKit installed.
12
+ See the [Quick start](/appkit/docs.md#quick-start) section to create a new Databricks app with AppKit installed.
13
13
 
14
14
  ## Configuration[​](#configuration "Direct link to Configuration")
15
15
 
package/docs/docs/architecture/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Architecture | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/architecture"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Architecture | AppKit"><meta data-rh="true" name="description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><meta data-rh="true" property="og:description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/architecture"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Architecture","item":"https://databricks.github.io/appkit/docs/architecture"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/category/development/index.html CHANGED
@@ -4,13 +4,13 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/category/development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Development | AppKit"><meta data-rh="true" name="description" content="Guides for developing AppKit applications"><meta data-rh="true" property="og:description" content="Guides for developing AppKit applications"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/category/development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
12
12
  <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
13
  </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><link rel="preload" as="image" href="/appkit/img/logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_R3I2" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_Upl7" style="background-color:#f0f0f0;color:#000000" role="banner"><div class="announcementBarPlaceholder_Lvio"></div><div class="content_vq0X announcementBarContent_FIMQ">⚠️ AppKit is in an early development phase and is subject to change without notice. <strong>DO NOT</strong> use in production environments.</div><button type="button" aria-label="Close" class="clean-btn close closeButton_J8WU announcementBarClose_jD94"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/appkit/"><div class="navbar__logo"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--light_BgK8"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--dark_RKPt"></div><b class="navbar__title text--truncate">AppKit</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/appkit/docs/">Documentation</a><a class="navbar__item navbar__link" href="/appkit/contributing">Contributing</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_eFYw colorModeToggle_EPbi"><button class="clean-btn toggleButton_HRKp toggleButtonDisabled_bICu" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO lightToggleIcon_vxPA"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO darkToggleIcon_PZNO"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO systemToggleIcon_A7x6"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_cVhq"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper__Y_W"><div class="docsWrapper_cIfN"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_xQFv" type="button"></button><div class="docRoot_FHtD"><aside class="theme-doc-sidebar-container docSidebarContainer_dvCd"><div class="sidebarViewport_GeRf"><div class="sidebar_T8N1"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_uyE9 menuWithAnnouncementBar_Bucd"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/"><span title="Getting started" class="linkLabel_hZzm">Getting started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/app-management"><span title="App management" class="linkLabel_hZzm">App management</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/plugins"><span title="Plugins" class="linkLabel_hZzm">Plugins</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/architecture"><span title="Architecture" class="linkLabel_hZzm">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/configuration"><span title="Configuration" class="linkLabel_hZzm">Configuration</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_P6CU menu__link menu__link--sublist menu__link--active" aria-current="page" href="/appkit/docs/category/development"><span title="Development" class="categoryLinkLabel_ShmP">Development</span></a><button aria-label="Collapse sidebar category &#x27;Development&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/local-development"><span title="Local development" class="linkLabel_hZzm">Local development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/ai-assisted-development"><span title="AI-Assisted development" class="linkLabel_hZzm">AI-Assisted development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/"><span title="Development" class="linkLabel_hZzm">Development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/remote-bridge"><span title="Remote Bridge" class="linkLabel_hZzm">Remote Bridge</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/project-setup"><span title="Project setup" class="linkLabel_hZzm">Project setup</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/type-generation"><span title="Type generation" class="linkLabel_hZzm">Type generation</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/llm-guide"><span title="LLM Guide" class="linkLabel_hZzm">LLM Guide</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/core-principles"><span title="Core principles" class="linkLabel_hZzm">Core principles</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_P6CU menu__link menu__link--sublist" href="/appkit/docs/api/"><span title="API reference" class="categoryLinkLabel_ShmP">API reference</span></a><button aria-label="Expand sidebar category &#x27;API reference&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_P5br"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_XI0L"><nav class="theme-doc-breadcrumbs breadcrumbsContainer_bEIa" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/appkit/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_sma7"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Development</span></li></ul></nav><header><h1 class="title_JGm5">Development</h1><p>Guides for developing AppKit applications</p></header><article class="margin-top--lg"><section class="row"><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/local-development"><h2 class="text--truncate cardTitle_QwTc" title="Local development">📄️<!-- --> <!-- -->Local development</h2><p class="text--truncate cardDescription_W6_C" title="Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.">Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/ai-assisted-development"><h2 class="text--truncate cardTitle_QwTc" title="AI-Assisted development">📄️<!-- --> <!-- -->AI-Assisted development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).">AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/"><h2 class="text--truncate cardTitle_QwTc" title="Development">📄️<!-- --> <!-- -->Development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.">AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/remote-bridge"><h2 class="text--truncate cardTitle_QwTc" title="Remote Bridge">📄️<!-- --> <!-- -->Remote Bridge</h2><p class="text--truncate cardDescription_W6_C" title="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.">Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/project-setup"><h2 class="text--truncate cardTitle_QwTc" title="Project setup">📄️<!-- --> <!-- -->Project setup</h2><p class="text--truncate cardDescription_W6_C" title="This guide covers the recommended project structure and scaffolding for AppKit applications.">This guide covers the recommended project structure and scaffolding for AppKit applications.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/type-generation"><h2 class="text--truncate cardTitle_QwTc" title="Type generation">📄️<!-- --> <!-- -->Type generation</h2><p class="text--truncate cardDescription_W6_C" title="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.">AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/llm-guide"><h2 class="text--truncate cardTitle_QwTc" title="LLM Guide">📄️<!-- --> <!-- -->LLM Guide</h2><p class="text--truncate cardDescription_W6_C" title="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.">This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.</p></a></article></section></article><footer class="margin-top--md"><nav class="pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Local development</div></a></nav></footer></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
14
+ <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><link rel="preload" as="image" href="/appkit/img/logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_R3I2" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_Upl7" style="background-color:#f0f0f0;color:#000000" role="banner"><div class="announcementBarPlaceholder_Lvio"></div><div class="content_vq0X announcementBarContent_FIMQ">⚠️ AppKit is in an early development phase and is subject to change without notice. <strong>DO NOT</strong> use in production environments.</div><button type="button" aria-label="Close" class="clean-btn close closeButton_J8WU announcementBarClose_jD94"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/appkit/"><div class="navbar__logo"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--light_BgK8"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--dark_RKPt"></div><b class="navbar__title text--truncate">AppKit</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/appkit/docs/">Documentation</a><a class="navbar__item navbar__link" href="/appkit/contributing">Contributing</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_eFYw colorModeToggle_EPbi"><button class="clean-btn toggleButton_HRKp toggleButtonDisabled_bICu" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO lightToggleIcon_vxPA"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO darkToggleIcon_PZNO"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO systemToggleIcon_A7x6"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_cVhq"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper__Y_W"><div class="docsWrapper_cIfN"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_xQFv" type="button"></button><div class="docRoot_FHtD"><aside class="theme-doc-sidebar-container docSidebarContainer_dvCd"><div class="sidebarViewport_GeRf"><div class="sidebar_T8N1"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_uyE9 menuWithAnnouncementBar_Bucd"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/"><span title="Getting started" class="linkLabel_hZzm">Getting started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/app-management"><span title="App management" class="linkLabel_hZzm">App management</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/plugins"><span title="Plugins" class="linkLabel_hZzm">Plugins</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/architecture"><span title="Architecture" class="linkLabel_hZzm">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/configuration"><span title="Configuration" class="linkLabel_hZzm">Configuration</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_P6CU menu__link menu__link--sublist menu__link--active" aria-current="page" href="/appkit/docs/category/development"><span title="Development" class="categoryLinkLabel_ShmP">Development</span></a><button aria-label="Collapse sidebar category &#x27;Development&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/local-development"><span title="Local development" class="linkLabel_hZzm">Local development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/ai-assisted-development"><span title="AI-Assisted development" class="linkLabel_hZzm">AI-Assisted development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/"><span title="Development" class="linkLabel_hZzm">Development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/remote-bridge"><span title="Remote Bridge" class="linkLabel_hZzm">Remote Bridge</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/project-setup"><span title="Project setup" class="linkLabel_hZzm">Project setup</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/type-generation"><span title="Type generation" class="linkLabel_hZzm">Type generation</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/llm-guide"><span title="LLM Guide" class="linkLabel_hZzm">LLM Guide</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/core-principles"><span title="Core principles" class="linkLabel_hZzm">Core principles</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_P6CU menu__link menu__link--sublist" href="/appkit/docs/api/"><span title="API reference" class="categoryLinkLabel_ShmP">API reference</span></a><button aria-label="Expand sidebar category &#x27;API reference&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_P5br"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_XI0L"><nav class="theme-doc-breadcrumbs breadcrumbsContainer_bEIa" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/appkit/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_sma7"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Development</span></li></ul></nav><header><h1 class="title_JGm5">Development</h1><p>Guides for developing AppKit applications</p></header><article class="margin-top--lg"><section class="row"><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/local-development"><h2 class="text--truncate cardTitle_QwTc" title="Local development">📄️<!-- --> <!-- -->Local development</h2><p class="text--truncate cardDescription_W6_C" title="Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.">Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/ai-assisted-development"><h2 class="text--truncate cardTitle_QwTc" title="AI-Assisted development">📄️<!-- --> <!-- -->AI-Assisted development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.">AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/"><h2 class="text--truncate cardTitle_QwTc" title="Development">📄️<!-- --> <!-- -->Development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.">AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/remote-bridge"><h2 class="text--truncate cardTitle_QwTc" title="Remote Bridge">📄️<!-- --> <!-- -->Remote Bridge</h2><p class="text--truncate cardDescription_W6_C" title="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.">Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/project-setup"><h2 class="text--truncate cardTitle_QwTc" title="Project setup">📄️<!-- --> <!-- -->Project setup</h2><p class="text--truncate cardDescription_W6_C" title="This guide covers the recommended project structure and scaffolding for AppKit applications.">This guide covers the recommended project structure and scaffolding for AppKit applications.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/type-generation"><h2 class="text--truncate cardTitle_QwTc" title="Type generation">📄️<!-- --> <!-- -->Type generation</h2><p class="text--truncate cardDescription_W6_C" title="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.">AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/llm-guide"><h2 class="text--truncate cardTitle_QwTc" title="LLM Guide">📄️<!-- --> <!-- -->LLM Guide</h2><p class="text--truncate cardDescription_W6_C" title="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.">This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.</p></a></article></section></article><footer class="margin-top--md"><nav class="pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Local development</div></a></nav></footer></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
15
15
  </body>
16
16
  </html>
package/docs/docs/category/development.md CHANGED
@@ -1,3 +1,3 @@
1
1
  ## [📄️<!-- --> <!-- -->Local development](/appkit/docs/development/local-development.md)
2
2
 
3
- [Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.](/appkit/docs/development/local-development.md)
3
+ [Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.](/appkit/docs/development/local-development.md)
package/docs/docs/configuration/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Configuration | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Configuration | AppKit"><meta data-rh="true" name="description" content="This guide covers environment variables and configuration options for AppKit applications."><meta data-rh="true" property="og:description" content="This guide covers environment variables and configuration options for AppKit applications."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/configuration"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configuration","item":"https://databricks.github.io/appkit/docs/configuration"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/core-principles/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Core principles | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/core-principles"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Core principles | AppKit"><meta data-rh="true" name="description" content="Learn about the fundamental concepts and principles behind AppKit."><meta data-rh="true" property="og:description" content="Learn about the fundamental concepts and principles behind AppKit."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/core-principles"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Core principles","item":"https://databricks.github.io/appkit/docs/core-principles"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/development/ai-assisted-development/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">AI-Assisted development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/ai-assisted-development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AI-Assisted development | AppKit"><meta data-rh="true" name="description" content="AppKit integrates with AI coding assistants through the Model Context Protocol (MCP)."><meta data-rh="true" property="og:description" content="AppKit integrates with AI coding assistants through the Model Context Protocol (MCP)."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"AI-Assisted development","item":"https://databricks.github.io/appkit/docs/development/ai-assisted-development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">AI-Assisted development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/ai-assisted-development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AI-Assisted development | AppKit"><meta data-rh="true" name="description" content="AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available."><meta data-rh="true" property="og:description" content="AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/ai-assisted-development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"AI-Assisted development","item":"https://databricks.github.io/appkit/docs/development/ai-assisted-development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -16,38 +16,10 @@
16
16
  <ul>
17
17
  <li class=""><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> v22+ environment with <code>npm</code></li>
18
18
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
19
- <li class="">A new Databricks app with AppKit installed. See <a class="" href="/appkit/docs/#quick-start-options">Bootstrap a new Databricks app</a> for more details.</li>
19
+ <li class="">A new Databricks app with AppKit installed. See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> for more details.</li>
20
20
  </ul>
21
- <p>AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).</p>
22
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="installing-mcp-server">Installing MCP server<a href="#installing-mcp-server" class="hash-link" aria-label="Direct link to Installing MCP server" title="Direct link to Installing MCP server" translate="no">​</a></h2>
23
- <p>To install the Databricks MCP server for your preferred AI assistant, run:</p>
24
- <div class="language-bash codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-bash codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">databricks experimental apps-mcp install</span><br></span></code></pre></div></div>
25
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="mcp-capabilities">MCP capabilities<a href="#mcp-capabilities" class="hash-link" aria-label="Direct link to MCP capabilities" title="Direct link to MCP capabilities" translate="no">​</a></h2>
26
- <p>The MCP server exposes the following capabilities for AI assistants:</p>
27
- <ul>
28
- <li class=""><strong>Data exploration</strong>: Query catalogs, schemas, tables, and execute SQL</li>
29
- <li class=""><strong>CLI command execution</strong>: Deploy and manage apps, and run other workspace operations</li>
30
- <li class=""><strong>Workspace resource discovery</strong>: Inspect and navigate workspace resources</li>
31
- </ul>
32
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="example-prompts">Example prompts<a href="#example-prompts" class="hash-link" aria-label="Direct link to Example prompts" title="Direct link to Example prompts" translate="no">​</a></h2>
33
- <p>Here are some basic examples you can use to explore your app and workspace:</p>
34
- <ol>
35
- <li class="">Creating a new basic app</li>
36
- </ol>
37
- <div class="language-text codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-text codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">Create a new Databricks app that displays a dashboard of the users table in main.default.</span><br></span></code></pre></div></div>
38
- <ol>
39
- <li class="">Introspecting a table schema</li>
40
- </ol>
41
- <div class="language-text codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-text codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">Show me the schema of the users table in main.default.</span><br></span></code></pre></div></div>
42
- <ol>
43
- <li class="">Creating a new query</li>
44
- </ol>
45
- <div class="language-text codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-text codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">Create a new query to find users created in the last 7 days.</span><br></span></code></pre></div></div>
46
- <ol>
47
- <li class="">Deploying an app</li>
48
- </ol>
49
- <div class="language-text codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-text codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">Deploy the app to Databricks with the name &quot;my-app&quot;.</span><br></span></code></pre></div></div>
50
- <p>Possibilities are virtually endless. Ask your AI assistant to help you with your app and workspace.</p>
21
+ <p>AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.</p>
22
+ <p>In the meantime, refer to the LLM resources section below for guidance on working with AppKit in AI-assisted development environments.</p>
51
23
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="llm-resources">LLM resources<a href="#llm-resources" class="hash-link" aria-label="Direct link to LLM resources" title="Direct link to LLM resources" translate="no">​</a></h2>
52
24
  <p>AppKit provides specialized guidance files to help AI coding assistants work more effectively with the projects.</p>
53
25
  <p>If you&#x27;re building applications using AppKit packages, reference the <code>llms.txt</code> file.
@@ -56,6 +28,6 @@ There are two ways to access the documentation:</p>
56
28
  <li class="">Use the <a href="https://databricks.github.io/appkit/llms.txt" target="_blank" rel="noopener noreferrer" class="">hosted llms.txt file</a></li>
57
29
  <li class="">Use the <code>npx @databricks/appkit docs</code> command to view the documentation in the terminal.</li>
58
30
  </ol>
59
- <div class="language-bash codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-bash codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">npx @databricks/appkit docs # returns the llms.txt file content with all available documentation pages</span><br></span><span class="token-line" style="color:#000000"><span class="token plain">npx @databricks/appkit docs &lt;path&gt; # for specific documentation file</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_Z6Q_"><a href="https://github.com/databricks/appkit/edit/main/docs/docs/development/ai-assisted-development.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_kMm5" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_mnLK"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Local development</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_xfIk thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#installing-mcp-server" class="table-of-contents__link toc-highlight">Installing MCP server</a></li><li><a href="#mcp-capabilities" class="table-of-contents__link toc-highlight">MCP capabilities</a></li><li><a href="#example-prompts" class="table-of-contents__link toc-highlight">Example prompts</a></li><li><a href="#llm-resources" class="table-of-contents__link toc-highlight">LLM resources</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
31
+ <div class="language-bash codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-bash codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">npx @databricks/appkit docs # returns the llms.txt file content with all available documentation pages</span><br></span><span class="token-line" style="color:#000000"><span class="token plain">npx @databricks/appkit docs &lt;path&gt; # for specific documentation file</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_Z6Q_"><a href="https://github.com/databricks/appkit/edit/main/docs/docs/development/ai-assisted-development.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_kMm5" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_mnLK"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Local development</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Development</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_xfIk thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#llm-resources" class="table-of-contents__link toc-highlight">LLM resources</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
60
32
  </body>
61
33
  </html>
package/docs/docs/development/ai-assisted-development.md CHANGED
@@ -4,60 +4,11 @@
4
4
 
5
5
  * [Node.js](https://nodejs.org) v22+ environment with `npm`
6
6
  * Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
7
- * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](/appkit/docs.md#quick-start-options) for more details.
7
+ * A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
8
8
 
9
- AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).
9
+ AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.
10
10
 
11
- ## Installing MCP server[​](#installing-mcp-server "Direct link to Installing MCP server")
12
-
13
- To install the Databricks MCP server for your preferred AI assistant, run:
14
-
15
- ```bash
16
- databricks experimental apps-mcp install
17
-
18
- ```
19
-
20
- ## MCP capabilities[​](#mcp-capabilities "Direct link to MCP capabilities")
21
-
22
- The MCP server exposes the following capabilities for AI assistants:
23
-
24
- * **Data exploration**: Query catalogs, schemas, tables, and execute SQL
25
- * **CLI command execution**: Deploy and manage apps, and run other workspace operations
26
- * **Workspace resource discovery**: Inspect and navigate workspace resources
27
-
28
- ## Example prompts[​](#example-prompts "Direct link to Example prompts")
29
-
30
- Here are some basic examples you can use to explore your app and workspace:
31
-
32
- 1. Creating a new basic app
33
-
34
- ```text
35
- Create a new Databricks app that displays a dashboard of the users table in main.default.
36
-
37
- ```
38
-
39
- 1. Introspecting a table schema
40
-
41
- ```text
42
- Show me the schema of the users table in main.default.
43
-
44
- ```
45
-
46
- 1. Creating a new query
47
-
48
- ```text
49
- Create a new query to find users created in the last 7 days.
50
-
51
- ```
52
-
53
- 1. Deploying an app
54
-
55
- ```text
56
- Deploy the app to Databricks with the name "my-app".
57
-
58
- ```
59
-
60
- Possibilities are virtually endless. Ask your AI assistant to help you with your app and workspace.
11
+ In the meantime, refer to the LLM resources section below for guidance on working with AppKit in AI-assisted development environments.
61
12
 
62
13
  ## LLM resources[​](#llm-resources "Direct link to LLM resources")
63
14
 
package/docs/docs/development/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Development | AppKit"><meta data-rh="true" name="description" content="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends."><meta data-rh="true" property="og:description" content="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"Development","item":"https://databricks.github.io/appkit/docs/development/"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -17,13 +17,13 @@
17
17
  <ul>
18
18
  <li class=""><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> v22+ environment with <code>npm</code></li>
19
19
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
20
- <li class="">A new Databricks app with AppKit installed. See <a class="" href="/appkit/docs/#quick-start-options">Bootstrap a new Databricks app</a> for more details.</li>
20
+ <li class="">A new Databricks app with AppKit installed. See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> for more details.</li>
21
21
  </ul>
22
22
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="development-flows">Development flows<a href="#development-flows" class="hash-link" aria-label="Direct link to Development flows" title="Direct link to Development flows" translate="no">​</a></h2>
23
23
  <p>There are multiple supported development flows available with AppKit:</p>
24
24
  <ol>
25
25
  <li class=""><strong><a class="" href="/appkit/docs/development/local-development">Local development</a></strong>: Run the development server with hot reload for both UI and backend code. This is the default development flow and is suitable for most use cases.</li>
26
- <li class=""><strong><a class="" href="/appkit/docs/development/ai-assisted-development">AI-assisted development</a></strong>: Use an AI coding assistant connected via the Databricks MCP server to explore data, run CLI commands, and scaffold your app interactively.</li>
26
+ <li class=""><strong><a class="" href="/appkit/docs/development/ai-assisted-development">AI-assisted development</a></strong>: Use an AI coding assistant to explore data, run CLI commands, and scaffold your app interactively.</li>
27
27
  <li class=""><strong><a class="" href="/appkit/docs/development/remote-bridge">Remote Bridge</a></strong>: Create a remote bridge to a deployed backend while keeping your queries and UI local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</li>
28
28
  </ol>
29
29
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no">​</a></h2>
package/docs/docs/development/llm-guide/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">LLM Guide | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/llm-guide"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="LLM Guide | AppKit"><meta data-rh="true" name="description" content="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation."><meta data-rh="true" property="og:description" content="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/llm-guide"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/llm-guide" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/llm-guide" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"LLM Guide","item":"https://databricks.github.io/appkit/docs/development/llm-guide"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/development/local-development/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Local development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/local-development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Local development | AppKit"><meta data-rh="true" name="description" content="Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code."><meta data-rh="true" property="og:description" content="Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/local-development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/local-development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/local-development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"Local development","item":"https://databricks.github.io/appkit/docs/development/local-development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Local development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/local-development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Local development | AppKit"><meta data-rh="true" name="description" content="Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code."><meta data-rh="true" property="og:description" content="Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/local-development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/local-development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/local-development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"Local development","item":"https://databricks.github.io/appkit/docs/development/local-development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -16,9 +16,9 @@
16
16
  <ul>
17
17
  <li class=""><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> v22+ environment with <code>npm</code></li>
18
18
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
19
- <li class="">A new Databricks app with AppKit installed. See <a class="" href="/appkit/docs/#quick-start-options">Bootstrap a new Databricks app</a> for more details.</li>
19
+ <li class="">A new Databricks app with AppKit installed. See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> for more details.</li>
20
20
  </ul>
21
- <p>Once your app is bootstrapped according to the <a class="" href="/appkit/docs/#manual-quick-start">Manual quick start</a> guide, you can start the development server with hot reload for both UI and backend code.</p>
21
+ <p>Once your app is bootstrapped according to the <a class="" href="/appkit/docs/#quick-start">Quick start</a> guide, you can start the development server with hot reload for both UI and backend code.</p>
22
22
  <p>In the application root directory, run the following command to start the development server:</p>
23
23
  <div class="language-bash codeBlockContainer_crgn theme-code-block" style="--prism-color:#000000;--prism-background-color:#ffffff"><div class="codeBlockContent__42J"><pre tabindex="0" class="prism-code language-bash codeBlock_CnLD thin-scrollbar" style="color:#000000;background-color:#ffffff"><code class="codeBlockLines_sJEA"><span class="token-line" style="color:#000000"><span class="token plain">npm run dev</span><br></span></code></pre></div></div>
24
24
  <p>This command will start the development server with hot reload for both UI and backend code. Open the displayed URL in your browser to see the app. Modify the code in the <code>src/</code> directory to see the changes reflected in the browser.</p>
package/docs/docs/development/local-development.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  * [Node.js](https://nodejs.org) v22+ environment with `npm`
6
6
  * Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
7
- * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](/appkit/docs.md#quick-start-options) for more details.
7
+ * A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
8
8
 
9
- Once your app is bootstrapped according to the [Manual quick start](/appkit/docs.md#manual-quick-start) guide, you can start the development server with hot reload for both UI and backend code.
9
+ Once your app is bootstrapped according to the [Quick start](/appkit/docs.md#quick-start) guide, you can start the development server with hot reload for both UI and backend code.
10
10
 
11
11
  In the application root directory, run the following command to start the development server:
12
12
 
package/docs/docs/development/project-setup/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Project setup | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/project-setup"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Project setup | AppKit"><meta data-rh="true" name="description" content="This guide covers the recommended project structure and scaffolding for AppKit applications."><meta data-rh="true" property="og:description" content="This guide covers the recommended project structure and scaffolding for AppKit applications."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/project-setup"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/project-setup" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/project-setup" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"Project setup","item":"https://databricks.github.io/appkit/docs/development/project-setup"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/development/remote-bridge/index.html CHANGED
@@ -4,8 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
6
  <title data-rh="true">Remote Bridge | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/development/remote-bridge"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Remote Bridge | AppKit"><meta data-rh="true" name="description" content="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app."><meta data-rh="true" property="og:description" content="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/development/remote-bridge"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/remote-bridge" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/remote-bridge" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"},{"@type":"ListItem","position":2,"name":"Remote Bridge","item":"https://databricks.github.io/appkit/docs/development/remote-bridge"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
7
+ <script src="/appkit/assets/js/runtime~main.1638dd61.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.e55aba4f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -16,7 +16,7 @@
16
16
  <ul>
17
17
  <li class=""><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> v22+ environment with <code>npm</code></li>
18
18
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
19
- <li class="">A new Databricks app with AppKit installed. See <a class="" href="/appkit/docs/#quick-start-options">Bootstrap a new Databricks app</a> for more details.</li>
19
+ <li class="">A new Databricks app with AppKit installed. See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> for more details.</li>
20
20
  </ul>
21
21
  <p>Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</p>
22
22
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="when-to-use-remote-bridge">When to use Remote Bridge<a href="#when-to-use-remote-bridge" class="hash-link" aria-label="Direct link to When to use Remote Bridge" title="Direct link to When to use Remote Bridge" translate="no">​</a></h2>