@sanity/runtime-cli 17.2.0-next.ga4b9ae7 → 17.3.0-blueprinit.gaf4f184

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.2.0-next.ga4b9ae7",
+  "version": "17.3.0-blueprinit.gaf4f184",
   "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"
@@ -76,7 +78,7 @@
     "cardinal": "^2.1.1",
     "empathic": "^2.0.1",
     "eventsource": "^4.1.0",
-    "groq-js": "^1.30.3",
+    "groq-js": "^2.0.0",
     "jiti": "^2.7.0",
     "mime-types": "^3.0.2",
     "ora": "^9.4.1",

package/skills/blueprinit.md

@@ -0,0 +1,137 @@
+# 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,
+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.
+
+## Choose the flow
+
+- **Existing Blueprint:** Exit without changes and use `blueprints config --edit` or
+  `blueprints doctor`.
+- **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>
+```
+
+Replace both placeholders with real IDs. The project must belong to the organization. Do not guess
+either value.
+
+`--yes` skips confirmation and uses `studio` as the Studio name. Without explicit IDs, an
+unattended run stops when the account has several organizations or projects. Ask the user for the
+IDs or have them run the command interactively.
+
+For interactive organization, project, confirmation, and Studio-name prompts, have the user run:
+
+```sh
+npx @sanity/runtime-cli@blueprinit blueprinit
+```
+
+There is no dataset flag. The command uses `production` when present, otherwise the first dataset
+returned for the project. 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`, `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. 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. Stop and report the partial state. Do not fabricate a
+  config file or blindly rerun: the command has no partial-failure recovery flow, and the generated
+  Blueprint makes a rerun exit as already initialized.