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

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.g0ac8878",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -26,7 +26,9 @@
   "files": [
     "./bin",
     "./dist",
-    "./oclif.manifest.json"
+    "./oclif.manifest.json",
+    "./SKILL.md",
+    "./skills"
   ],
   "bin": {
     "sanity-run": "bin/run.js"
@@ -66,11 +68,12 @@
     "@oclif/core": "^4.13.2",
     "@oclif/plugin-help": "^6.2.55",
     "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
+    "@sanity-labs/oclif-plugin-skills-flag": "^0.1.3",
     "@sanity/blueprints": "^0.23.1",
     "@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.7.1",
+    "@sanity/client": "^7.26.0",
     "adm-zip": "^0.6.0",
     "array-treeify": "^0.1.5",
     "cardinal": "^2.1.1",
@@ -89,15 +92,15 @@
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.5",
+    "@biomejs/biome": "2.5.6",
     "@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.5.0",
     "@types/adm-zip": "^0.5.8",
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",
@@ -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": {

package/skills/blueprinit.md

@@ -0,0 +1,155 @@
+# Blueprinit
+
+Use `blueprinit` to scaffold a Blueprint around an existing Sanity project. The command is
+experimental, hidden from root help, and available from the `blueprinit` npm dist-tag.
+
+Use it for demos and evaluation, not as a stable project initializer. Its flags, generated files,
+and resource model may change.
+
+## Know what it does
+
+`blueprinit` uses an existing Sanity organization, project, and dataset. It writes local Blueprint
+files, then creates an empty organization-scoped Stack. The generated Blueprint attaches the
+project and dataset and declares resources for a later deployment.
+
+It does not create an organization, project, or dataset. It does not deploy the attached resources,
+CORS origin, Studio, or Function. Those changes happen only if `blueprints deploy` is run later.
+
+## Inspect the target directory
+
+Run the command from the directory that should contain the Blueprint.
+
+Before running:
+
+1. Check the working tree and existing files. Do not discard unrelated user changes.
+2. Look for a root `sanity.blueprint.*` file. If one exists, use the existing Blueprint instead of
+   initializing again.
+3. Look for a root `sanity.config.*` file. Its presence selects the Studio adoption flow.
+4. Confirm the user asked to initialize this directory. The command writes files and creates a
+   remote Stack.
+5. Confirm the user is signed in. If needed, have them run:
+
+```sh
+npx sanity login
+```
+
+The account must have at least one organization, one project in the selected organization, and one
+dataset in the selected project.
+
+Interactive runs show the Blueprint resources, hosted Studio URL, local changes, and remote Stack
+action before the confirmation prompt. Project and dataset attachment plus CORS, Studio, and
+Function creation remain pending until a later deployment.
+
+## Choose the flow
+
+- **Existing Blueprint with a configured Stack:** Exit without changes and use
+  `blueprints config --edit` or `blueprints doctor`.
+- **Existing Blueprint without a configured Stack:** Finish setup with `blueprints init`; it can
+  connect the existing manifest without rewriting it.
+- **Root Studio config:** Adopt the Studio in place. Read literal `projectId` and `dataset` strings
+  from `sanity.config.*`, falling back to `sanity.cli.*`. Do not move the Studio.
+- **Fresh workspace:** Create a Blueprint, an npm-workspace Studio, and a starter `set-slug`
+  document function.
+
+Do not rewrite a Studio config merely to make adoption work unless the user asks. Dynamic
+`projectId` or `dataset` values built from environment variables or imports cannot be detected.
+
+For an existing Blueprint, inspect it with:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprints doctor
+```
+
+## Run unattended
+
+When the organization and project IDs are known, run this from the target directory:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprinit --yes \
+  --organization-id <organization-id> \
+  --project-id <project-id> \
+  --dataset <dataset-name>
+```
+
+Replace all placeholders with real values. The project must belong to the organization, and the
+dataset must belong to the project. Do not guess any value.
+
+`--yes` skips confirmation. Without explicit values, an unattended run stops when the account has
+several organizations, projects, or datasets. Ask the user for the missing value or have them run
+the command interactively.
+
+Use `--stack-name <name>` and `--studio-name <name>` when those generated names need to be stable.
+The command normalizes both names to lowercase kebab case. The Studio name is also its hosted slug,
+so it must be available in the target environment. Stack and Studio names must differ because they
+also name Blueprint resources.
+
+When `SANITY_INTERNAL_ENV=staging`, the generated Studio URL and CORS origin use
+`https://<studio-name>.studio.sanity.work`. Other environments use
+`https://<studio-name>.sanity.studio`.
+
+For interactive organization, project, dataset, confirmation, and Studio-name prompts, have the
+user run:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprinit
+```
+
+When the project has several datasets, the interactive command prompts for one and lists
+`production` first. Report the selected dataset from the command output.
+
+## Review the result
+
+A successful fresh run creates or updates:
+
+```text
+.
+├── .sanity/blueprint.config.json
+├── sanity.blueprint.ts
+├── package.json
+├── functions/
+│   └── set-slug/
+└── studios/
+    └── studio/
+```
+
+The command also creates or updates `.gitignore`. It preserves existing package metadata and adds
+the required npm workspaces and `@sanity/blueprints` dependency.
+
+An adopted Studio stays at the repository root. The command adds the Blueprint, Blueprint config,
+dependency, and `.gitignore` entry, but does not generate the starter Function.
+
+After the command exits:
+
+1. Confirm the output names the expected organization, project, and dataset.
+2. Confirm `.sanity/blueprint.config.json` exists. Its presence means Stack creation completed.
+3. Review `sanity.blueprint.ts`, including the Studio slug and credentialed CORS origin, plus
+   `package.json`, `.gitignore`, and the working-tree diff.
+4. Report the Stack ID and every created or modified path.
+
+Do not deploy as part of initialization unless the user separately asks for deployment. To continue
+after reviewing the scaffold, install dependencies and preview the deployment:
+
+```sh
+npm install
+npx @sanity/runtime-cli@blueprinit blueprints plan
+```
+
+Treat dependency installation and planning as separate follow-up actions when they were not part of
+the user's request.
+
+## Handle failures
+
+- **`No Sanity session found.`** Stop and ask the user to run `npx sanity login`. Authentication
+  fails before files are written.
+- **Multiple organizations or projects found.** Rerun with the matching `--organization-id` and
+  `--project-id`. Selection fails before files are written.
+- **No datasets found.** Ask the user to create or choose a project with a dataset. The command does
+  not create datasets.
+- **Could not read `projectId` and `dataset`.** The detected Studio config does not contain both
+  values as string literals. Pass explicit `--project-id` and `--dataset` values or report the config
+  file and let the user decide whether to change it.
+- **Refusing to overwrite an existing path.** Inspect the reported Studio or Function directory.
+  Do not delete or replace it without the user's direction.
+- **Stack quota or duplicate-name error.** Local scaffold files may already exist while
+  `.sanity/blueprint.config.json` does not. Resolve the Stack error, then run the recovery command
+  printed by `blueprinit`. It uses `blueprints init` to connect the existing manifest.