@databricks/appkit-ui 0.5.3 → 0.6.0

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 (220) hide show
  1. package/CLAUDE.md +14 -3
  2. package/NOTICE.md +2 -0
  3. package/bin/appkit.js +0 -0
  4. package/dist/cli/commands/plugins-sync.js +369 -0
  5. package/dist/cli/commands/plugins-sync.js.map +1 -0
  6. package/dist/cli/commands/plugins.js +19 -0
  7. package/dist/cli/commands/plugins.js.map +1 -0
  8. package/dist/cli/index.js +2 -0
  9. package/dist/cli/index.js.map +1 -1
  10. package/dist/react/charts/area/index.d.ts +2 -2
  11. package/dist/react/charts/bar/index.d.ts +2 -2
  12. package/dist/react/charts/base.d.ts +2 -2
  13. package/dist/react/charts/base.d.ts.map +1 -1
  14. package/dist/react/charts/create-chart.d.ts +2 -2
  15. package/dist/react/charts/create-chart.d.ts.map +1 -1
  16. package/dist/react/charts/heatmap/index.d.ts +2 -2
  17. package/dist/react/charts/line/index.d.ts +2 -2
  18. package/dist/react/charts/pie/index.d.ts +3 -3
  19. package/dist/react/charts/radar/index.d.ts +2 -2
  20. package/dist/react/charts/scatter/index.d.ts +2 -2
  21. package/dist/react/charts/wrapper.d.ts +2 -2
  22. package/dist/react/charts/wrapper.d.ts.map +1 -1
  23. package/dist/react/table/data-table.d.ts +2 -2
  24. package/dist/react/table/data-table.d.ts.map +1 -1
  25. package/dist/react/ui/accordion.d.ts +5 -5
  26. package/dist/react/ui/accordion.d.ts.map +1 -1
  27. package/dist/react/ui/alert-dialog.d.ts +12 -12
  28. package/dist/react/ui/alert-dialog.d.ts.map +1 -1
  29. package/dist/react/ui/alert.d.ts +6 -6
  30. package/dist/react/ui/alert.d.ts.map +1 -1
  31. package/dist/react/ui/aspect-ratio.d.ts +2 -2
  32. package/dist/react/ui/avatar.d.ts +4 -4
  33. package/dist/react/ui/badge.d.ts +4 -4
  34. package/dist/react/ui/breadcrumb.d.ts +8 -8
  35. package/dist/react/ui/button-group.d.ts +6 -6
  36. package/dist/react/ui/button.d.ts +5 -5
  37. package/dist/react/ui/calendar.d.ts +3 -3
  38. package/dist/react/ui/card.d.ts +8 -8
  39. package/dist/react/ui/carousel.d.ts +6 -6
  40. package/dist/react/ui/chart.d.ts +5 -5
  41. package/dist/react/ui/checkbox.d.ts +2 -2
  42. package/dist/react/ui/collapsible.d.ts +4 -4
  43. package/dist/react/ui/command.d.ts +10 -10
  44. package/dist/react/ui/context-menu.d.ts +16 -16
  45. package/dist/react/ui/dialog.d.ts +11 -11
  46. package/dist/react/ui/dialog.d.ts.map +1 -1
  47. package/dist/react/ui/drawer.d.ts +11 -11
  48. package/dist/react/ui/drawer.d.ts.map +1 -1
  49. package/dist/react/ui/dropdown-menu.d.ts +16 -16
  50. package/dist/react/ui/empty.d.ts +9 -9
  51. package/dist/react/ui/field.d.ts +13 -13
  52. package/dist/react/ui/form.d.ts +7 -7
  53. package/dist/react/ui/hover-card.d.ts +4 -4
  54. package/dist/react/ui/input-group.d.ts +11 -11
  55. package/dist/react/ui/input-group.d.ts.map +1 -1
  56. package/dist/react/ui/input-otp.d.ts +5 -5
  57. package/dist/react/ui/input.d.ts +2 -2
  58. package/dist/react/ui/item.d.ts +11 -11
  59. package/dist/react/ui/kbd.d.ts +3 -3
  60. package/dist/react/ui/label.d.ts +2 -2
  61. package/dist/react/ui/menubar.d.ts +17 -17
  62. package/dist/react/ui/navigation-menu.d.ts +9 -9
  63. package/dist/react/ui/pagination.d.ts +8 -8
  64. package/dist/react/ui/popover.d.ts +5 -5
  65. package/dist/react/ui/progress.d.ts +2 -2
  66. package/dist/react/ui/radio-group.d.ts +3 -3
  67. package/dist/react/ui/resizable.d.ts +4 -4
  68. package/dist/react/ui/scroll-area.d.ts +3 -3
  69. package/dist/react/ui/select.d.ts +11 -11
  70. package/dist/react/ui/separator.d.ts +2 -2
  71. package/dist/react/ui/sheet.d.ts +9 -9
  72. package/dist/react/ui/sidebar.d.ts +24 -24
  73. package/dist/react/ui/skeleton.d.ts +2 -2
  74. package/dist/react/ui/slider.d.ts +2 -2
  75. package/dist/react/ui/sonner.d.ts +2 -2
  76. package/dist/react/ui/spinner.d.ts +2 -2
  77. package/dist/react/ui/switch.d.ts +2 -2
  78. package/dist/react/ui/table.d.ts +9 -9
  79. package/dist/react/ui/tabs.d.ts +5 -5
  80. package/dist/react/ui/textarea.d.ts +2 -2
  81. package/dist/react/ui/toggle-group.d.ts +3 -3
  82. package/dist/react/ui/toggle.d.ts +2 -2
  83. package/dist/react/ui/tooltip.d.ts +5 -5
  84. package/dist/react/ui/tooltip.d.ts.map +1 -1
  85. package/docs/docs/api/appkit/Class.AppKitError/index.html +5 -5
  86. package/docs/docs/api/appkit/Class.AuthenticationError/index.html +4 -4
  87. package/docs/docs/api/appkit/Class.ConfigurationError/index.html +4 -4
  88. package/docs/docs/api/appkit/Class.ConnectionError/index.html +4 -4
  89. package/docs/docs/api/appkit/Class.ExecutionError/index.html +4 -4
  90. package/docs/docs/api/appkit/Class.InitializationError/index.html +4 -4
  91. package/docs/docs/api/appkit/Class.Plugin/index.html +28 -16
  92. package/docs/docs/api/appkit/Class.Plugin.md +90 -30
  93. package/docs/docs/api/appkit/Class.ResourceRegistry/index.html +150 -0
  94. package/docs/docs/api/appkit/Class.ResourceRegistry.md +301 -0
  95. package/docs/docs/api/appkit/Class.ServerError/index.html +5 -5
  96. package/docs/docs/api/appkit/Class.TunnelError/index.html +4 -4
  97. package/docs/docs/api/appkit/Class.ValidationError/index.html +4 -4
  98. package/docs/docs/api/appkit/Enumeration.ResourceType/index.html +66 -0
  99. package/docs/docs/api/appkit/Enumeration.ResourceType.md +135 -0
  100. package/docs/docs/api/appkit/Function.appKitTypesPlugin/index.html +4 -4
  101. package/docs/docs/api/appkit/Function.createApp/index.html +4 -4
  102. package/docs/docs/api/appkit/Function.getExecutionContext/index.html +5 -5
  103. package/docs/docs/api/appkit/Function.getPluginManifest/index.html +26 -0
  104. package/docs/docs/api/appkit/Function.getPluginManifest.md +24 -0
  105. package/docs/docs/api/appkit/Function.getResourceRequirements/index.html +28 -0
  106. package/docs/docs/api/appkit/Function.getResourceRequirements.md +42 -0
  107. package/docs/docs/api/appkit/Function.isSQLTypeMarker/index.html +5 -5
  108. package/docs/docs/api/appkit/Interface.BasePluginConfig/index.html +4 -4
  109. package/docs/docs/api/appkit/Interface.CacheConfig/index.html +4 -4
  110. package/docs/docs/api/appkit/Interface.ITelemetry/index.html +5 -5
  111. package/docs/docs/api/appkit/Interface.PluginManifest/index.html +63 -0
  112. package/docs/docs/api/appkit/Interface.PluginManifest.md +135 -0
  113. package/docs/docs/api/appkit/Interface.ResourceEntry/index.html +83 -0
  114. package/docs/docs/api/appkit/Interface.ResourceEntry.md +156 -0
  115. package/docs/docs/api/appkit/Interface.ResourceFieldEntry/index.html +26 -0
  116. package/docs/docs/api/appkit/Interface.ResourceFieldEntry.md +25 -0
  117. package/docs/docs/api/appkit/Interface.ResourceRequirement/index.html +51 -0
  118. package/docs/docs/api/appkit/Interface.ResourceRequirement.md +84 -0
  119. package/docs/docs/api/appkit/Interface.StreamExecutionSettings/index.html +5 -5
  120. package/docs/docs/api/appkit/Interface.TelemetryConfig/index.html +5 -5
  121. package/docs/docs/api/appkit/Interface.ValidationResult/index.html +29 -0
  122. package/docs/docs/api/appkit/Interface.ValidationResult.md +36 -0
  123. package/docs/docs/api/appkit/TypeAlias.ConfigSchema/index.html +21 -0
  124. package/docs/docs/api/appkit/TypeAlias.ConfigSchema.md +12 -0
  125. package/docs/docs/api/appkit/TypeAlias.IAppRouter/index.html +5 -5
  126. package/docs/docs/api/appkit/TypeAlias.ResourcePermission/index.html +18 -0
  127. package/docs/docs/api/appkit/TypeAlias.ResourcePermission.md +20 -0
  128. package/docs/docs/api/appkit/Variable.sql/index.html +5 -5
  129. package/docs/docs/api/appkit/index.html +10 -8
  130. package/docs/docs/api/appkit-ui/data/AreaChart/index.html +3 -3
  131. package/docs/docs/api/appkit-ui/data/BarChart/index.html +3 -3
  132. package/docs/docs/api/appkit-ui/data/DataTable/index.html +3 -3
  133. package/docs/docs/api/appkit-ui/data/DonutChart/index.html +3 -3
  134. package/docs/docs/api/appkit-ui/data/HeatmapChart/index.html +3 -3
  135. package/docs/docs/api/appkit-ui/data/LineChart/index.html +3 -3
  136. package/docs/docs/api/appkit-ui/data/PieChart/index.html +3 -3
  137. package/docs/docs/api/appkit-ui/data/RadarChart/index.html +3 -3
  138. package/docs/docs/api/appkit-ui/data/ScatterChart/index.html +3 -3
  139. package/docs/docs/api/appkit-ui/index.html +3 -3
  140. package/docs/docs/api/appkit-ui/styling/index.html +3 -3
  141. package/docs/docs/api/appkit-ui/ui/Accordion/index.html +3 -3
  142. package/docs/docs/api/appkit-ui/ui/Alert/index.html +3 -3
  143. package/docs/docs/api/appkit-ui/ui/AlertDialog/index.html +3 -3
  144. package/docs/docs/api/appkit-ui/ui/AspectRatio/index.html +3 -3
  145. package/docs/docs/api/appkit-ui/ui/Avatar/index.html +3 -3
  146. package/docs/docs/api/appkit-ui/ui/Badge/index.html +3 -3
  147. package/docs/docs/api/appkit-ui/ui/Breadcrumb/index.html +3 -3
  148. package/docs/docs/api/appkit-ui/ui/Button/index.html +3 -3
  149. package/docs/docs/api/appkit-ui/ui/ButtonGroup/index.html +3 -3
  150. package/docs/docs/api/appkit-ui/ui/Calendar/index.html +3 -3
  151. package/docs/docs/api/appkit-ui/ui/Card/index.html +3 -3
  152. package/docs/docs/api/appkit-ui/ui/Carousel/index.html +3 -3
  153. package/docs/docs/api/appkit-ui/ui/ChartContainer/index.html +3 -3
  154. package/docs/docs/api/appkit-ui/ui/Checkbox/index.html +3 -3
  155. package/docs/docs/api/appkit-ui/ui/Collapsible/index.html +3 -3
  156. package/docs/docs/api/appkit-ui/ui/Command/index.html +3 -3
  157. package/docs/docs/api/appkit-ui/ui/ContextMenu/index.html +3 -3
  158. package/docs/docs/api/appkit-ui/ui/Dialog/index.html +3 -3
  159. package/docs/docs/api/appkit-ui/ui/Drawer/index.html +3 -3
  160. package/docs/docs/api/appkit-ui/ui/DropdownMenu/index.html +3 -3
  161. package/docs/docs/api/appkit-ui/ui/Empty/index.html +3 -3
  162. package/docs/docs/api/appkit-ui/ui/Field/index.html +3 -3
  163. package/docs/docs/api/appkit-ui/ui/FormControl/index.html +3 -3
  164. package/docs/docs/api/appkit-ui/ui/HoverCard/index.html +3 -3
  165. package/docs/docs/api/appkit-ui/ui/Input/index.html +3 -3
  166. package/docs/docs/api/appkit-ui/ui/InputGroup/index.html +3 -3
  167. package/docs/docs/api/appkit-ui/ui/InputOTP/index.html +3 -3
  168. package/docs/docs/api/appkit-ui/ui/Item/index.html +3 -3
  169. package/docs/docs/api/appkit-ui/ui/Kbd/index.html +3 -3
  170. package/docs/docs/api/appkit-ui/ui/Label/index.html +3 -3
  171. package/docs/docs/api/appkit-ui/ui/Menubar/index.html +3 -3
  172. package/docs/docs/api/appkit-ui/ui/NavigationMenu/index.html +3 -3
  173. package/docs/docs/api/appkit-ui/ui/Pagination/index.html +3 -3
  174. package/docs/docs/api/appkit-ui/ui/Popover/index.html +3 -3
  175. package/docs/docs/api/appkit-ui/ui/Progress/index.html +3 -3
  176. package/docs/docs/api/appkit-ui/ui/RadioGroup/index.html +3 -3
  177. package/docs/docs/api/appkit-ui/ui/ResizableHandle/index.html +3 -3
  178. package/docs/docs/api/appkit-ui/ui/ScrollArea/index.html +3 -3
  179. package/docs/docs/api/appkit-ui/ui/Select/index.html +3 -3
  180. package/docs/docs/api/appkit-ui/ui/Separator/index.html +3 -3
  181. package/docs/docs/api/appkit-ui/ui/Sheet/index.html +3 -3
  182. package/docs/docs/api/appkit-ui/ui/Sidebar/index.html +3 -3
  183. package/docs/docs/api/appkit-ui/ui/Skeleton/index.html +3 -3
  184. package/docs/docs/api/appkit-ui/ui/Slider/index.html +3 -3
  185. package/docs/docs/api/appkit-ui/ui/Spinner/index.html +3 -3
  186. package/docs/docs/api/appkit-ui/ui/Switch/index.html +3 -3
  187. package/docs/docs/api/appkit-ui/ui/Table/index.html +3 -3
  188. package/docs/docs/api/appkit-ui/ui/Tabs/index.html +3 -3
  189. package/docs/docs/api/appkit-ui/ui/Textarea/index.html +3 -3
  190. package/docs/docs/api/appkit-ui/ui/Toaster/index.html +3 -3
  191. package/docs/docs/api/appkit-ui/ui/Toggle/index.html +3 -3
  192. package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html +3 -3
  193. package/docs/docs/api/appkit-ui/ui/Tooltip/index.html +3 -3
  194. package/docs/docs/api/appkit.md +44 -28
  195. package/docs/docs/api/index.html +3 -3
  196. package/docs/docs/app-management/index.html +4 -4
  197. package/docs/docs/app-management.md +1 -1
  198. package/docs/docs/architecture/index.html +4 -4
  199. package/docs/docs/architecture.md +1 -1
  200. package/docs/docs/category/development/index.html +4 -4
  201. package/docs/docs/category/development.md +1 -1
  202. package/docs/docs/configuration/index.html +3 -3
  203. package/docs/docs/core-principles/index.html +3 -3
  204. package/docs/docs/development/ai-assisted-development/index.html +7 -35
  205. package/docs/docs/development/ai-assisted-development.md +3 -52
  206. package/docs/docs/development/index.html +5 -5
  207. package/docs/docs/development/llm-guide/index.html +3 -3
  208. package/docs/docs/development/local-development/index.html +5 -5
  209. package/docs/docs/development/local-development.md +2 -2
  210. package/docs/docs/development/project-setup/index.html +3 -3
  211. package/docs/docs/development/remote-bridge/index.html +4 -4
  212. package/docs/docs/development/remote-bridge.md +1 -1
  213. package/docs/docs/development/type-generation/index.html +3 -3
  214. package/docs/docs/development.md +2 -2
  215. package/docs/docs/index.html +5 -20
  216. package/docs/docs/plugins/index.html +18 -8
  217. package/docs/docs/plugins.md +82 -4
  218. package/docs/docs.md +1 -32
  219. package/llms.txt +14 -3
  220. package/package.json +3 -1
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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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
@@ -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">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>
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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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
@@ -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">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>
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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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
@@ -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">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>
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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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
@@ -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">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>
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.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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>
package/docs/docs/development/remote-bridge.md CHANGED
@@ -4,7 +4,7 @@
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
9
  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.
