feat: add plugin commands by MarioCadenas · Pull Request #110 · databricks/appkit

MarioCadenas · 2026-02-18T12:56:18Z

Introduces a full suite of CLI commands under npx appkit plugin for managing plugin manifests — creating, validating, listing, syncing, and adding resources. Restructures the previous single plugins sync command into a modular command tree and strengthens the JSON schema with type-specific permission validation.

New CLI commands

plugin create — Interactive wizard (via @clack/prompts) to scaffold a new plugin with manifest, TypeScript class, and barrel exports. Supports in-repo or standalone placement, resource selection, and metadata fields.
plugin validate — Validates manifest.json or appkit.plugins.json against the JSON schema. Auto-detects schema type, reports humanized errors with actual values and expected enums.
plugin list — Lists plugins from appkit.plugins.json or scans a directory. Supports --json output for scripting.
plugin add-resource — Interactively adds a resource requirement to an existing plugin manifest.
plugin sync — Refactored from the previous plugins sync; discovers plugin manifests from packages and local imports, writes consolidated appkit.plugins.json.

Schema improvements

Type-specific permission validation: Each resource type (12 known types) now has its own permission enum enforced via allOf/if-then rules (e.g. sql_warehouse only allows CAN_MANAGE | CAN_USE).
No unknown resource types: The resourceType enum is the single source of truth — unknown types are rejected at the schema level.
Template schema deduplication: template-plugins.schema.json now $refs definitions from plugin-manifest.schema.json instead of duplicating them.

chore: fixup

pkosiec

Nice job!

(There was a lot of code to review so I focused mostly on the end-user experience, and just checked it briefly 😄 )

docs/docs/plugins.md

pkosiec · 2026-02-20T17:14:08Z

docs/static/schemas/plugin-manifest.schema.json

