@sanity/cli 8.4.1 → 8.4.2

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.
@@ -2497,69 +2497,96 @@
2497
2497
  "list.js"
2498
2498
  ]
2499
2499
  },
2500
- "docs:browse": {
2501
- "aliases": [],
2502
- "args": {},
2503
- "description": "Open Sanity docs in your browser",
2504
- "flags": {},
2505
- "hasDynamicHelp": false,
2506
- "hiddenAliases": [],
2507
- "id": "docs:browse",
2508
- "pluginAlias": "@sanity/cli",
2509
- "pluginName": "@sanity/cli",
2510
- "pluginType": "core",
2511
- "strict": true,
2512
- "enableJsonFlag": false,
2513
- "isESM": true,
2514
- "relativePath": [
2515
- "dist",
2516
- "commands",
2517
- "docs",
2518
- "browse.js"
2519
- ]
2520
- },
2521
- "docs:read": {
2500
+ "documents:create": {
2522
2501
  "aliases": [],
2523
2502
  "args": {
2524
- "path": {
2525
- "description": "Path or URL to article, found in search results and docs content as links",
2526
- "name": "path",
2527
- "required": true
2503
+ "file": {
2504
+ "description": "JSON file to create document(s) from",
2505
+ "name": "file",
2506
+ "required": false
2528
2507
  }
2529
2508
  },
2530
- "description": "Read an article in terminal",
2509
+ "description": "Create one or more documents",
2531
2510
  "examples": [
2532
2511
  {
2533
- "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation",
2534
- "description": "Read as markdown in terminal"
2512
+ "command": "<%= config.bin %> <%= command.id %> myDocument.json",
2513
+ "description": "Create the document specified in \"myDocument.json\""
2535
2514
  },
2536
2515
  {
2537
- "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation",
2538
- "description": "Read using full URL"
2516
+ "command": "<%= config.bin %> <%= command.id %>",
2517
+ "description": "Open configured $EDITOR and create the specified document(s)"
2539
2518
  },
2540
2519
  {
2541
- "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation --web",
2542
- "description": "Open in web browser"
2520
+ "command": "<%= config.bin %> <%= command.id %> --id myDocId --replace",
2521
+ "description": "Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes"
2543
2522
  },
2544
2523
  {
2545
- "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation -w",
2546
- "description": "Open using full URL in web browser"
2524
+ "command": "<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5",
2525
+ "description": "Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax."
2526
+ },
2527
+ {
2528
+ "command": "<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123",
2529
+ "description": "Create documents in a specific project"
2547
2530
  }
2548
2531
  ],
2549
2532
  "flags": {
2550
- "web": {
2551
- "aliases": [
2552
- "w"
2553
- ],
2554
- "description": "Open in a web browser",
2555
- "name": "web",
2533
+ "project-id": {
2534
+ "char": "p",
2535
+ "description": "Project ID to create document(s) in (overrides CLI configuration)",
2536
+ "helpGroup": "OVERRIDE",
2537
+ "name": "project-id",
2538
+ "hasDynamicHelp": false,
2539
+ "helpValue": "<id>",
2540
+ "multiple": false,
2541
+ "type": "option"
2542
+ },
2543
+ "dataset": {
2544
+ "char": "d",
2545
+ "description": "Dataset to create document(s) in (overrides CLI configuration)",
2546
+ "helpGroup": "OVERRIDE",
2547
+ "name": "dataset",
2548
+ "hasDynamicHelp": false,
2549
+ "helpValue": "<name>",
2550
+ "multiple": false,
2551
+ "type": "option"
2552
+ },
2553
+ "id": {
2554
+ "description": "Specify a document ID to use. Will fetch remote document ID and populate editor.",
2555
+ "name": "id",
2556
+ "hasDynamicHelp": false,
2557
+ "multiple": false,
2558
+ "type": "option"
2559
+ },
2560
+ "json5": {
2561
+ "description": "Use JSON5 file type to allow a \"simplified\" version of JSON",
2562
+ "name": "json5",
2563
+ "allowNo": false,
2564
+ "type": "boolean"
2565
+ },
2566
+ "missing": {
2567
+ "description": "On duplicate document IDs, don't modify the target document(s)",
2568
+ "name": "missing",
2569
+ "allowNo": false,
2570
+ "type": "boolean"
2571
+ },
2572
+ "replace": {
2573
+ "description": "On duplicate document IDs, replace existing document with specified document(s)",
2574
+ "name": "replace",
2575
+ "allowNo": false,
2576
+ "type": "boolean"
2577
+ },
2578
+ "watch": {
2579
+ "description": "Write the documents whenever the target file or buffer changes",
2580
+ "name": "watch",
2556
2581
  "allowNo": false,
2557
2582
  "type": "boolean"
2558
2583
  }
2559
2584
  },
2560
2585
  "hasDynamicHelp": false,
2561
- "hiddenAliases": [],
2562
- "id": "docs:read",
2586
+ "hiddenAliases": [
2587
+ "document:create"
2588
+ ],
2589
+ "id": "documents:create",
2563
2590
  "pluginAlias": "@sanity/cli",
2564
2591
  "pluginName": "@sanity/cli",
2565
2592
  "pluginType": "core",
@@ -2568,151 +2595,147 @@
2568
2595
  "relativePath": [
2569
2596
  "dist",
2570
2597
  "commands",
2571
- "docs",
2572
- "read.js"
2598
+ "documents",
2599
+ "create.js"
2573
2600
  ]
2574
2601
  },
2575
- "docs:search": {
2602
+ "documents:delete": {
2576
2603
  "aliases": [],
2577
2604
  "args": {
2578
- "query": {
2579
- "description": "Search query for documentation",
2580
- "name": "query",
2605
+ "id": {
2606
+ "description": "Document ID to delete",
2607
+ "name": "id",
2581
2608
  "required": true
2609
+ },
2610
+ "ids": {
2611
+ "description": "Additional document IDs to delete",
2612
+ "name": "ids",
2613
+ "required": false
2582
2614
  }
2583
2615
  },
2584
- "description": "Search Sanity docs",
2616
+ "description": "Delete one or more documents from the project's configured dataset",
2585
2617
  "examples": [
2586
2618
  {
2587
- "command": "<%= config.bin %> <%= command.id %> schema",
2588
- "description": "Search for documentation about schemas"
2619
+ "command": "<%= config.bin %> <%= command.id %> myDocId",
2620
+ "description": "Delete the document with the ID \"myDocId\""
2589
2621
  },
2590
2622
  {
2591
- "command": "<%= config.bin %> <%= command.id %> \"groq functions\"",
2592
- "description": "Search with phrase"
2623
+ "command": "<%= config.bin %> <%= command.id %> 'myDocId'",
2624
+ "description": "ID wrapped in double or single quote works equally well"
2593
2625
  },
2594
2626
  {
2595
- "command": "<%= config.bin %> <%= command.id %> \"deployment\" --limit=5",
2596
- "description": "Limit search results"
2627
+ "command": "<%= config.bin %> <%= command.id %> --dataset=blog someDocId",
2628
+ "description": "Delete document with ID \"someDocId\" from dataset \"blog\""
2629
+ },
2630
+ {
2631
+ "command": "<%= config.bin %> <%= command.id %> doc1 doc2",
2632
+ "description": "Delete the document with ID \"doc1\" and \"doc2\""
2633
+ },
2634
+ {
2635
+ "command": "<%= config.bin %> <%= command.id %> myDocId --project-id abc123",
2636
+ "description": "Delete a document from a specific project"
2597
2637
  }
2598
2638
  ],
2599
2639
  "flags": {
2600
- "limit": {
2601
- "description": "Maximum number of results to return",
2602
- "name": "limit",
2603
- "default": 10,
2640
+ "project-id": {
2641
+ "char": "p",
2642
+ "description": "Project ID to delete from (overrides CLI configuration)",
2643
+ "helpGroup": "OVERRIDE",
2644
+ "name": "project-id",
2604
2645
  "hasDynamicHelp": false,
2646
+ "helpValue": "<id>",
2647
+ "multiple": false,
2648
+ "type": "option"
2649
+ },
2650
+ "dataset": {
2651
+ "char": "d",
2652
+ "description": "Dataset to delete from (overrides CLI configuration)",
2653
+ "helpGroup": "OVERRIDE",
2654
+ "name": "dataset",
2655
+ "hasDynamicHelp": false,
2656
+ "helpValue": "<name>",
2605
2657
  "multiple": false,
2606
2658
  "type": "option"
2607
2659
  }
2608
2660
  },
2609
2661
  "hasDynamicHelp": false,
2610
- "hiddenAliases": [],
2611
- "id": "docs:search",
2662
+ "hiddenAliases": [
2663
+ "document:delete"
2664
+ ],
2665
+ "id": "documents:delete",
2612
2666
  "pluginAlias": "@sanity/cli",
2613
2667
  "pluginName": "@sanity/cli",
2614
2668
  "pluginType": "core",
2615
- "strict": true,
2669
+ "strict": false,
2616
2670
  "isESM": true,
2617
2671
  "relativePath": [
2618
2672
  "dist",
2619
2673
  "commands",
2620
- "docs",
2621
- "search.js"
2674
+ "documents",
2675
+ "delete.js"
2622
2676
  ]
2623
2677
  },
2624
- "graphql:deploy": {
2678
+ "documents:get": {
2625
2679
  "aliases": [],
2626
- "args": {},
2627
- "description": "Deploy a GraphQL API from the current Sanity schema",
2680
+ "args": {
2681
+ "documentId": {
2682
+ "description": "Document ID to retrieve",
2683
+ "name": "documentId",
2684
+ "required": true
2685
+ }
2686
+ },
2687
+ "description": "Get and print a document by ID",
2628
2688
  "examples": [
2629
2689
  {
2630
- "command": "<%= config.bin %> <%= command.id %>",
2631
- "description": "Deploy all defined GraphQL APIs"
2690
+ "command": "<%= config.bin %> <%= command.id %> myDocId",
2691
+ "description": "Get the document with ID \"myDocId\""
2632
2692
  },
2633
2693
  {
2634
- "command": "<%= config.bin %> <%= command.id %> --dry-run",
2635
- "description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy"
2694
+ "command": "<%= config.bin %> <%= command.id %> myDocId --pretty",
2695
+ "description": "Get document with colorized JSON output"
2636
2696
  },
2637
2697
  {
2638
- "command": "<%= config.bin %> <%= command.id %> --api staging --api ios",
2639
- "description": "Deploy only the GraphQL APIs with the IDs \"staging\" and \"ios\""
2698
+ "command": "<%= config.bin %> <%= command.id %> myDocId --dataset production",
2699
+ "description": "Get document from a specific dataset"
2640
2700
  },
2641
2701
  {
2642
- "command": "<%= config.bin %> <%= command.id %> --playground",
2643
- "description": "Deploy all defined GraphQL APIs, overriding any playground setting"
2702
+ "command": "<%= config.bin %> <%= command.id %> myDocId --project-id abc123",
2703
+ "description": "Get a document from a specific project"
2644
2704
  }
2645
2705
  ],
2646
2706
  "flags": {
2647
- "api": {
2648
- "description": "Only deploy API with this ID (can be specified multiple times)",
2649
- "name": "api",
2650
- "hasDynamicHelp": false,
2651
- "multiple": true,
2652
- "type": "option"
2653
- },
2654
- "dataset": {
2655
- "char": "d",
2656
- "description": "Deploy API for the given dataset",
2657
- "name": "dataset",
2658
- "hasDynamicHelp": false,
2659
- "helpValue": "<name>",
2660
- "multiple": false,
2661
- "type": "option"
2662
- },
2663
- "dry-run": {
2664
- "description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy",
2665
- "name": "dry-run",
2666
- "allowNo": false,
2667
- "type": "boolean"
2668
- },
2669
- "force": {
2670
- "description": "Deploy API without confirming breaking changes",
2671
- "name": "force",
2672
- "allowNo": false,
2673
- "type": "boolean"
2674
- },
2675
- "generation": {
2676
- "description": "API generation to deploy (defaults to \"gen3\")",
2677
- "name": "generation",
2707
+ "project-id": {
2708
+ "char": "p",
2709
+ "description": "Project ID to get document from (overrides CLI configuration)",
2710
+ "helpGroup": "OVERRIDE",
2711
+ "name": "project-id",
2678
2712
  "hasDynamicHelp": false,
2713
+ "helpValue": "<id>",
2679
2714
  "multiple": false,
2680
- "options": [
2681
- "gen1",
2682
- "gen2",
2683
- "gen3"
2684
- ],
2685
2715
  "type": "option"
2686
2716
  },
2687
- "non-null-document-fields": {
2688
- "description": "Use non-null document fields (_id, _type etc)",
2689
- "name": "non-null-document-fields",
2690
- "allowNo": false,
2691
- "type": "boolean"
2692
- },
2693
- "playground": {
2694
- "description": "Enable GraphQL playground for easier debugging",
2695
- "name": "playground",
2696
- "allowNo": true,
2697
- "type": "boolean"
2698
- },
2699
- "tag": {
2700
- "description": "Deploy API(s) to given tag (defaults to \"default\")",
2701
- "name": "tag",
2717
+ "dataset": {
2718
+ "char": "d",
2719
+ "description": "Dataset to get document from (overrides CLI configuration)",
2720
+ "helpGroup": "OVERRIDE",
2721
+ "name": "dataset",
2702
2722
  "hasDynamicHelp": false,
2723
+ "helpValue": "<name>",
2703
2724
  "multiple": false,
2704
2725
  "type": "option"
2705
2726
  },
2706
- "with-union-cache": {
2707
- "description": "Cache union types (faster for schemas with many self-references)",
2708
- "name": "with-union-cache",
2727
+ "pretty": {
2728
+ "description": "Colorize JSON output",
2729
+ "name": "pretty",
2709
2730
  "allowNo": false,
2710
2731
  "type": "boolean"
2711
2732
  }
2712
2733
  },
2713
2734
  "hasDynamicHelp": false,
2714
- "hiddenAliases": [],
2715
- "id": "graphql:deploy",
2735
+ "hiddenAliases": [
2736
+ "document:get"
2737
+ ],
2738
+ "id": "documents:get",
2716
2739
  "pluginAlias": "@sanity/cli",
2717
2740
  "pluginName": "@sanity/cli",
2718
2741
  "pluginType": "core",
@@ -2721,39 +2744,95 @@
2721
2744
  "relativePath": [
2722
2745
  "dist",
2723
2746
  "commands",
2724
- "graphql",
2725
- "deploy.js"
2747
+ "documents",
2748
+ "get.js"
2726
2749
  ]
2727
2750
  },
2728
- "graphql:list": {
2751
+ "documents:query": {
2729
2752
  "aliases": [],
2730
- "args": {},
2731
- "description": "List deployed GraphQL endpoints for the project",
2753
+ "args": {
2754
+ "query": {
2755
+ "description": "GROQ query to run against the dataset",
2756
+ "name": "query",
2757
+ "required": true
2758
+ }
2759
+ },
2760
+ "description": "Query for documents",
2732
2761
  "examples": [
2733
2762
  {
2734
- "command": "<%= config.bin %> <%= command.id %>",
2735
- "description": "List GraphQL endpoints for the project"
2763
+ "command": "<%= config.bin %> <%= command.id %> '*[_type == \"movie\"][0..4]'",
2764
+ "description": "Fetch 5 documents of type \"movie\""
2736
2765
  },
2737
2766
  {
2738
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
2739
- "description": "List GraphQL endpoints for a specific project"
2767
+ "command": "<%= config.bin %> <%= command.id %> '*[_type == \"movie\"]|order(releaseDate asc)[0]{title}' --dataset staging",
2768
+ "description": "Fetch title of the oldest movie in the dataset named \"staging\""
2769
+ },
2770
+ {
2771
+ "command": "<%= config.bin %> <%= command.id %> '*[_id == \"header\"] { \"headerText\": pt::text(body) }' --api-version v2021-06-07",
2772
+ "description": "Use API version v2021-06-07 and do a query"
2773
+ },
2774
+ {
2775
+ "command": "<%= config.bin %> <%= command.id %> '*[_type == \"post\"]' --project-id abc123 --dataset production",
2776
+ "description": "Query documents in a specific project and dataset"
2740
2777
  }
2741
2778
  ],
2742
2779
  "flags": {
2743
2780
  "project-id": {
2744
2781
  "char": "p",
2745
- "description": "Project ID to list GraphQL endpoints for (overrides CLI configuration)",
2782
+ "description": "Project ID to query (overrides CLI configuration)",
2746
2783
  "helpGroup": "OVERRIDE",
2747
2784
  "name": "project-id",
2748
2785
  "hasDynamicHelp": false,
2749
2786
  "helpValue": "<id>",
2750
2787
  "multiple": false,
2751
2788
  "type": "option"
2789
+ },
2790
+ "dataset": {
2791
+ "char": "d",
2792
+ "description": "Dataset to query (overrides CLI configuration)",
2793
+ "helpGroup": "OVERRIDE",
2794
+ "name": "dataset",
2795
+ "hasDynamicHelp": false,
2796
+ "helpValue": "<name>",
2797
+ "multiple": false,
2798
+ "type": "option"
2799
+ },
2800
+ "anonymous": {
2801
+ "description": "Send the query without any authorization token",
2802
+ "name": "anonymous",
2803
+ "allowNo": false,
2804
+ "type": "boolean"
2805
+ },
2806
+ "api-version": {
2807
+ "description": "API version to use (defaults to 2025-08-15)",
2808
+ "name": "api-version",
2809
+ "hasDynamicHelp": false,
2810
+ "multiple": false,
2811
+ "type": "option"
2812
+ },
2813
+ "pretty": {
2814
+ "description": "Colorize JSON output",
2815
+ "name": "pretty",
2816
+ "allowNo": false,
2817
+ "type": "boolean"
2818
+ },
2819
+ "project": {
2820
+ "deprecated": {
2821
+ "to": "project-id"
2822
+ },
2823
+ "description": "Project ID to query",
2824
+ "hidden": true,
2825
+ "name": "project",
2826
+ "hasDynamicHelp": false,
2827
+ "multiple": false,
2828
+ "type": "option"
2752
2829
  }
2753
2830
  },
2754
2831
  "hasDynamicHelp": false,
2755
- "hiddenAliases": [],
2756
- "id": "graphql:list",
2832
+ "hiddenAliases": [
2833
+ "document:query"
2834
+ ],
2835
+ "id": "documents:query",
2757
2836
  "pluginAlias": "@sanity/cli",
2758
2837
  "pluginName": "@sanity/cli",
2759
2838
  "pluginType": "core",
@@ -2762,207 +2841,198 @@
2762
2841
  "relativePath": [
2763
2842
  "dist",
2764
2843
  "commands",
2765
- "graphql",
2766
- "list.js"
2844
+ "documents",
2845
+ "query.js"
2767
2846
  ]
2768
2847
  },
2769
- "graphql:undeploy": {
2848
+ "documents:validate": {
2770
2849
  "aliases": [],
2771
2850
  "args": {},
2772
- "description": "Remove a deployed GraphQL API",
2851
+ "description": "Validate documents in a dataset against the studio schema",
2773
2852
  "examples": [
2774
2853
  {
2775
- "command": "<%= config.bin %> <%= command.id %>",
2776
- "description": "Undeploy GraphQL API for current project and dataset"
2777
- },
2778
- {
2779
- "command": "<%= config.bin %> <%= command.id %> --api ios",
2780
- "description": "Undeploy API with ID \"ios\""
2854
+ "command": "<%= config.bin %> <%= command.id %> --workspace default",
2855
+ "description": "Validates all documents in a Sanity project with more than one workspace"
2781
2856
  },
2782
2857
  {
2783
- "command": "<%= config.bin %> <%= command.id %> --dataset staging",
2784
- "description": "Undeploy GraphQL API for staging dataset"
2858
+ "command": "<%= config.bin %> <%= command.id %> --workspace default --dataset staging",
2859
+ "description": "Override the dataset specified in the workspace"
2785
2860
  },
2786
2861
  {
2787
- "command": "<%= config.bin %> <%= command.id %> --dataset staging --tag next",
2788
- "description": "Undeploy GraphQL API for staging dataset with \"next\" tag"
2862
+ "command": "<%= config.bin %> <%= command.id %> --yes > report.txt",
2863
+ "description": "Save the results of the report into a file"
2789
2864
  },
2790
2865
  {
2791
- "command": "<%= config.bin %> <%= command.id %> --force",
2792
- "description": "Undeploy GraphQL API without confirmation prompt"
2866
+ "command": "<%= config.bin %> <%= command.id %> --level info",
2867
+ "description": "Report out info level validation markers too"
2793
2868
  },
2794
2869
  {
2795
2870
  "command": "<%= config.bin %> <%= command.id %> --project-id abc123 --dataset production",
2796
- "description": "Undeploy GraphQL API for a specific project and dataset"
2871
+ "description": "Validate documents in a specific project and dataset"
2797
2872
  }
2798
2873
  ],
2799
2874
  "flags": {
2800
2875
  "project-id": {
2801
2876
  "char": "p",
2802
- "description": "Project ID to undeploy GraphQL API from (overrides CLI configuration)",
2803
- "helpGroup": "OVERRIDE",
2877
+ "description": "Override the project ID used. By default, this is derived from the given workspace",
2804
2878
  "name": "project-id",
2805
2879
  "hasDynamicHelp": false,
2806
2880
  "helpValue": "<id>",
2807
2881
  "multiple": false,
2808
2882
  "type": "option"
2809
2883
  },
2810
- "api": {
2811
- "description": "Undeploy API with this ID",
2812
- "exclusive": [
2813
- "project-id",
2814
- "project"
2815
- ],
2816
- "name": "api",
2817
- "required": false,
2818
- "hasDynamicHelp": false,
2819
- "multiple": false,
2820
- "type": "option"
2821
- },
2822
2884
  "dataset": {
2823
2885
  "char": "d",
2824
- "description": "Dataset to undeploy GraphQL API from (overrides CLI configuration)",
2825
- "helpGroup": "OVERRIDE",
2886
+ "description": "Override the dataset used. By default, this is derived from the given workspace",
2826
2887
  "name": "dataset",
2827
2888
  "hasDynamicHelp": false,
2828
2889
  "helpValue": "<name>",
2829
2890
  "multiple": false,
2830
2891
  "type": "option"
2831
2892
  },
2832
- "force": {
2833
- "description": "Skip confirmation prompt",
2834
- "name": "force",
2835
- "required": false,
2836
- "allowNo": false,
2837
- "type": "boolean"
2893
+ "file": {
2894
+ "description": "Path to an NDJSON file or tar archive containing an NDJSON file (optionally gzip-compressed)",
2895
+ "name": "file",
2896
+ "hasDynamicHelp": false,
2897
+ "multiple": false,
2898
+ "type": "option"
2838
2899
  },
2839
- "project": {
2840
- "deprecated": {
2841
- "to": "project-id"
2842
- },
2843
- "description": "Project ID to delete GraphQL API for",
2844
- "hidden": true,
2845
- "name": "project",
2846
- "required": false,
2900
+ "format": {
2901
+ "description": "The output format used to print the found validation markers and report progress",
2902
+ "name": "format",
2847
2903
  "hasDynamicHelp": false,
2848
2904
  "multiple": false,
2905
+ "options": [
2906
+ "json",
2907
+ "ndjson",
2908
+ "pretty"
2909
+ ],
2849
2910
  "type": "option"
2850
2911
  },
2851
- "tag": {
2852
- "description": "Tag to undeploy GraphQL API from",
2853
- "name": "tag",
2854
- "required": false,
2855
- "default": "default",
2912
+ "level": {
2913
+ "description": "The minimum level reported. Defaults to warning",
2914
+ "name": "level",
2915
+ "default": "warning",
2916
+ "hasDynamicHelp": false,
2917
+ "multiple": false,
2918
+ "options": [
2919
+ "error",
2920
+ "warning",
2921
+ "info"
2922
+ ],
2923
+ "type": "option"
2924
+ },
2925
+ "max-custom-validation-concurrency": {
2926
+ "description": "Specify how many custom validators can run concurrently",
2927
+ "name": "max-custom-validation-concurrency",
2928
+ "default": 5,
2929
+ "hasDynamicHelp": false,
2930
+ "multiple": false,
2931
+ "type": "option"
2932
+ },
2933
+ "max-fetch-concurrency": {
2934
+ "description": "Specify how many `client.fetch` requests are allowed to run concurrently",
2935
+ "name": "max-fetch-concurrency",
2936
+ "default": 25,
2937
+ "hasDynamicHelp": false,
2938
+ "multiple": false,
2939
+ "type": "option"
2940
+ },
2941
+ "workspace": {
2942
+ "description": "The name of the workspace to use when downloading and validating all documents",
2943
+ "name": "workspace",
2856
2944
  "hasDynamicHelp": false,
2857
2945
  "multiple": false,
2858
2946
  "type": "option"
2947
+ },
2948
+ "yes": {
2949
+ "char": "y",
2950
+ "description": "Skips the first confirmation prompt",
2951
+ "name": "yes",
2952
+ "allowNo": false,
2953
+ "type": "boolean"
2859
2954
  }
2860
2955
  },
2861
2956
  "hasDynamicHelp": false,
2957
+ "hiddenAliases": [
2958
+ "document:validate"
2959
+ ],
2960
+ "id": "documents:validate",
2961
+ "pluginAlias": "@sanity/cli",
2962
+ "pluginName": "@sanity/cli",
2963
+ "pluginType": "core",
2964
+ "strict": true,
2965
+ "isESM": true,
2966
+ "relativePath": [
2967
+ "dist",
2968
+ "commands",
2969
+ "documents",
2970
+ "validate.js"
2971
+ ]
2972
+ },
2973
+ "docs:browse": {
2974
+ "aliases": [],
2975
+ "args": {},
2976
+ "description": "Open Sanity docs in your browser",
2977
+ "flags": {},
2978
+ "hasDynamicHelp": false,
2862
2979
  "hiddenAliases": [],
2863
- "id": "graphql:undeploy",
2980
+ "id": "docs:browse",
2864
2981
  "pluginAlias": "@sanity/cli",
2865
2982
  "pluginName": "@sanity/cli",
2866
2983
  "pluginType": "core",
2867
2984
  "strict": true,
2985
+ "enableJsonFlag": false,
2868
2986
  "isESM": true,
2869
2987
  "relativePath": [
2870
2988
  "dist",
2871
2989
  "commands",
2872
- "graphql",
2873
- "undeploy.js"
2990
+ "docs",
2991
+ "browse.js"
2874
2992
  ]
2875
2993
  },
2876
- "documents:create": {
2994
+ "docs:read": {
2877
2995
  "aliases": [],
2878
2996
  "args": {
2879
- "file": {
2880
- "description": "JSON file to create document(s) from",
2881
- "name": "file",
2882
- "required": false
2997
+ "path": {
2998
+ "description": "Path or URL to article, found in search results and docs content as links",
2999
+ "name": "path",
3000
+ "required": true
2883
3001
  }
2884
3002
  },
2885
- "description": "Create one or more documents",
3003
+ "description": "Read an article in terminal",
2886
3004
  "examples": [
2887
3005
  {
2888
- "command": "<%= config.bin %> <%= command.id %> myDocument.json",
2889
- "description": "Create the document specified in \"myDocument.json\""
2890
- },
2891
- {
2892
- "command": "<%= config.bin %> <%= command.id %>",
2893
- "description": "Open configured $EDITOR and create the specified document(s)"
3006
+ "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation",
3007
+ "description": "Read as markdown in terminal"
2894
3008
  },
2895
3009
  {
2896
- "command": "<%= config.bin %> <%= command.id %> --id myDocId --replace",
2897
- "description": "Fetch document with the ID \"myDocId\" and open configured $EDITOR with the current document content (if any). Replace document with the edited version when the editor closes"
3010
+ "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation",
3011
+ "description": "Read using full URL"
2898
3012
  },
2899
3013
  {
2900
- "command": "<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5",
2901
- "description": "Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax."
3014
+ "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation --web",
3015
+ "description": "Open in web browser"
2902
3016
  },
2903
3017
  {
2904
- "command": "<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123",
2905
- "description": "Create documents in a specific project"
3018
+ "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation -w",
3019
+ "description": "Open using full URL in web browser"
2906
3020
  }
2907
3021
  ],
2908
3022
  "flags": {
2909
- "project-id": {
2910
- "char": "p",
2911
- "description": "Project ID to create document(s) in (overrides CLI configuration)",
2912
- "helpGroup": "OVERRIDE",
2913
- "name": "project-id",
2914
- "hasDynamicHelp": false,
2915
- "helpValue": "<id>",
2916
- "multiple": false,
2917
- "type": "option"
2918
- },
2919
- "dataset": {
2920
- "char": "d",
2921
- "description": "Dataset to create document(s) in (overrides CLI configuration)",
2922
- "helpGroup": "OVERRIDE",
2923
- "name": "dataset",
2924
- "hasDynamicHelp": false,
2925
- "helpValue": "<name>",
2926
- "multiple": false,
2927
- "type": "option"
2928
- },
2929
- "id": {
2930
- "description": "Specify a document ID to use. Will fetch remote document ID and populate editor.",
2931
- "name": "id",
2932
- "hasDynamicHelp": false,
2933
- "multiple": false,
2934
- "type": "option"
2935
- },
2936
- "json5": {
2937
- "description": "Use JSON5 file type to allow a \"simplified\" version of JSON",
2938
- "name": "json5",
2939
- "allowNo": false,
2940
- "type": "boolean"
2941
- },
2942
- "missing": {
2943
- "description": "On duplicate document IDs, don't modify the target document(s)",
2944
- "name": "missing",
2945
- "allowNo": false,
2946
- "type": "boolean"
2947
- },
2948
- "replace": {
2949
- "description": "On duplicate document IDs, replace existing document with specified document(s)",
2950
- "name": "replace",
2951
- "allowNo": false,
2952
- "type": "boolean"
2953
- },
2954
- "watch": {
2955
- "description": "Write the documents whenever the target file or buffer changes",
2956
- "name": "watch",
3023
+ "web": {
3024
+ "aliases": [
3025
+ "w"
3026
+ ],
3027
+ "description": "Open in a web browser",
3028
+ "name": "web",
2957
3029
  "allowNo": false,
2958
3030
  "type": "boolean"
2959
3031
  }
2960
3032
  },
2961
3033
  "hasDynamicHelp": false,
2962
- "hiddenAliases": [
2963
- "document:create"
2964
- ],
2965
- "id": "documents:create",
3034
+ "hiddenAliases": [],
3035
+ "id": "docs:read",
2966
3036
  "pluginAlias": "@sanity/cli",
2967
3037
  "pluginName": "@sanity/cli",
2968
3038
  "pluginType": "core",
@@ -2971,147 +3041,151 @@
2971
3041
  "relativePath": [
2972
3042
  "dist",
2973
3043
  "commands",
2974
- "documents",
2975
- "create.js"
3044
+ "docs",
3045
+ "read.js"
2976
3046
  ]
2977
3047
  },
2978
- "documents:delete": {
3048
+ "docs:search": {
2979
3049
  "aliases": [],
2980
3050
  "args": {
2981
- "id": {
2982
- "description": "Document ID to delete",
2983
- "name": "id",
3051
+ "query": {
3052
+ "description": "Search query for documentation",
3053
+ "name": "query",
2984
3054
  "required": true
2985
- },
2986
- "ids": {
2987
- "description": "Additional document IDs to delete",
2988
- "name": "ids",
2989
- "required": false
2990
3055
  }
2991
3056
  },
2992
- "description": "Delete one or more documents from the project's configured dataset",
3057
+ "description": "Search Sanity docs",
2993
3058
  "examples": [
2994
3059
  {
2995
- "command": "<%= config.bin %> <%= command.id %> myDocId",
2996
- "description": "Delete the document with the ID \"myDocId\""
2997
- },
2998
- {
2999
- "command": "<%= config.bin %> <%= command.id %> 'myDocId'",
3000
- "description": "ID wrapped in double or single quote works equally well"
3001
- },
3002
- {
3003
- "command": "<%= config.bin %> <%= command.id %> --dataset=blog someDocId",
3004
- "description": "Delete document with ID \"someDocId\" from dataset \"blog\""
3060
+ "command": "<%= config.bin %> <%= command.id %> schema",
3061
+ "description": "Search for documentation about schemas"
3005
3062
  },
3006
3063
  {
3007
- "command": "<%= config.bin %> <%= command.id %> doc1 doc2",
3008
- "description": "Delete the document with ID \"doc1\" and \"doc2\""
3064
+ "command": "<%= config.bin %> <%= command.id %> \"groq functions\"",
3065
+ "description": "Search with phrase"
3009
3066
  },
3010
3067
  {
3011
- "command": "<%= config.bin %> <%= command.id %> myDocId --project-id abc123",
3012
- "description": "Delete a document from a specific project"
3068
+ "command": "<%= config.bin %> <%= command.id %> \"deployment\" --limit=5",
3069
+ "description": "Limit search results"
3013
3070
  }
3014
3071
  ],
3015
3072
  "flags": {
3016
- "project-id": {
3017
- "char": "p",
3018
- "description": "Project ID to delete from (overrides CLI configuration)",
3019
- "helpGroup": "OVERRIDE",
3020
- "name": "project-id",
3021
- "hasDynamicHelp": false,
3022
- "helpValue": "<id>",
3023
- "multiple": false,
3024
- "type": "option"
3025
- },
3026
- "dataset": {
3027
- "char": "d",
3028
- "description": "Dataset to delete from (overrides CLI configuration)",
3029
- "helpGroup": "OVERRIDE",
3030
- "name": "dataset",
3073
+ "limit": {
3074
+ "description": "Maximum number of results to return",
3075
+ "name": "limit",
3076
+ "default": 10,
3031
3077
  "hasDynamicHelp": false,
3032
- "helpValue": "<name>",
3033
3078
  "multiple": false,
3034
3079
  "type": "option"
3035
3080
  }
3036
3081
  },
3037
3082
  "hasDynamicHelp": false,
3038
- "hiddenAliases": [
3039
- "document:delete"
3040
- ],
3041
- "id": "documents:delete",
3083
+ "hiddenAliases": [],
3084
+ "id": "docs:search",
3042
3085
  "pluginAlias": "@sanity/cli",
3043
3086
  "pluginName": "@sanity/cli",
3044
3087
  "pluginType": "core",
3045
- "strict": false,
3088
+ "strict": true,
3046
3089
  "isESM": true,
3047
3090
  "relativePath": [
3048
3091
  "dist",
3049
3092
  "commands",
3050
- "documents",
3051
- "delete.js"
3093
+ "docs",
3094
+ "search.js"
3052
3095
  ]
3053
3096
  },
3054
- "documents:get": {
3097
+ "graphql:deploy": {
3055
3098
  "aliases": [],
3056
- "args": {
3057
- "documentId": {
3058
- "description": "Document ID to retrieve",
3059
- "name": "documentId",
3060
- "required": true
3061
- }
3062
- },
3063
- "description": "Get and print a document by ID",
3099
+ "args": {},
3100
+ "description": "Deploy a GraphQL API from the current Sanity schema",
3064
3101
  "examples": [
3065
3102
  {
3066
- "command": "<%= config.bin %> <%= command.id %> myDocId",
3067
- "description": "Get the document with ID \"myDocId\""
3103
+ "command": "<%= config.bin %> <%= command.id %>",
3104
+ "description": "Deploy all defined GraphQL APIs"
3068
3105
  },
3069
3106
  {
3070
- "command": "<%= config.bin %> <%= command.id %> myDocId --pretty",
3071
- "description": "Get document with colorized JSON output"
3107
+ "command": "<%= config.bin %> <%= command.id %> --dry-run",
3108
+ "description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy"
3072
3109
  },
3073
3110
  {
3074
- "command": "<%= config.bin %> <%= command.id %> myDocId --dataset production",
3075
- "description": "Get document from a specific dataset"
3111
+ "command": "<%= config.bin %> <%= command.id %> --api staging --api ios",
3112
+ "description": "Deploy only the GraphQL APIs with the IDs \"staging\" and \"ios\""
3076
3113
  },
3077
3114
  {
3078
- "command": "<%= config.bin %> <%= command.id %> myDocId --project-id abc123",
3079
- "description": "Get a document from a specific project"
3115
+ "command": "<%= config.bin %> <%= command.id %> --playground",
3116
+ "description": "Deploy all defined GraphQL APIs, overriding any playground setting"
3080
3117
  }
3081
3118
  ],
3082
3119
  "flags": {
3083
- "project-id": {
3084
- "char": "p",
3085
- "description": "Project ID to get document from (overrides CLI configuration)",
3086
- "helpGroup": "OVERRIDE",
3087
- "name": "project-id",
3120
+ "api": {
3121
+ "description": "Only deploy API with this ID (can be specified multiple times)",
3122
+ "name": "api",
3088
3123
  "hasDynamicHelp": false,
3089
- "helpValue": "<id>",
3090
- "multiple": false,
3124
+ "multiple": true,
3091
3125
  "type": "option"
3092
3126
  },
3093
3127
  "dataset": {
3094
3128
  "char": "d",
3095
- "description": "Dataset to get document from (overrides CLI configuration)",
3096
- "helpGroup": "OVERRIDE",
3129
+ "description": "Deploy API for the given dataset",
3097
3130
  "name": "dataset",
3098
3131
  "hasDynamicHelp": false,
3099
3132
  "helpValue": "<name>",
3100
3133
  "multiple": false,
3101
3134
  "type": "option"
3102
3135
  },
3103
- "pretty": {
3104
- "description": "Colorize JSON output",
3105
- "name": "pretty",
3136
+ "dry-run": {
3137
+ "description": "Validate defined GraphQL APIs, check for breaking changes, skip deploy",
3138
+ "name": "dry-run",
3139
+ "allowNo": false,
3140
+ "type": "boolean"
3141
+ },
3142
+ "force": {
3143
+ "description": "Deploy API without confirming breaking changes",
3144
+ "name": "force",
3145
+ "allowNo": false,
3146
+ "type": "boolean"
3147
+ },
3148
+ "generation": {
3149
+ "description": "API generation to deploy (defaults to \"gen3\")",
3150
+ "name": "generation",
3151
+ "hasDynamicHelp": false,
3152
+ "multiple": false,
3153
+ "options": [
3154
+ "gen1",
3155
+ "gen2",
3156
+ "gen3"
3157
+ ],
3158
+ "type": "option"
3159
+ },
3160
+ "non-null-document-fields": {
3161
+ "description": "Use non-null document fields (_id, _type etc)",
3162
+ "name": "non-null-document-fields",
3163
+ "allowNo": false,
3164
+ "type": "boolean"
3165
+ },
3166
+ "playground": {
3167
+ "description": "Enable GraphQL playground for easier debugging",
3168
+ "name": "playground",
3169
+ "allowNo": true,
3170
+ "type": "boolean"
3171
+ },
3172
+ "tag": {
3173
+ "description": "Deploy API(s) to given tag (defaults to \"default\")",
3174
+ "name": "tag",
3175
+ "hasDynamicHelp": false,
3176
+ "multiple": false,
3177
+ "type": "option"
3178
+ },
3179
+ "with-union-cache": {
3180
+ "description": "Cache union types (faster for schemas with many self-references)",
3181
+ "name": "with-union-cache",
3106
3182
  "allowNo": false,
3107
3183
  "type": "boolean"
3108
3184
  }
3109
3185
  },
3110
3186
  "hasDynamicHelp": false,
3111
- "hiddenAliases": [
3112
- "document:get"
3113
- ],
3114
- "id": "documents:get",
3187
+ "hiddenAliases": [],
3188
+ "id": "graphql:deploy",
3115
3189
  "pluginAlias": "@sanity/cli",
3116
3190
  "pluginName": "@sanity/cli",
3117
3191
  "pluginType": "core",
@@ -3120,95 +3194,39 @@
3120
3194
  "relativePath": [
3121
3195
  "dist",
3122
3196
  "commands",
3123
- "documents",
3124
- "get.js"
3197
+ "graphql",
3198
+ "deploy.js"
3125
3199
  ]
3126
3200
  },
3127
- "documents:query": {
3201
+ "graphql:list": {
3128
3202
  "aliases": [],
3129
- "args": {
3130
- "query": {
3131
- "description": "GROQ query to run against the dataset",
3132
- "name": "query",
3133
- "required": true
3134
- }
3135
- },
3136
- "description": "Query for documents",
3203
+ "args": {},
3204
+ "description": "List deployed GraphQL endpoints for the project",
3137
3205
  "examples": [
3138
3206
  {
3139
- "command": "<%= config.bin %> <%= command.id %> '*[_type == \"movie\"][0..4]'",
3140
- "description": "Fetch 5 documents of type \"movie\""
3141
- },
3142
- {
3143
- "command": "<%= config.bin %> <%= command.id %> '*[_type == \"movie\"]|order(releaseDate asc)[0]{title}' --dataset staging",
3144
- "description": "Fetch title of the oldest movie in the dataset named \"staging\""
3145
- },
3146
- {
3147
- "command": "<%= config.bin %> <%= command.id %> '*[_id == \"header\"] { \"headerText\": pt::text(body) }' --api-version v2021-06-07",
3148
- "description": "Use API version v2021-06-07 and do a query"
3207
+ "command": "<%= config.bin %> <%= command.id %>",
3208
+ "description": "List GraphQL endpoints for the project"
3149
3209
  },
3150
3210
  {
3151
- "command": "<%= config.bin %> <%= command.id %> '*[_type == \"post\"]' --project-id abc123 --dataset production",
3152
- "description": "Query documents in a specific project and dataset"
3211
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
3212
+ "description": "List GraphQL endpoints for a specific project"
3153
3213
  }
3154
3214
  ],
3155
3215
  "flags": {
3156
3216
  "project-id": {
3157
3217
  "char": "p",
3158
- "description": "Project ID to query (overrides CLI configuration)",
3218
+ "description": "Project ID to list GraphQL endpoints for (overrides CLI configuration)",
3159
3219
  "helpGroup": "OVERRIDE",
3160
3220
  "name": "project-id",
3161
3221
  "hasDynamicHelp": false,
3162
3222
  "helpValue": "<id>",
3163
3223
  "multiple": false,
3164
3224
  "type": "option"
3165
- },
3166
- "dataset": {
3167
- "char": "d",
3168
- "description": "Dataset to query (overrides CLI configuration)",
3169
- "helpGroup": "OVERRIDE",
3170
- "name": "dataset",
3171
- "hasDynamicHelp": false,
3172
- "helpValue": "<name>",
3173
- "multiple": false,
3174
- "type": "option"
3175
- },
3176
- "anonymous": {
3177
- "description": "Send the query without any authorization token",
3178
- "name": "anonymous",
3179
- "allowNo": false,
3180
- "type": "boolean"
3181
- },
3182
- "api-version": {
3183
- "description": "API version to use (defaults to 2025-08-15)",
3184
- "name": "api-version",
3185
- "hasDynamicHelp": false,
3186
- "multiple": false,
3187
- "type": "option"
3188
- },
3189
- "pretty": {
3190
- "description": "Colorize JSON output",
3191
- "name": "pretty",
3192
- "allowNo": false,
3193
- "type": "boolean"
3194
- },
3195
- "project": {
3196
- "deprecated": {
3197
- "to": "project-id"
3198
- },
3199
- "description": "Project ID to query",
3200
- "hidden": true,
3201
- "name": "project",
3202
- "hasDynamicHelp": false,
3203
- "multiple": false,
3204
- "type": "option"
3205
3225
  }
3206
3226
  },
3207
3227
  "hasDynamicHelp": false,
3208
- "hiddenAliases": [
3209
- "document:query"
3210
- ],
3211
- "id": "documents:query",
3228
+ "hiddenAliases": [],
3229
+ "id": "graphql:list",
3212
3230
  "pluginAlias": "@sanity/cli",
3213
3231
  "pluginName": "@sanity/cli",
3214
3232
  "pluginType": "core",
@@ -3217,123 +3235,105 @@
3217
3235
  "relativePath": [
3218
3236
  "dist",
3219
3237
  "commands",
3220
- "documents",
3221
- "query.js"
3238
+ "graphql",
3239
+ "list.js"
3222
3240
  ]
3223
3241
  },
3224
- "documents:validate": {
3242
+ "graphql:undeploy": {
3225
3243
  "aliases": [],
3226
3244
  "args": {},
3227
- "description": "Validate documents in a dataset against the studio schema",
3245
+ "description": "Remove a deployed GraphQL API",
3228
3246
  "examples": [
3229
3247
  {
3230
- "command": "<%= config.bin %> <%= command.id %> --workspace default",
3231
- "description": "Validates all documents in a Sanity project with more than one workspace"
3248
+ "command": "<%= config.bin %> <%= command.id %>",
3249
+ "description": "Undeploy GraphQL API for current project and dataset"
3232
3250
  },
3233
3251
  {
3234
- "command": "<%= config.bin %> <%= command.id %> --workspace default --dataset staging",
3235
- "description": "Override the dataset specified in the workspace"
3252
+ "command": "<%= config.bin %> <%= command.id %> --api ios",
3253
+ "description": "Undeploy API with ID \"ios\""
3236
3254
  },
3237
3255
  {
3238
- "command": "<%= config.bin %> <%= command.id %> --yes > report.txt",
3239
- "description": "Save the results of the report into a file"
3256
+ "command": "<%= config.bin %> <%= command.id %> --dataset staging",
3257
+ "description": "Undeploy GraphQL API for staging dataset"
3240
3258
  },
3241
3259
  {
3242
- "command": "<%= config.bin %> <%= command.id %> --level info",
3243
- "description": "Report out info level validation markers too"
3260
+ "command": "<%= config.bin %> <%= command.id %> --dataset staging --tag next",
3261
+ "description": "Undeploy GraphQL API for staging dataset with \"next\" tag"
3262
+ },
3263
+ {
3264
+ "command": "<%= config.bin %> <%= command.id %> --force",
3265
+ "description": "Undeploy GraphQL API without confirmation prompt"
3244
3266
  },
3245
3267
  {
3246
3268
  "command": "<%= config.bin %> <%= command.id %> --project-id abc123 --dataset production",
3247
- "description": "Validate documents in a specific project and dataset"
3269
+ "description": "Undeploy GraphQL API for a specific project and dataset"
3248
3270
  }
3249
3271
  ],
3250
3272
  "flags": {
3251
3273
  "project-id": {
3252
3274
  "char": "p",
3253
- "description": "Override the project ID used. By default, this is derived from the given workspace",
3275
+ "description": "Project ID to undeploy GraphQL API from (overrides CLI configuration)",
3276
+ "helpGroup": "OVERRIDE",
3254
3277
  "name": "project-id",
3255
3278
  "hasDynamicHelp": false,
3256
3279
  "helpValue": "<id>",
3257
3280
  "multiple": false,
3258
3281
  "type": "option"
3259
3282
  },
3260
- "dataset": {
3261
- "char": "d",
3262
- "description": "Override the dataset used. By default, this is derived from the given workspace",
3263
- "name": "dataset",
3264
- "hasDynamicHelp": false,
3265
- "helpValue": "<name>",
3266
- "multiple": false,
3267
- "type": "option"
3268
- },
3269
- "file": {
3270
- "description": "Path to an NDJSON file or tar archive containing an NDJSON file (optionally gzip-compressed)",
3271
- "name": "file",
3272
- "hasDynamicHelp": false,
3273
- "multiple": false,
3274
- "type": "option"
3275
- },
3276
- "format": {
3277
- "description": "The output format used to print the found validation markers and report progress",
3278
- "name": "format",
3279
- "hasDynamicHelp": false,
3280
- "multiple": false,
3281
- "options": [
3282
- "json",
3283
- "ndjson",
3284
- "pretty"
3283
+ "api": {
3284
+ "description": "Undeploy API with this ID",
3285
+ "exclusive": [
3286
+ "project-id",
3287
+ "project"
3285
3288
  ],
3286
- "type": "option"
3287
- },
3288
- "level": {
3289
- "description": "The minimum level reported. Defaults to warning",
3290
- "name": "level",
3291
- "default": "warning",
3289
+ "name": "api",
3290
+ "required": false,
3292
3291
  "hasDynamicHelp": false,
3293
3292
  "multiple": false,
3294
- "options": [
3295
- "error",
3296
- "warning",
3297
- "info"
3298
- ],
3299
3293
  "type": "option"
3300
3294
  },
3301
- "max-custom-validation-concurrency": {
3302
- "description": "Specify how many custom validators can run concurrently",
3303
- "name": "max-custom-validation-concurrency",
3304
- "default": 5,
3295
+ "dataset": {
3296
+ "char": "d",
3297
+ "description": "Dataset to undeploy GraphQL API from (overrides CLI configuration)",
3298
+ "helpGroup": "OVERRIDE",
3299
+ "name": "dataset",
3305
3300
  "hasDynamicHelp": false,
3301
+ "helpValue": "<name>",
3306
3302
  "multiple": false,
3307
3303
  "type": "option"
3308
3304
  },
3309
- "max-fetch-concurrency": {
3310
- "description": "Specify how many `client.fetch` requests are allowed to run concurrently",
3311
- "name": "max-fetch-concurrency",
3312
- "default": 25,
3305
+ "force": {
3306
+ "description": "Skip confirmation prompt",
3307
+ "name": "force",
3308
+ "required": false,
3309
+ "allowNo": false,
3310
+ "type": "boolean"
3311
+ },
3312
+ "project": {
3313
+ "deprecated": {
3314
+ "to": "project-id"
3315
+ },
3316
+ "description": "Project ID to delete GraphQL API for",
3317
+ "hidden": true,
3318
+ "name": "project",
3319
+ "required": false,
3313
3320
  "hasDynamicHelp": false,
3314
3321
  "multiple": false,
3315
3322
  "type": "option"
3316
3323
  },
3317
- "workspace": {
3318
- "description": "The name of the workspace to use when downloading and validating all documents",
3319
- "name": "workspace",
3324
+ "tag": {
3325
+ "description": "Tag to undeploy GraphQL API from",
3326
+ "name": "tag",
3327
+ "required": false,
3328
+ "default": "default",
3320
3329
  "hasDynamicHelp": false,
3321
3330
  "multiple": false,
3322
3331
  "type": "option"
3323
- },
3324
- "yes": {
3325
- "char": "y",
3326
- "description": "Skips the first confirmation prompt",
3327
- "name": "yes",
3328
- "allowNo": false,
3329
- "type": "boolean"
3330
3332
  }
3331
3333
  },
3332
3334
  "hasDynamicHelp": false,
3333
- "hiddenAliases": [
3334
- "document:validate"
3335
- ],
3336
- "id": "documents:validate",
3335
+ "hiddenAliases": [],
3336
+ "id": "graphql:undeploy",
3337
3337
  "pluginAlias": "@sanity/cli",
3338
3338
  "pluginName": "@sanity/cli",
3339
3339
  "pluginType": "core",
@@ -3342,8 +3342,8 @@
3342
3342
  "relativePath": [
3343
3343
  "dist",
3344
3344
  "commands",
3345
- "documents",
3346
- "validate.js"
3345
+ "graphql",
3346
+ "undeploy.js"
3347
3347
  ]
3348
3348
  },
3349
3349
  "hooks:attempt": {
@@ -3568,59 +3568,20 @@
3568
3568
  "helpValue": "<id>",
3569
3569
  "multiple": false,
3570
3570
  "type": "option"
3571
- },
3572
- "detailed": {
3573
- "description": "Include detailed payload and attempts",
3574
- "name": "detailed",
3575
- "required": false,
3576
- "allowNo": false,
3577
- "type": "boolean"
3578
- }
3579
- },
3580
- "hasDynamicHelp": false,
3581
- "hiddenAliases": [
3582
- "hook:logs"
3583
- ],
3584
- "id": "hooks:logs",
3585
- "pluginAlias": "@sanity/cli",
3586
- "pluginName": "@sanity/cli",
3587
- "pluginType": "core",
3588
- "strict": true,
3589
- "isESM": true,
3590
- "relativePath": [
3591
- "dist",
3592
- "commands",
3593
- "hooks",
3594
- "logs.js"
3595
- ]
3596
- },
3597
- "manifest:extract": {
3598
- "aliases": [],
3599
- "args": {},
3600
- "description": "Extract studio configuration as JSON manifest files.\n\nNote: This command is experimental and subject to change. It is currently intended for use with Create only.",
3601
- "examples": [
3602
- {
3603
- "command": "<%= config.bin %> <%= command.id %>",
3604
- "description": "Extracts manifests"
3605
- },
3606
- {
3607
- "command": "<%= config.bin %> <%= command.id %> --path /public/static",
3608
- "description": "Extracts manifests into /public/static"
3609
- }
3610
- ],
3611
- "flags": {
3612
- "path": {
3613
- "description": "Optional path to specify destination directory of the manifest files",
3614
- "name": "path",
3615
- "default": "dist/static",
3616
- "hasDynamicHelp": false,
3617
- "multiple": false,
3618
- "type": "option"
3571
+ },
3572
+ "detailed": {
3573
+ "description": "Include detailed payload and attempts",
3574
+ "name": "detailed",
3575
+ "required": false,
3576
+ "allowNo": false,
3577
+ "type": "boolean"
3619
3578
  }
3620
3579
  },
3621
3580
  "hasDynamicHelp": false,
3622
- "hiddenAliases": [],
3623
- "id": "manifest:extract",
3581
+ "hiddenAliases": [
3582
+ "hook:logs"
3583
+ ],
3584
+ "id": "hooks:logs",
3624
3585
  "pluginAlias": "@sanity/cli",
3625
3586
  "pluginName": "@sanity/cli",
3626
3587
  "pluginType": "core",
@@ -3629,8 +3590,8 @@
3629
3590
  "relativePath": [
3630
3591
  "dist",
3631
3592
  "commands",
3632
- "manifest",
3633
- "extract.js"
3593
+ "hooks",
3594
+ "logs.js"
3634
3595
  ]
3635
3596
  },
3636
3597
  "mcp:configure": {
@@ -4487,6 +4448,45 @@
4487
4448
  "update.js"
4488
4449
  ]
4489
4450
  },
4451
+ "manifest:extract": {
4452
+ "aliases": [],
4453
+ "args": {},
4454
+ "description": "Extract studio configuration as JSON manifest files.\n\nNote: This command is experimental and subject to change. It is currently intended for use with Create only.",
4455
+ "examples": [
4456
+ {
4457
+ "command": "<%= config.bin %> <%= command.id %>",
4458
+ "description": "Extracts manifests"
4459
+ },
4460
+ {
4461
+ "command": "<%= config.bin %> <%= command.id %> --path /public/static",
4462
+ "description": "Extracts manifests into /public/static"
4463
+ }
4464
+ ],
4465
+ "flags": {
4466
+ "path": {
4467
+ "description": "Optional path to specify destination directory of the manifest files",
4468
+ "name": "path",
4469
+ "default": "dist/static",
4470
+ "hasDynamicHelp": false,
4471
+ "multiple": false,
4472
+ "type": "option"
4473
+ }
4474
+ },
4475
+ "hasDynamicHelp": false,
4476
+ "hiddenAliases": [],
4477
+ "id": "manifest:extract",
4478
+ "pluginAlias": "@sanity/cli",
4479
+ "pluginName": "@sanity/cli",
4480
+ "pluginType": "core",
4481
+ "strict": true,
4482
+ "isESM": true,
4483
+ "relativePath": [
4484
+ "dist",
4485
+ "commands",
4486
+ "manifest",
4487
+ "extract.js"
4488
+ ]
4489
+ },
4490
4490
  "projects:create": {
4491
4491
  "aliases": [],
4492
4492
  "args": {
@@ -4677,6 +4677,32 @@
4677
4677
  "unclaimed.js"
4678
4678
  ]
4679
4679
  },
4680
+ "skills:install": {
4681
+ "aliases": [],
4682
+ "args": {},
4683
+ "description": "Install Sanity agent skills for detected AI editors (Antigravity, Claude Code, Cline, Cline CLI, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, OpenCode, VS Code, VS Code Insiders)",
4684
+ "examples": [
4685
+ {
4686
+ "command": "<%= config.bin %> <%= command.id %>",
4687
+ "description": "Install Sanity agent skills for detected AI editors"
4688
+ }
4689
+ ],
4690
+ "flags": {},
4691
+ "hasDynamicHelp": false,
4692
+ "hiddenAliases": [],
4693
+ "id": "skills:install",
4694
+ "pluginAlias": "@sanity/cli",
4695
+ "pluginName": "@sanity/cli",
4696
+ "pluginType": "core",
4697
+ "strict": true,
4698
+ "isESM": true,
4699
+ "relativePath": [
4700
+ "dist",
4701
+ "commands",
4702
+ "skills",
4703
+ "install.js"
4704
+ ]
4705
+ },
4680
4706
  "schemas:delete": {
4681
4707
  "aliases": [],
4682
4708
  "args": {},
@@ -5076,32 +5102,6 @@
5076
5102
  "validate.js"
5077
5103
  ]
5078
5104
  },
5079
- "skills:install": {
5080
- "aliases": [],
5081
- "args": {},
5082
- "description": "Install Sanity agent skills for detected AI editors (Antigravity, Claude Code, Cline, Cline CLI, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, OpenCode, VS Code, VS Code Insiders)",
5083
- "examples": [
5084
- {
5085
- "command": "<%= config.bin %> <%= command.id %>",
5086
- "description": "Install Sanity agent skills for detected AI editors"
5087
- }
5088
- ],
5089
- "flags": {},
5090
- "hasDynamicHelp": false,
5091
- "hiddenAliases": [],
5092
- "id": "skills:install",
5093
- "pluginAlias": "@sanity/cli",
5094
- "pluginName": "@sanity/cli",
5095
- "pluginType": "core",
5096
- "strict": true,
5097
- "isESM": true,
5098
- "relativePath": [
5099
- "dist",
5100
- "commands",
5101
- "skills",
5102
- "install.js"
5103
- ]
5104
- },
5105
5105
  "telemetry:disable": {
5106
5106
  "aliases": [],
5107
5107
  "args": {},
@@ -5349,22 +5349,179 @@
5349
5349
  "description": "List API tokens for the project",
5350
5350
  "examples": [
5351
5351
  {
5352
- "command": "<%= config.bin %> <%= command.id %>",
5353
- "description": "List tokens for the project"
5352
+ "command": "<%= config.bin %> <%= command.id %>",
5353
+ "description": "List tokens for the project"
5354
+ },
5355
+ {
5356
+ "command": "<%= config.bin %> <%= command.id %> --json",
5357
+ "description": "List tokens in JSON format"
5358
+ },
5359
+ {
5360
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5361
+ "description": "List tokens for a specific project"
5362
+ }
5363
+ ],
5364
+ "flags": {
5365
+ "project-id": {
5366
+ "char": "p",
5367
+ "description": "Project ID to list tokens for (overrides CLI configuration)",
5368
+ "helpGroup": "OVERRIDE",
5369
+ "name": "project-id",
5370
+ "hasDynamicHelp": false,
5371
+ "helpValue": "<id>",
5372
+ "multiple": false,
5373
+ "type": "option"
5374
+ },
5375
+ "json": {
5376
+ "description": "Output tokens in JSON format",
5377
+ "name": "json",
5378
+ "allowNo": false,
5379
+ "type": "boolean"
5380
+ }
5381
+ },
5382
+ "hasDynamicHelp": false,
5383
+ "hiddenAliases": [
5384
+ "token:list"
5385
+ ],
5386
+ "id": "tokens:list",
5387
+ "pluginAlias": "@sanity/cli",
5388
+ "pluginName": "@sanity/cli",
5389
+ "pluginType": "core",
5390
+ "strict": true,
5391
+ "isESM": true,
5392
+ "relativePath": [
5393
+ "dist",
5394
+ "commands",
5395
+ "tokens",
5396
+ "list.js"
5397
+ ]
5398
+ },
5399
+ "tokens:rotate": {
5400
+ "aliases": [],
5401
+ "args": {},
5402
+ "description": "Rotate an API token, replacing its secret with a new one",
5403
+ "examples": [
5404
+ {
5405
+ "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %>",
5406
+ "description": "Rotate the token piped on standard input"
5407
+ },
5408
+ {
5409
+ "command": "<%= config.bin %> <%= command.id %> < token.txt",
5410
+ "description": "Rotate a token read from a file"
5411
+ },
5412
+ {
5413
+ "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %> --json",
5414
+ "description": "Output the rotated token as JSON"
5415
+ }
5416
+ ],
5417
+ "flags": {
5418
+ "json": {
5419
+ "description": "Output as JSON",
5420
+ "name": "json",
5421
+ "allowNo": false,
5422
+ "type": "boolean"
5423
+ },
5424
+ "token": {
5425
+ "char": "t",
5426
+ "description": "Token to rotate (prefer standard input to keep it out of shell history)",
5427
+ "name": "token",
5428
+ "hasDynamicHelp": false,
5429
+ "helpValue": "<token>",
5430
+ "multiple": false,
5431
+ "type": "option"
5432
+ }
5433
+ },
5434
+ "hasDynamicHelp": false,
5435
+ "hiddenAliases": [
5436
+ "token:rotate"
5437
+ ],
5438
+ "id": "tokens:rotate",
5439
+ "pluginAlias": "@sanity/cli",
5440
+ "pluginName": "@sanity/cli",
5441
+ "pluginType": "core",
5442
+ "strict": true,
5443
+ "isESM": true,
5444
+ "relativePath": [
5445
+ "dist",
5446
+ "commands",
5447
+ "tokens",
5448
+ "rotate.js"
5449
+ ]
5450
+ },
5451
+ "datasets:embeddings:disable": {
5452
+ "aliases": [],
5453
+ "args": {
5454
+ "dataset": {
5455
+ "description": "Dataset name to disable embeddings for",
5456
+ "name": "dataset",
5457
+ "required": false
5458
+ }
5459
+ },
5460
+ "description": "Disable embeddings for a dataset",
5461
+ "examples": [
5462
+ {
5463
+ "command": "<%= config.bin %> <%= command.id %> production",
5464
+ "description": "Disable embeddings for the production dataset"
5465
+ }
5466
+ ],
5467
+ "flags": {
5468
+ "project-id": {
5469
+ "char": "p",
5470
+ "description": "Project ID to disable embeddings for (overrides CLI configuration)",
5471
+ "helpGroup": "OVERRIDE",
5472
+ "name": "project-id",
5473
+ "hasDynamicHelp": false,
5474
+ "helpValue": "<id>",
5475
+ "multiple": false,
5476
+ "type": "option"
5477
+ }
5478
+ },
5479
+ "hasDynamicHelp": false,
5480
+ "hiddenAliases": [
5481
+ "dataset:embeddings:disable"
5482
+ ],
5483
+ "id": "datasets:embeddings:disable",
5484
+ "pluginAlias": "@sanity/cli",
5485
+ "pluginName": "@sanity/cli",
5486
+ "pluginType": "core",
5487
+ "strict": true,
5488
+ "isESM": true,
5489
+ "relativePath": [
5490
+ "dist",
5491
+ "commands",
5492
+ "datasets",
5493
+ "embeddings",
5494
+ "disable.js"
5495
+ ]
5496
+ },
5497
+ "datasets:embeddings:enable": {
5498
+ "aliases": [],
5499
+ "args": {
5500
+ "dataset": {
5501
+ "description": "Dataset name to enable embeddings for",
5502
+ "name": "dataset",
5503
+ "required": false
5504
+ }
5505
+ },
5506
+ "description": "Enable embeddings for a dataset",
5507
+ "examples": [
5508
+ {
5509
+ "command": "<%= config.bin %> <%= command.id %> production",
5510
+ "description": "Enable embeddings for the production dataset"
5354
5511
  },
5355
5512
  {
5356
- "command": "<%= config.bin %> <%= command.id %> --json",
5357
- "description": "List tokens in JSON format"
5513
+ "command": "<%= config.bin %> <%= command.id %> production --projection \"{ title, body }\"",
5514
+ "description": "Enable embeddings with a specific projection"
5358
5515
  },
5359
5516
  {
5360
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5361
- "description": "List tokens for a specific project"
5517
+ "command": "<%= config.bin %> <%= command.id %> production --wait",
5518
+ "description": "Enable embeddings and wait for processing to complete"
5362
5519
  }
5363
5520
  ],
5364
5521
  "flags": {
5365
5522
  "project-id": {
5366
5523
  "char": "p",
5367
- "description": "Project ID to list tokens for (overrides CLI configuration)",
5524
+ "description": "Project ID to enable embeddings for (overrides CLI configuration)",
5368
5525
  "helpGroup": "OVERRIDE",
5369
5526
  "name": "project-id",
5370
5527
  "hasDynamicHelp": false,
@@ -5372,18 +5529,26 @@
5372
5529
  "multiple": false,
5373
5530
  "type": "option"
5374
5531
  },
5375
- "json": {
5376
- "description": "Output tokens in JSON format",
5377
- "name": "json",
5532
+ "projection": {
5533
+ "description": "GROQ projection defining which fields to embed (e.g. \"{ title, body }\")",
5534
+ "name": "projection",
5535
+ "required": false,
5536
+ "hasDynamicHelp": false,
5537
+ "multiple": false,
5538
+ "type": "option"
5539
+ },
5540
+ "wait": {
5541
+ "description": "Wait for embeddings processing to complete before returning",
5542
+ "name": "wait",
5378
5543
  "allowNo": false,
5379
5544
  "type": "boolean"
5380
5545
  }
5381
5546
  },
5382
5547
  "hasDynamicHelp": false,
5383
5548
  "hiddenAliases": [
5384
- "token:list"
5549
+ "dataset:embeddings:enable"
5385
5550
  ],
5386
- "id": "tokens:list",
5551
+ "id": "datasets:embeddings:enable",
5387
5552
  "pluginAlias": "@sanity/cli",
5388
5553
  "pluginName": "@sanity/cli",
5389
5554
  "pluginType": "core",
@@ -5392,50 +5557,44 @@
5392
5557
  "relativePath": [
5393
5558
  "dist",
5394
5559
  "commands",
5395
- "tokens",
5396
- "list.js"
5560
+ "datasets",
5561
+ "embeddings",
5562
+ "enable.js"
5397
5563
  ]
5398
5564
  },
5399
- "tokens:rotate": {
5565
+ "datasets:embeddings:status": {
5400
5566
  "aliases": [],
5401
- "args": {},
5402
- "description": "Rotate an API token, replacing its secret with a new one",
5567
+ "args": {
5568
+ "dataset": {
5569
+ "description": "The name of the dataset to check embeddings status for",
5570
+ "name": "dataset",
5571
+ "required": false
5572
+ }
5573
+ },
5574
+ "description": "Show embeddings settings and status for a dataset",
5403
5575
  "examples": [
5404
5576
  {
5405
- "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %>",
5406
- "description": "Rotate the token piped on standard input"
5407
- },
5408
- {
5409
- "command": "<%= config.bin %> <%= command.id %> < token.txt",
5410
- "description": "Rotate a token read from a file"
5411
- },
5412
- {
5413
- "command": "echo \"$SANITY_TOKEN\" | <%= config.bin %> <%= command.id %> --json",
5414
- "description": "Output the rotated token as JSON"
5577
+ "command": "<%= config.bin %> <%= command.id %> production",
5578
+ "description": "Show embeddings status for the production dataset"
5415
5579
  }
5416
5580
  ],
5417
5581
  "flags": {
5418
- "json": {
5419
- "description": "Output as JSON",
5420
- "name": "json",
5421
- "allowNo": false,
5422
- "type": "boolean"
5423
- },
5424
- "token": {
5425
- "char": "t",
5426
- "description": "Token to rotate (prefer standard input to keep it out of shell history)",
5427
- "name": "token",
5582
+ "project-id": {
5583
+ "char": "p",
5584
+ "description": "Project ID to check embeddings status for (overrides CLI configuration)",
5585
+ "helpGroup": "OVERRIDE",
5586
+ "name": "project-id",
5428
5587
  "hasDynamicHelp": false,
5429
- "helpValue": "<token>",
5588
+ "helpValue": "<id>",
5430
5589
  "multiple": false,
5431
5590
  "type": "option"
5432
5591
  }
5433
5592
  },
5434
5593
  "hasDynamicHelp": false,
5435
5594
  "hiddenAliases": [
5436
- "token:rotate"
5595
+ "dataset:embeddings:status"
5437
5596
  ],
5438
- "id": "tokens:rotate",
5597
+ "id": "datasets:embeddings:status",
5439
5598
  "pluginAlias": "@sanity/cli",
5440
5599
  "pluginName": "@sanity/cli",
5441
5600
  "pluginType": "core",
@@ -5444,14 +5603,15 @@
5444
5603
  "relativePath": [
5445
5604
  "dist",
5446
5605
  "commands",
5447
- "tokens",
5448
- "rotate.js"
5606
+ "datasets",
5607
+ "embeddings",
5608
+ "status.js"
5449
5609
  ]
5450
5610
  },
5451
5611
  "typegen:generate": {
5452
5612
  "aliases": [],
5453
5613
  "args": {},
5454
- "description": "Sanity TypeGen\n\nConfiguration:\nThis command can utilize configuration settings defined in a `sanity-typegen.json` file. These settings include:\n\n- \"path\": Specifies a glob pattern to locate your TypeScript or JavaScript files.\n Default: \"./src/**/*.{ts,tsx,js,jsx}\"\n\n- \"schema\": Defines the path to your Sanity schema file. This file should be generated using the `sanity schema extract` command.\n Default: \"schema.json\"\n\n- \"generates\": Indicates the path where the generated TypeScript type definitions will be saved.\n Default: \"./sanity.types.ts\"\n\nThe default configuration values listed above are used if not overridden in your `sanity-typegen.json` configuration file. To customize the behavior of the type generation, adjust these properties in the configuration file according to your project's needs.\n\nNote:\n- The `sanity schema extract` command is a prerequisite for extracting your Sanity Studio schema into a `schema.json` file, which is then used by the `sanity typegen generate` command to generate type definitions.",
5614
+ "description": "Sanity TypeGen\n\n\u001b[1mConfiguration:\u001b[22m\nThis command can utilize configuration settings defined in a `sanity-typegen.json` file. These settings include:\n\n- \"path\": Specifies a glob pattern to locate your TypeScript or JavaScript files.\n Default: \"./src/**/*.{ts,tsx,js,jsx}\"\n\n- \"schema\": Defines the path to your Sanity schema file. This file should be generated using the `sanity schema extract` command.\n Default: \"schema.json\"\n\n- \"generates\": Indicates the path where the generated TypeScript type definitions will be saved.\n Default: \"./sanity.types.ts\"\n\nThe default configuration values listed above are used if not overridden in your `sanity-typegen.json` configuration file. To customize the behavior of the type generation, adjust these properties in the configuration file according to your project's needs.\n\n\u001b[1mNote:\u001b[22m\n- The `sanity schema extract` command is a prerequisite for extracting your Sanity Studio schema into a `schema.json` file, which is then used by the `sanity typegen generate` command to generate type definitions.",
5455
5615
  "examples": [
5456
5616
  {
5457
5617
  "command": "<%= config.bin %> <%= command.id %>",
@@ -5895,166 +6055,6 @@
5895
6055
  "unlink.js"
5896
6056
  ]
5897
6057
  },
5898
- "datasets:embeddings:disable": {
5899
- "aliases": [],
5900
- "args": {
5901
- "dataset": {
5902
- "description": "Dataset name to disable embeddings for",
5903
- "name": "dataset",
5904
- "required": false
5905
- }
5906
- },
5907
- "description": "Disable embeddings for a dataset",
5908
- "examples": [
5909
- {
5910
- "command": "<%= config.bin %> <%= command.id %> production",
5911
- "description": "Disable embeddings for the production dataset"
5912
- }
5913
- ],
5914
- "flags": {
5915
- "project-id": {
5916
- "char": "p",
5917
- "description": "Project ID to disable embeddings for (overrides CLI configuration)",
5918
- "helpGroup": "OVERRIDE",
5919
- "name": "project-id",
5920
- "hasDynamicHelp": false,
5921
- "helpValue": "<id>",
5922
- "multiple": false,
5923
- "type": "option"
5924
- }
5925
- },
5926
- "hasDynamicHelp": false,
5927
- "hiddenAliases": [
5928
- "dataset:embeddings:disable"
5929
- ],
5930
- "id": "datasets:embeddings:disable",
5931
- "pluginAlias": "@sanity/cli",
5932
- "pluginName": "@sanity/cli",
5933
- "pluginType": "core",
5934
- "strict": true,
5935
- "isESM": true,
5936
- "relativePath": [
5937
- "dist",
5938
- "commands",
5939
- "datasets",
5940
- "embeddings",
5941
- "disable.js"
5942
- ]
5943
- },
5944
- "datasets:embeddings:enable": {
5945
- "aliases": [],
5946
- "args": {
5947
- "dataset": {
5948
- "description": "Dataset name to enable embeddings for",
5949
- "name": "dataset",
5950
- "required": false
5951
- }
5952
- },
5953
- "description": "Enable embeddings for a dataset",
5954
- "examples": [
5955
- {
5956
- "command": "<%= config.bin %> <%= command.id %> production",
5957
- "description": "Enable embeddings for the production dataset"
5958
- },
5959
- {
5960
- "command": "<%= config.bin %> <%= command.id %> production --projection \"{ title, body }\"",
5961
- "description": "Enable embeddings with a specific projection"
5962
- },
5963
- {
5964
- "command": "<%= config.bin %> <%= command.id %> production --wait",
5965
- "description": "Enable embeddings and wait for processing to complete"
5966
- }
5967
- ],
5968
- "flags": {
5969
- "project-id": {
5970
- "char": "p",
5971
- "description": "Project ID to enable embeddings for (overrides CLI configuration)",
5972
- "helpGroup": "OVERRIDE",
5973
- "name": "project-id",
5974
- "hasDynamicHelp": false,
5975
- "helpValue": "<id>",
5976
- "multiple": false,
5977
- "type": "option"
5978
- },
5979
- "projection": {
5980
- "description": "GROQ projection defining which fields to embed (e.g. \"{ title, body }\")",
5981
- "name": "projection",
5982
- "required": false,
5983
- "hasDynamicHelp": false,
5984
- "multiple": false,
5985
- "type": "option"
5986
- },
5987
- "wait": {
5988
- "description": "Wait for embeddings processing to complete before returning",
5989
- "name": "wait",
5990
- "allowNo": false,
5991
- "type": "boolean"
5992
- }
5993
- },
5994
- "hasDynamicHelp": false,
5995
- "hiddenAliases": [
5996
- "dataset:embeddings:enable"
5997
- ],
5998
- "id": "datasets:embeddings:enable",
5999
- "pluginAlias": "@sanity/cli",
6000
- "pluginName": "@sanity/cli",
6001
- "pluginType": "core",
6002
- "strict": true,
6003
- "isESM": true,
6004
- "relativePath": [
6005
- "dist",
6006
- "commands",
6007
- "datasets",
6008
- "embeddings",
6009
- "enable.js"
6010
- ]
6011
- },
6012
- "datasets:embeddings:status": {
6013
- "aliases": [],
6014
- "args": {
6015
- "dataset": {
6016
- "description": "The name of the dataset to check embeddings status for",
6017
- "name": "dataset",
6018
- "required": false
6019
- }
6020
- },
6021
- "description": "Show embeddings settings and status for a dataset",
6022
- "examples": [
6023
- {
6024
- "command": "<%= config.bin %> <%= command.id %> production",
6025
- "description": "Show embeddings status for the production dataset"
6026
- }
6027
- ],
6028
- "flags": {
6029
- "project-id": {
6030
- "char": "p",
6031
- "description": "Project ID to check embeddings status for (overrides CLI configuration)",
6032
- "helpGroup": "OVERRIDE",
6033
- "name": "project-id",
6034
- "hasDynamicHelp": false,
6035
- "helpValue": "<id>",
6036
- "multiple": false,
6037
- "type": "option"
6038
- }
6039
- },
6040
- "hasDynamicHelp": false,
6041
- "hiddenAliases": [
6042
- "dataset:embeddings:status"
6043
- ],
6044
- "id": "datasets:embeddings:status",
6045
- "pluginAlias": "@sanity/cli",
6046
- "pluginName": "@sanity/cli",
6047
- "pluginType": "core",
6048
- "strict": true,
6049
- "isESM": true,
6050
- "relativePath": [
6051
- "dist",
6052
- "commands",
6053
- "datasets",
6054
- "embeddings",
6055
- "status.js"
6056
- ]
6057
- },
6058
6058
  "datasets:visibility:get": {
6059
6059
  "aliases": [],
6060
6060
  "args": {
@@ -6161,5 +6161,5 @@
6161
6161
  ]
6162
6162
  }
6163
6163
  },
6164
- "version": "8.4.1"
6164
+ "version": "8.4.2"
6165
6165
  }