10
10
 
package/docs/docs/development/type-generation/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">Type generation | 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/type-generation"><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="Type generation | AppKit"><meta data-rh="true" name="description" content="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI."><meta data-rh="true" property="og:description" content="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI."><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/type-generation"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/type-generation" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/type-generation" 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":"Type generation","item":"https://databricks.github.io/appkit/docs/development/type-generation"}]}</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">Type generation | 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/type-generation"><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="Type generation | AppKit"><meta data-rh="true" name="description" content="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI."><meta data-rh="true" property="og:description" content="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI."><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/type-generation"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/type-generation" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/development/type-generation" 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":"Type generation","item":"https://databricks.github.io/appkit/docs/development/type-generation"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.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.md CHANGED
@@ -6,14 +6,14 @@ AppKit provides multiple development workflows to suit different needs: local de
6
6
 
7
7
  * [Node.js](https://nodejs.org) v22+ environment with `npm`
8
8
  * 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).
9
- * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](/appkit/docs.md#quick-start-options) for more details.
9
+ * A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
10
10
 
11
11
  ## Development flows[​](#development-flows "Direct link to Development flows")
12
12
 
13
13
  There are multiple supported development flows available with AppKit:
14
14
 
15
15
  1. **[Local development](/appkit/docs/development/local-development.md)**: 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.
16
- 2. **[AI-assisted development](/appkit/docs/development/ai-assisted-development.md)**: Use an AI coding assistant connected via the Databricks MCP server to explore data, run CLI commands, and scaffold your app interactively.
16
+ 2. **[AI-assisted development](/appkit/docs/development/ai-assisted-development.md)**: Use an AI coding assistant to explore data, run CLI commands, and scaffold your app interactively.
17
17
  3. **[Remote Bridge](/appkit/docs/development/remote-bridge.md)**: 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.
18
18
 
19
19
  ## See also[​](#see-also "Direct link to See also")
package/docs/docs/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">Getting started | 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/"><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="Getting started | AppKit"><meta data-rh="true" name="description" content="Learn how to get started with AppKit."><meta data-rh="true" property="og:description" content="Learn how to get started with 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/"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Getting started","item":"https://databricks.github.io/appkit/docs/"}]}</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">Getting started | 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/"><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="Getting started | AppKit"><meta data-rh="true" name="description" content="Learn how to get started with AppKit."><meta data-rh="true" property="og:description" content="Learn how to get started with 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/"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Getting started","item":"https://databricks.github.io/appkit/docs/"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -29,22 +29,7 @@
29
29
  <li class=""><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer" class="">Node.js</a> v22+ environment with <code>npm</code></li>
30
30
  <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>
31
31
  </ul>
32
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="quick-start-options">Quick start options<a href="#quick-start-options" class="hash-link" aria-label="Direct link to Quick start options" title="Direct link to Quick start options" translate="no">​</a></h2>
33
- <p>There are two ways to get started with AppKit:</p>
34
- <ul>
35
- <li class=""><strong>AI-assisted</strong> (recommended): Use an AI coding assistant connected via the Databricks MCP server to explore data, run CLI commands, and scaffold your app interactively.</li>
36
- <li class=""><strong>Manual</strong>: Use the Databricks CLI directly to create, bootstrap, and deploy your app.</li>
37
- </ul>
38
- <p>Choose the path that best fits your workflow; both approaches produce the same kind of AppKit-based Databricks application.</p>
39
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="ai-first-quick-start">AI-first quick start<a href="#ai-first-quick-start" class="hash-link" aria-label="Direct link to AI-first quick start" title="Direct link to AI-first quick start" translate="no">​</a></h2>
40
- <p>Databricks AppKit is designed to work with AI coding assistants through the Databricks MCP server.</p>
41
- <p>Install the Databricks MCP server and configure it for use with your preferred AI assistant:</p>
42
- <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>
43
- <p>Once configured for your development environment, you can use your AI assistant to create and deploy new Databricks applications, as well as to iteratively evolve your app&#x27;s codebase.</p>
44
- <p>Just prompt your AI assistant to create a new Databricks app, such as:</p>
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 Databricks app that displays a dashboard of the nyc taxi trips dataset.</span><br></span></code></pre></div></div>
46
- <p>To learn more about the MCP server, see the <a class="" href="/appkit/docs/development/ai-assisted-development">AI-assisted development</a> documentation.</p>
47
- <h2 class="anchor anchorTargetStickyNavbar_scV4" id="manual-quick-start">Manual quick start<a href="#manual-quick-start" class="hash-link" aria-label="Direct link to Manual quick start" title="Direct link to Manual quick start" translate="no">​</a></h2>
32
+ <h2 class="anchor anchorTargetStickyNavbar_scV4" id="quick-start">Quick start<a href="#quick-start" class="hash-link" aria-label="Direct link to Quick start" title="Direct link to Quick start" translate="no">​</a></h2>
48
33
  <p>Learn how to create and deploy a sample Databricks application that uses AppKit with the Databricks CLI.</p>
49
34
  <h3 class="anchor anchorTargetStickyNavbar_scV4" id="bootstrap-a-new-databricks-app">Bootstrap a new Databricks app<a href="#bootstrap-a-new-databricks-app" class="hash-link" aria-label="Direct link to Bootstrap a new Databricks app" title="Direct link to Bootstrap a new Databricks app" translate="no">​</a></h3>
50
35
  <p>Run the following command to bootstrap the new Databricks app with AppKit:</p>
@@ -68,6 +53,6 @@
68
53
  <li class=""><strong><a class="" href="/appkit/docs/app-management">App management</a></strong>: Manage your AppKit application throughout its lifecycle using the Databricks CLI</li>
69
54
  <li class=""><strong><a class="" href="/appkit/docs/api/appkit/">API reference</a></strong>: Explore the complete API documentation</li>
70
55
  <li class=""><strong><a class="" href="/appkit/docs/core-principles">Core concepts</a></strong>: Learn about AppKit&#x27;s design principles and architecture</li>
71
- </ul></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/index.md" 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--next" href="/appkit/docs/app-management"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">App management</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#quick-start-options" class="table-of-contents__link toc-highlight">Quick start options</a></li><li><a href="#ai-first-quick-start" class="table-of-contents__link toc-highlight">AI-first quick start</a></li><li><a href="#manual-quick-start" class="table-of-contents__link toc-highlight">Manual quick start</a><ul><li><a href="#bootstrap-a-new-databricks-app" class="table-of-contents__link toc-highlight">Bootstrap a new Databricks app</a></li><li><a href="#deploy-the-app-to-databricks" class="table-of-contents__link toc-highlight">Deploy the app to Databricks</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</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>
56
+ </ul></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/index.md" 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--next" href="/appkit/docs/app-management"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">App management</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="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#quick-start" class="table-of-contents__link toc-highlight">Quick start</a><ul><li><a href="#bootstrap-a-new-databricks-app" class="table-of-contents__link toc-highlight">Bootstrap a new Databricks app</a></li><li><a href="#deploy-the-app-to-databricks" class="table-of-contents__link toc-highlight">Deploy the app to Databricks</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</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>
72
57
  </body>
73
58
  </html>