@@ -219,13 +201,13 @@
        },
        "alias": {


BTW IMO much clearer label would be displayName - but not sure if that's the best moment to change it 😄

docs/static/schemas/plugin-manifest.schema.json

pkosiec · 2026-02-20T18:37:00Z

packages/shared/src/cli/commands/plugin/create/resource-defaults.ts

+export const RESOURCE_TYPE_OPTIONS: ResourceTypeOption[] = [
+  { value: "secret", label: "Secret" },
+  { value: "job", label: "Job" },
+  { value: "sql_warehouse", label: "SQL Warehouse" },
+  { value: "serving_endpoint", label: "Serving Endpoint" },
+  { value: "volume", label: "Volume" },
+  { value: "vector_search_index", label: "Vector Search Index" },
+  { value: "uc_function", label: "UC Function" },
+  { value: "uc_connection", label: "UC Connection" },
+  { value: "database", label: "Database" },
+  { value: "genie_space", label: "Genie Space" },
+  { value: "experiment", label: "Experiment" },
+  { value: "app", label: "App" },
+];
+
+/** All valid permissions per resource type, aligned with the schema if/then rules. */
+export const PERMISSIONS_BY_TYPE: Record<string, string[]> = {
+  secret: ["READ", "WRITE", "MANAGE"],
+  job: ["CAN_VIEW", "CAN_MANAGE_RUN", "CAN_MANAGE"],
+  sql_warehouse: ["CAN_USE", "CAN_MANAGE"],
+  serving_endpoint: ["CAN_QUERY", "CAN_VIEW", "CAN_MANAGE"],
+  volume: ["READ_VOLUME", "WRITE_VOLUME"],
+  vector_search_index: ["SELECT"],
+  uc_function: ["EXECUTE"],
+  uc_connection: ["USE_CONNECTION"],
+  database: ["CAN_CONNECT_AND_CREATE"],
+  genie_space: ["CAN_VIEW", "CAN_RUN", "CAN_EDIT", "CAN_MANAGE"],
+  experiment: ["CAN_READ", "CAN_EDIT", "CAN_MANAGE"],
+  app: ["CAN_USE"],
+};


I don't like the fact that those resources (and sometimes permissions) are defined on:

CLI: https://github.com/databricks/cli/blob/main/libs/apps/generator/generator.go#L233 + https://github.com/databricks/cli/blob/main/libs/apps/prompt/resource_registry.go#L10

AppKit plugin-manifest schema: https://github.com/databricks/appkit/blob/main/packages/shared/src/schemas/plugin-manifest.schema.json#L92

now here, in App CLI

This becomes super difficult to maintain. When I'll be adding the postgres resource support, I'll need to update so many places (and wait for CLI release) 😶

I think we should get that from the schema: https://github.com/databricks/appkit/blob/main/packages/shared/src/schemas/plugin-manifest.schema.json - especially that we host it on docs:

appkit/docs/static/schemas/plugin-manifest.schema.json

Line 2 in 01c25e7

"$schema": "http://json-schema.org/draft-07/schema#",

yeah I agree, we already have the database resource there though, you might need to update it but it is there

database is a different resource (it's lakebase v1), in the API postgres is the Lakebase v2 - you can see that in the Databricks CLI (databricks postgres list-projects, databricks database list-database-instances)

we just need to sync with however the resource will look like in the UI and in DABs

packages/shared/src/cli/commands/plugin/create/create.ts

packages/shared/src/cli/commands/plugin/validate/validate.ts

pkosiec · 2026-02-20T18:51:47Z

packages/shared/src/cli/commands/plugin/list/list.ts

+  .option(
+    "-d, --dir <path>",
+    "Scan directory for plugin folders (each with manifest.json)",
+  )


I expected the same syntax as validate (npx appkit plugin list ../../template). By default it would use . as before.
WDYT? IMO it would be great to keep the consistency across commands.

pkosiec

LGTM

pkosiec · 2026-02-24T09:33:18Z

packages/shared/src/cli/commands/plugin/create/resource-defaults.ts

Before merge please get rid of the hardcoded definitions 🙏

on it, I thought I handled that 🤦🏻

MarioCadenas force-pushed the cli-plugin-commands branch from be88a0d to c4c2fc9 Compare February 19, 2026 08:47

MarioCadenas changed the title ~~feat: add plugin create command~~ feat: add plugin commands Feb 19, 2026

feat: add plugin create command

aeb6370

chore: fixup

MarioCadenas force-pushed the cli-plugin-commands branch 2 times, most recently from 767f200 to 34f8509 Compare February 19, 2026 17:22

chore: fixup

f593d8f

MarioCadenas force-pushed the cli-plugin-commands branch from 34f8509 to f593d8f Compare February 19, 2026 17:26

MarioCadenas added 4 commits February 19, 2026 18:42

chore: fixup

ff60caf

chore: fixup

01c25e7

chore: fixup

182bb8e

chore: fixup

1bd1f6f

MarioCadenas marked this pull request as ready for review February 20, 2026 10:27

MarioCadenas requested a review from pkosiec February 20, 2026 11:51

chore: fixup

9f60455

MarioCadenas force-pushed the cli-plugin-commands branch from a3a17fd to 9f60455 Compare February 20, 2026 12:04

pkosiec reviewed Feb 20, 2026

View reviewed changes

MarioCadenas added 2 commits February 23, 2026 17:57

chore: fixup

733b703

chore: fixup

86c4632

pkosiec approved these changes Feb 24, 2026

View reviewed changes

pkosiec reviewed Feb 24, 2026

View reviewed changes

MarioCadenas added 5 commits February 24, 2026 11:07

chore: fixup

03b5cb4

chore: fixup

7052e3d

chore: fixup

150ffe9

chore: fixup

f781450

chore: fixup

c19af8f

MarioCadenas merged commit ec5481d into main Feb 24, 2026
6 checks passed

MarioCadenas deleted the cli-plugin-commands branch February 24, 2026 10:48

Conversation

MarioCadenas commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New CLI commands

Schema improvements

Uh oh!

pkosiec left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pkosiec left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MarioCadenas commented Feb 18, 2026 •

edited

Loading