@sanity/runtime-cli 17.3.2 → 17.4.0-blueprinit.g596ac51

package/oclif.manifest.json

@@ -1,5 +1,134 @@
 {
   "commands": {
+    "blueprinit": {
+      "aliases": [],
+      "args": {},
+      "description": "Scaffolds a Blueprint, Studio, and starter function around an existing Sanity project.\n\nThis hidden command is an experiment; its interface and generated files are not stable.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --yes",
+        "<%= config.bin %> <%= command.id %> --project-id <id> --dataset <name> --yes"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "path": {
+          "aliases": [
+            "blueprint-path"
+          ],
+          "char": "p",
+          "description": "Path to a Blueprint file or directory containing one",
+          "env": "SANITY_BLUEPRINT_PATH",
+          "hidden": true,
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "trace": {
+          "description": "Trace output",
+          "hidden": true,
+          "name": "trace",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "validate-resources": {
+          "description": "Validate resources",
+          "hidden": true,
+          "name": "validate-resources",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "verbose": {
+          "description": "Verbose output",
+          "hidden": true,
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "llms": {
+          "aliases": [
+            "skill"
+          ],
+          "description": "Show agent-oriented guidance for this command",
+          "hidden": true,
+          "name": "llms",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "yes": {
+          "char": "y",
+          "description": "Skip confirmation prompts",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "organization-id": {
+          "aliases": [
+            "organization",
+            "organizationId",
+            "org"
+          ],
+          "description": "Organization to use when the account has several",
+          "name": "organization-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "project-id": {
+          "aliases": [
+            "project",
+            "projectId"
+          ],
+          "description": "Project to use when the organization has several",
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dataset": {
+          "description": "Dataset to attach",
+          "name": "dataset",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "stack-name": {
+          "description": "Name for the new organization-scoped Stack",
+          "name": "stack-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "studio-name": {
+          "description": "Name and hosted slug for the Studio resource",
+          "name": "studio-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "blueprinit",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Experimental blueprints-first project init",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "blueprinit.js"
+      ]
+    },
     "blueprints:add": {
       "aliases": [],
       "args": {
@@ -373,7 +502,7 @@
     "blueprints:deploy": {
       "aliases": [],
       "args": {},
-      "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 60-second timeout for processing resource assets.\n\nExit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
+      "description": "Applies your local Blueprint to the remote Stack, creating, updating, or removing resources as needed. This is the primary command for applying infrastructure changes.\n\nBefore deploying, run 'blueprints plan' to preview changes. After deployment, use 'blueprints info' to verify Stack status or 'blueprints logs' to monitor activity.\n\nUse --no-wait to queue the deployment and return immediately without waiting for completion.\n\nUse --fn-installer to force which package manager to use when deploying functions.\n\nSet SANITY_ASSET_TIMEOUT (seconds) to override the 180-second timeout for processing resource assets.\n\nSet SANITY_ASSET_CONCURRENCY to override how many resource assets are processed at once (default 4).\n\nExit codes: 0 deployed, 2 deployment failed, 75 deployment accepted but completion could not be confirmed (rerun 'blueprints info' to check).",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --message \"Enable staging dataset\"",
@@ -491,6 +620,17 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "configure": {
+          "aliases": [
+            "config",
+            "init"
+          ],
+          "description": "Configure the local Blueprint interactively before deploying",
+          "hidden": true,
+          "name": "configure",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "new-stack-name": {
           "description": "Set a new name for the Stack",
           "name": "new-stack-name",
@@ -618,9 +758,7 @@
           "type": "option"
         },
         "force": {
-          "aliases": [
-            "f"
-          ],
+          "char": "f",
           "description": "Force Stack destruction (skip confirmation)",
           "name": "force",
           "allowNo": false,
@@ -770,8 +908,8 @@
           "type": "boolean"
         },
         "verbose": {
-          "description": "Verbose output",
-          "hidden": true,
+          "char": "v",
+          "description": "Show resource and external IDs",
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
@@ -844,7 +982,7 @@
           "name": "dir"
         }
       },
-      "description": "A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions, etc.). A Stack is the remote deployment target where your Blueprint is applied.\n[NOTE: Currently, accounts are limited to three (3) Stacks per project scope.]\n\nThis is typically the first command you run in a new project. It creates a local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.\nAdditionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. This is .gitignored by default.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.\n\nRunning without a directory prompts to confirm the current directory. Run 'blueprints init .' to initialize in the current directory without a prompt.",
+      "description": "A Blueprint is your local infrastructure-as-code configuration that defines Sanity resources (datasets, functions, etc.). A Stack is the remote deployment target where your Blueprint is applied.\n\nThis is typically the first command you run in a new project. It creates a local Blueprint manifest file (sanity.blueprint.ts, .js, or .json) and provisions a new remote Stack.\nAdditionally, a Blueprint configuration file is created in .sanity/ containing the scope and Stack IDs. A .gitignore covering node_modules, .env, and Function build output is created or updated; the .sanity/ config itself is not ignored.\n\nAfter initialization, use 'blueprints plan' to preview changes, then 'blueprints deploy' to apply them.\n\nRunning without a directory prompts to confirm the current directory. Run 'blueprints init .' to initialize in the current directory without a prompt.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> .",
@@ -1121,6 +1259,9 @@
           ],
           "char": "w",
           "description": "Watch for new Stack logs",
+          "exclusive": [
+            "json"
+          ],
           "name": "watch",
           "allowNo": false,
           "type": "boolean"
@@ -1757,11 +1898,12 @@
           "description": "Example to use for the Function",
           "exclusive": [
             "name",
-            "fn-type",
+            "type",
             "language",
             "javascript",
-            "fn-helpers",
-            "fn-installer"
+            "helpers",
+            "installer",
+            "install"
           ],
           "name": "example",
           "hasDynamicHelp": false,
@@ -1845,9 +1987,9 @@
         },
         "install": {
           "char": "i",
-          "description": "Shortcut for --fn-installer npm",
+          "description": "Shortcut for --installer npm",
           "exclusive": [
-            "fn-installer"
+            "installer"
           ],
           "name": "install",
           "allowNo": false,
@@ -2013,9 +2155,9 @@
     "functions:dev": {
       "aliases": [],
       "args": {},
-      "description": "Runs a local, web-based development server to test your functions before deploying.\n\nOpen the emulator in your browser to interactively test your functions with the payload editor.\n\nOptionally, set the host and port with the --host and --port flags. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.",
+      "description": "Runs a local, web-based development server to test your functions before deploying.\n\nOpen the emulator in your browser to interactively test your functions with the payload editor.\n\nOptionally, set the host and port with the --host and --port flags. Port 8974 is reserved for the emulator's live-reload WebSocket server. Function timeout can be configured with the --timeout flag.\n\nTo invoke a function with the CLI, use 'functions test'.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 8974",
+        "<%= config.bin %> <%= command.id %> --host 127.0.0.1 --port 3333",
         "<%= config.bin %> <%= command.id %> --timeout 60"
       ],
       "flags": {
@@ -2146,6 +2288,117 @@
         "dev.js"
       ]
     },
+    "functions:list": {
+      "aliases": [],
+      "args": {},
+      "description": "Lists functions deployed directly in the selected project or organization scope. The local Blueprint config supplies the scope by default.\n\nUse --project-id or --organization-id to select a scope without a local Blueprint. Organization results include organization-scoped functions only.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --verbose",
+        "<%= config.bin %> <%= command.id %> --project-id <projectId>",
+        "<%= config.bin %> <%= command.id %> --organization-id <organizationId>",
+        "<%= config.bin %> <%= command.id %> --project-id <projectId> --json"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "path": {
+          "aliases": [
+            "blueprint-path"
+          ],
+          "char": "p",
+          "description": "Path to a Blueprint file or directory containing one",
+          "env": "SANITY_BLUEPRINT_PATH",
+          "hidden": true,
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "trace": {
+          "description": "Trace output",
+          "hidden": true,
+          "name": "trace",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "validate-resources": {
+          "description": "Validate resources",
+          "hidden": true,
+          "name": "validate-resources",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Show function configuration details",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "stack": {
+          "description": "Stack name or ID to use instead of the locally configured Stack",
+          "hidden": true,
+          "name": "stack",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "project-id": {
+          "aliases": [
+            "project",
+            "projectId"
+          ],
+          "description": "Sanity project ID used to scope Blueprint and Stack",
+          "exclusive": [
+            "organization-id"
+          ],
+          "name": "project-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "organization-id": {
+          "aliases": [
+            "organization",
+            "organizationId",
+            "org"
+          ],
+          "description": "Sanity organization ID used to scope Blueprint and Stack",
+          "exclusive": [
+            "project-id"
+          ],
+          "name": "organization-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [],
+      "id": "functions:list",
+      "pluginAlias": "@sanity/runtime-cli",
+      "pluginName": "@sanity/runtime-cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "List deployed Sanity Functions",
+      "enableJsonFlag": true,
+      "needs": [
+        "scope"
+      ],
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "functions",
+        "list.js"
+      ]
+    },
     "functions:logs": {
       "aliases": [],
       "args": {
@@ -2288,6 +2541,9 @@
           ],
           "char": "w",
           "description": "Watch for new logs (streaming mode)",
+          "exclusive": [
+            "json"
+          ],
           "name": "watch",
           "allowNo": false,
           "type": "boolean"
@@ -2998,5 +3254,5 @@
       ]
     }
   },
-  "version": "17.3.2"
+  "version": "17.4.0-blueprinit.g596ac51"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.3.2",
+  "version": "17.4.0-blueprinit.g596ac51",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -26,6 +26,8 @@
   "files": [
     "./bin",
     "./dist",
+    "./SKILL.md",
+    "./skills",
     "./oclif.manifest.json"
   ],
   "bin": {
@@ -48,7 +50,7 @@
     "lint:fix": "npm run lint:write",
     "prepare": "npm run build",
     "postpack": "shx rm -f oclif.manifest.json",
-    "test": "vitest run && npm run test:depmgmt && npm run lint",
+    "test": "npm run typecheck && vitest run && npm run test:depmgmt && npm run lint",
     "test:depmgmt": "vitest run --config ./test-depmgmt/vitest.config.ts",
     "test:coverage": "vitest run --coverage --coverage.include \"runtime-cli/src/**/*\"",
     "test:scenarios": "vitest run test/scenarios",
@@ -63,19 +65,20 @@
     "@architect/hydrate": "~6.0.2",
     "@architect/inventory": "~6.1.0",
     "@inquirer/prompts": "^8.5.2",
-    "@oclif/core": "^4.13.2",
-    "@oclif/plugin-help": "^6.2.55",
+    "@oclif/core": "^4.13.3",
+    "@oclif/plugin-help": "^6.2.56",
     "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
-    "@sanity/blueprints": "^0.23.1",
+    "@sanity-labs/oclif-plugin-skills-flag": "^0.2.1",
+    "@sanity/blueprints": "^0.23.2",
     "@sanity/blueprints-parser": "^0.4.0",
-    "@sanity/cli-build": "^5.0.0",
-    "@sanity/cli-core": "^2.5.1",
-    "@sanity/client": "^7.25.0",
+    "@sanity/cli-build": "^5.1.0",
+    "@sanity/cli-core": "^2.8.1",
+    "@sanity/client": "^7.26.2",
     "adm-zip": "^0.6.0",
     "array-treeify": "^0.1.5",
     "cardinal": "^2.1.1",
     "empathic": "^2.0.1",
-    "eventsource": "^4.1.0",
+    "eventsource": "^4.1.1",
     "groq-js": "^2.0.0",
     "jiti": "^2.7.0",
     "mime-types": "^3.0.2",
@@ -84,20 +87,20 @@
     "strip-ansi": "^7.2.0",
     "tar-fs": "^3.1.3",
     "tar-stream": "^3.2.0",
-    "vite": "^8.1.5",
-    "ws": "^8.21.1",
+    "vite": "^8.2.1",
+    "ws": "^8.21.3",
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.5",
+    "@biomejs/biome": "2.5.7",
     "@codemirror/lang-json": "^6.0.2",
     "@codemirror/state": "^6.7.1",
     "@enhance/store": "^1.0.2",
     "@lezer/highlight": "^1.2.3",
     "@oclif/test": "^4.1.21",
-    "@playwright/test": "^1.62.0",
+    "@playwright/test": "^1.62.1",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@sanity/functions": "^1.4.0",
+    "@sanity/functions": "^1.6.0",
     "@types/adm-zip": "^0.5.8",
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",
@@ -108,10 +111,10 @@
     "@vitest/coverage-v8": "4.1.10",
     "codemirror": "^6.0.2",
     "mentoss": "^0.13.0",
-    "oclif": "^4.23.29",
+    "oclif": "^4.23.30",
     "pretty-bytes": "^7.1.1",
     "pretty-ms": "^9.3.0",
-    "rollup": "^4.62.3",
+    "rollup": "^4.62.4",
     "shx": "^0.4.0",
     "typescript": "^7.0.2",
     "vitest": "4.1.10"
@@ -121,7 +124,8 @@
     "dirname": "sanity-run",
     "commands": "./dist/commands",
     "plugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "@sanity-labs/oclif-plugin-skills-flag"
     ],
     "topicSeparator": " ",
     "topics": {
@@ -133,6 +137,16 @@
       }
     }
   },
+  "oclif-plugin-skills-flag": {
+    "flag": "skill",
+    "aliases": [
+      "agent",
+      "llm",
+      "llms",
+      "skills"
+    ],
+    "directory": "skills"
+  },
   "publishConfig": {
     "access": "public",
     "provenance": false

package/skills/_functions-build.md

@@ -0,0 +1,23 @@
+# `npx @sanity/cli functions build`
+
+Build local Functions into zip archives. This command is hidden from generated help; use it when archive artifacts are explicitly needed, not as a required step before `blueprints deploy`.
+
+## Build
+
+Build every local Function in the Blueprint:
+
+```sh
+npx @sanity/cli functions build --json
+```
+
+Build one Function into a chosen directory:
+
+```sh
+npx @sanity/cli functions build process-order --out-dir artifacts/functions --json
+```
+
+Without `--out-dir`, archives are written to `.build/` beside the Blueprint manifest. An existing archive with the same Function name is replaced.
+
+The JSON result contains `built`, `errors`, and `outDir`. A run can succeed when some Functions build and others fail, so inspect `errors` even when the exit code is zero. If every build fails, the command exits with an error.
+
+The `.gitignore` written by `blueprints init` covers `functions/**/.build/`, not the top-level `.build/` these archives land in, so exclude the output directory before committing.

package/skills/_functions-list.md

@@ -0,0 +1,28 @@
+# `npx @sanity/cli functions list`
+
+List Functions deployed in a project or organization scope. This command is hidden from generated help. Results cover the whole scope rather than one Stack; use `blueprints info` for the resources of a single Stack.
+
+## Run
+
+Use the locally configured scope:
+
+```sh
+npx @sanity/cli functions list --json
+```
+
+Select a scope explicitly when working outside a local Blueprint:
+
+```sh
+npx @sanity/cli functions list --project-id PROJECT_ID --json
+npx @sanity/cli functions list --organization-id ORGANIZATION_ID --json
+```
+
+The two flags are mutually exclusive. No Blueprint manifest is required: the scope resolves from those flags, from `SANITY_PROJECT_ID` or `SANITY_ORGANIZATION_ID`, or from `.sanity/blueprint.config.json`, and the command fails with `Missing scope` when none of them do. The scope is sent with the request, so a project and its organization return different sets: scheduled Functions are organization-scoped, every other type is project-scoped.
+
+## Read the result
+
+The JSON result contains `functions`, `scopeType`, and `scopeId`. Each entry carries `id`, `name`, `displayName`, `type`, `runtime`, `status`, `memory`, `storage`, `timeout`, `resourceType`, `resourceId`, `url`, `createdAt`, and `updatedAt`. An empty scope still emits `{"functions": []}` and exits `0`, so check the array length rather than the exit code.
+
+Default output is one line per Function with its name, ID, type, and last update time. `--verbose` (`-v`) instead prints the type, update time, memory, timeout, and event rule of each.
+
+Treat this as an inspection command. `functions logs`, `functions env add`, and `functions env remove` address a Function by its Blueprint resource name resolved through the deployed Stack, not by the `id` shown here.