@sanity/cli 8.9.1 → 8.10.0

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.
@@ -737,6 +737,15 @@
737
737
  "allowNo": true,
738
738
  "type": "boolean"
739
739
  },
740
+ "install": {
741
+ "description": "Install dependencies after scaffolding",
742
+ "exclusive": [
743
+ "bare"
744
+ ],
745
+ "name": "install",
746
+ "allowNo": true,
747
+ "type": "boolean"
748
+ },
740
749
  "mcp": {
741
750
  "description": "Enable AI editor integration (MCP) setup",
742
751
  "name": "mcp",
@@ -1713,167 +1722,6 @@
1713
1722
  "list.js"
1714
1723
  ]
1715
1724
  },
1716
- "cors:add": {
1717
- "aliases": [],
1718
- "args": {
1719
- "origin": {
1720
- "description": "Origin to allow (e.g., https://example.com)",
1721
- "name": "origin",
1722
- "required": true
1723
- }
1724
- },
1725
- "description": "Add a CORS origin to the project",
1726
- "examples": [
1727
- {
1728
- "command": "<%= config.bin %> <%= command.id %>",
1729
- "description": "Interactively add a CORS origin"
1730
- },
1731
- {
1732
- "command": "<%= config.bin %> <%= command.id %> http://localhost:3000 --no-credentials",
1733
- "description": "Add a localhost origin without credentials"
1734
- },
1735
- {
1736
- "command": "<%= config.bin %> <%= command.id %> https://myapp.com --credentials",
1737
- "description": "Add a production origin with credentials allowed"
1738
- },
1739
- {
1740
- "command": "<%= config.bin %> <%= command.id %> https://myapp.com --project-id abc123",
1741
- "description": "Add a CORS origin for a specific project"
1742
- }
1743
- ],
1744
- "flags": {
1745
- "project-id": {
1746
- "char": "p",
1747
- "description": "Project ID to add CORS origin to (overrides CLI configuration)",
1748
- "helpGroup": "OVERRIDE",
1749
- "name": "project-id",
1750
- "hasDynamicHelp": false,
1751
- "helpValue": "<id>",
1752
- "multiple": false,
1753
- "type": "option"
1754
- },
1755
- "credentials": {
1756
- "description": "Allow credentials (token/cookie) to be sent from this origin",
1757
- "name": "credentials",
1758
- "required": false,
1759
- "allowNo": true,
1760
- "type": "boolean"
1761
- },
1762
- "yes": {
1763
- "char": "y",
1764
- "description": "Confirm risky wildcard origins without prompting",
1765
- "name": "yes",
1766
- "allowNo": false,
1767
- "type": "boolean"
1768
- }
1769
- },
1770
- "hasDynamicHelp": false,
1771
- "hiddenAliases": [],
1772
- "id": "cors:add",
1773
- "pluginAlias": "@sanity/cli",
1774
- "pluginName": "@sanity/cli",
1775
- "pluginType": "core",
1776
- "strict": true,
1777
- "isESM": true,
1778
- "relativePath": [
1779
- "dist",
1780
- "commands",
1781
- "cors",
1782
- "add.js"
1783
- ]
1784
- },
1785
- "cors:delete": {
1786
- "aliases": [],
1787
- "args": {
1788
- "origin": {
1789
- "description": "Origin to delete (will prompt if not provided)",
1790
- "name": "origin",
1791
- "required": false
1792
- }
1793
- },
1794
- "description": "Delete a CORS origin from the project",
1795
- "examples": [
1796
- {
1797
- "command": "<%= config.bin %> <%= command.id %>",
1798
- "description": "Interactively select and delete a CORS origin"
1799
- },
1800
- {
1801
- "command": "<%= config.bin %> <%= command.id %> https://example.com",
1802
- "description": "Delete a specific CORS origin"
1803
- },
1804
- {
1805
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
1806
- "description": "Delete a CORS origin from a specific project"
1807
- }
1808
- ],
1809
- "flags": {
1810
- "project-id": {
1811
- "char": "p",
1812
- "description": "Project ID to delete CORS origin from (overrides CLI configuration)",
1813
- "helpGroup": "OVERRIDE",
1814
- "name": "project-id",
1815
- "hasDynamicHelp": false,
1816
- "helpValue": "<id>",
1817
- "multiple": false,
1818
- "type": "option"
1819
- }
1820
- },
1821
- "hasDynamicHelp": false,
1822
- "hiddenAliases": [],
1823
- "id": "cors:delete",
1824
- "pluginAlias": "@sanity/cli",
1825
- "pluginName": "@sanity/cli",
1826
- "pluginType": "core",
1827
- "strict": true,
1828
- "isESM": true,
1829
- "relativePath": [
1830
- "dist",
1831
- "commands",
1832
- "cors",
1833
- "delete.js"
1834
- ]
1835
- },
1836
- "cors:list": {
1837
- "aliases": [],
1838
- "args": {},
1839
- "description": "List CORS origins for the project",
1840
- "examples": [
1841
- {
1842
- "command": "<%= config.bin %> <%= command.id %>",
1843
- "description": "List CORS origins for the project"
1844
- },
1845
- {
1846
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
1847
- "description": "List CORS origins for a specific project"
1848
- }
1849
- ],
1850
- "flags": {
1851
- "project-id": {
1852
- "char": "p",
1853
- "description": "Project ID to list CORS origins for (overrides CLI configuration)",
1854
- "helpGroup": "OVERRIDE",
1855
- "name": "project-id",
1856
- "hasDynamicHelp": false,
1857
- "helpValue": "<id>",
1858
- "multiple": false,
1859
- "type": "option"
1860
- }
1861
- },
1862
- "hasDynamicHelp": false,
1863
- "hiddenAliases": [],
1864
- "id": "cors:list",
1865
- "pluginAlias": "@sanity/cli",
1866
- "pluginName": "@sanity/cli",
1867
- "pluginType": "core",
1868
- "strict": true,
1869
- "isESM": true,
1870
- "relativePath": [
1871
- "dist",
1872
- "commands",
1873
- "cors",
1874
- "list.js"
1875
- ]
1876
- },
1877
1725
  "context:build": {
1878
1726
  "aliases": [],
1879
1727
  "args": {
@@ -2261,63 +2109,38 @@
2261
2109
  "update.js"
2262
2110
  ]
2263
2111
  },
2264
- "datasets:copy": {
2112
+ "cors:add": {
2265
2113
  "aliases": [],
2266
2114
  "args": {
2267
- "source": {
2268
- "description": "Name of the dataset to copy from",
2269
- "name": "source",
2270
- "required": false
2271
- },
2272
- "target": {
2273
- "description": "Name of the dataset to copy to",
2274
- "name": "target",
2275
- "required": false
2115
+ "origin": {
2116
+ "description": "Origin to allow (e.g., https://example.com)",
2117
+ "name": "origin",
2118
+ "required": true
2276
2119
  }
2277
2120
  },
2278
- "description": "Copy a dataset or manage copy jobs",
2121
+ "description": "Add a CORS origin to the project",
2279
2122
  "examples": [
2280
2123
  {
2281
2124
  "command": "<%= config.bin %> <%= command.id %>",
2282
- "description": "Interactively copy a dataset"
2283
- },
2284
- {
2285
- "command": "<%= config.bin %> <%= command.id %> source-dataset",
2286
- "description": "Copy from source-dataset (prompts for target)"
2287
- },
2288
- {
2289
- "command": "<%= config.bin %> <%= command.id %> source-dataset target-dataset",
2290
- "description": "Copy from source-dataset to target-dataset"
2291
- },
2292
- {
2293
- "command": "<%= config.bin %> <%= command.id %> --skip-history source target",
2294
- "description": "Copy without preserving document history (faster for large datasets)"
2295
- },
2296
- {
2297
- "command": "<%= config.bin %> <%= command.id %> --skip-content-releases source target",
2298
- "description": "Copy without content release documents"
2299
- },
2300
- {
2301
- "command": "<%= config.bin %> <%= command.id %> --detach source target",
2302
- "description": "Start copy job without waiting for completion"
2125
+ "description": "Interactively add a CORS origin"
2303
2126
  },
2304
2127
  {
2305
- "command": "<%= config.bin %> <%= command.id %> --attach <job-id>",
2306
- "description": "Attach to a running copy job to follow progress"
2128
+ "command": "<%= config.bin %> <%= command.id %> http://localhost:3000 --no-credentials",
2129
+ "description": "Add a localhost origin without credentials"
2307
2130
  },
2308
2131
  {
2309
- "command": "<%= config.bin %> <%= command.id %> --list",
2310
- "description": "List all dataset copy jobs"
2132
+ "command": "<%= config.bin %> <%= command.id %> https://myapp.com --credentials",
2133
+ "description": "Add a production origin with credentials allowed"
2311
2134
  },
2312
2135
  {
2313
- "command": "<%= config.bin %> <%= command.id %> --list --offset 2 --limit 10",
2314
- "description": "List copy jobs with pagination"
2136
+ "command": "<%= config.bin %> <%= command.id %> https://myapp.com --project-id abc123",
2137
+ "description": "Add a CORS origin for a specific project"
2315
2138
  }
2316
2139
  ],
2317
2140
  "flags": {
2318
2141
  "project-id": {
2319
2142
  "char": "p",
2320
- "description": "Project ID to copy dataset in (overrides CLI configuration)",
2143
+ "description": "Project ID to add CORS origin to (overrides CLI configuration)",
2321
2144
  "helpGroup": "OVERRIDE",
2322
2145
  "name": "project-id",
2323
2146
  "hasDynamicHelp": false,
@@ -2325,37 +2148,223 @@
2325
2148
  "multiple": false,
2326
2149
  "type": "option"
2327
2150
  },
2328
- "attach": {
2329
- "description": "Attach to the running copy process to show progress",
2330
- "exclusive": [
2331
- "list",
2332
- "detach",
2333
- "skip-history"
2334
- ],
2335
- "name": "attach",
2151
+ "credentials": {
2152
+ "description": "Allow credentials (token/cookie) to be sent from this origin",
2153
+ "name": "credentials",
2336
2154
  "required": false,
2337
- "hasDynamicHelp": false,
2338
- "multiple": false,
2339
- "type": "option"
2155
+ "allowNo": true,
2156
+ "type": "boolean"
2340
2157
  },
2341
- "detach": {
2342
- "description": "Start the copy without waiting for it to finish",
2343
- "exclusive": [
2344
- "list",
2345
- "attach"
2346
- ],
2347
- "name": "detach",
2348
- "required": false,
2158
+ "yes": {
2159
+ "char": "y",
2160
+ "description": "Confirm risky wildcard origins without prompting",
2161
+ "name": "yes",
2349
2162
  "allowNo": false,
2350
2163
  "type": "boolean"
2351
- },
2352
- "limit": {
2353
- "dependsOn": [
2354
- "list"
2355
- ],
2356
- "description": "Maximum number of jobs returned (default 10, max 1000)",
2357
- "name": "limit",
2358
- "required": false,
2164
+ }
2165
+ },
2166
+ "hasDynamicHelp": false,
2167
+ "hiddenAliases": [],
2168
+ "id": "cors:add",
2169
+ "pluginAlias": "@sanity/cli",
2170
+ "pluginName": "@sanity/cli",
2171
+ "pluginType": "core",
2172
+ "strict": true,
2173
+ "isESM": true,
2174
+ "relativePath": [
2175
+ "dist",
2176
+ "commands",
2177
+ "cors",
2178
+ "add.js"
2179
+ ]
2180
+ },
2181
+ "cors:delete": {
2182
+ "aliases": [],
2183
+ "args": {
2184
+ "origin": {
2185
+ "description": "Origin to delete (will prompt if not provided)",
2186
+ "name": "origin",
2187
+ "required": false
2188
+ }
2189
+ },
2190
+ "description": "Delete a CORS origin from the project",
2191
+ "examples": [
2192
+ {
2193
+ "command": "<%= config.bin %> <%= command.id %>",
2194
+ "description": "Interactively select and delete a CORS origin"
2195
+ },
2196
+ {
2197
+ "command": "<%= config.bin %> <%= command.id %> https://example.com",
2198
+ "description": "Delete a specific CORS origin"
2199
+ },
2200
+ {
2201
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
2202
+ "description": "Delete a CORS origin from a specific project"
2203
+ }
2204
+ ],
2205
+ "flags": {
2206
+ "project-id": {
2207
+ "char": "p",
2208
+ "description": "Project ID to delete CORS origin from (overrides CLI configuration)",
2209
+ "helpGroup": "OVERRIDE",
2210
+ "name": "project-id",
2211
+ "hasDynamicHelp": false,
2212
+ "helpValue": "<id>",
2213
+ "multiple": false,
2214
+ "type": "option"
2215
+ }
2216
+ },
2217
+ "hasDynamicHelp": false,
2218
+ "hiddenAliases": [],
2219
+ "id": "cors:delete",
2220
+ "pluginAlias": "@sanity/cli",
2221
+ "pluginName": "@sanity/cli",
2222
+ "pluginType": "core",
2223
+ "strict": true,
2224
+ "isESM": true,
2225
+ "relativePath": [
2226
+ "dist",
2227
+ "commands",
2228
+ "cors",
2229
+ "delete.js"
2230
+ ]
2231
+ },
2232
+ "cors:list": {
2233
+ "aliases": [],
2234
+ "args": {},
2235
+ "description": "List CORS origins for the project",
2236
+ "examples": [
2237
+ {
2238
+ "command": "<%= config.bin %> <%= command.id %>",
2239
+ "description": "List CORS origins for the project"
2240
+ },
2241
+ {
2242
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
2243
+ "description": "List CORS origins for a specific project"
2244
+ }
2245
+ ],
2246
+ "flags": {
2247
+ "project-id": {
2248
+ "char": "p",
2249
+ "description": "Project ID to list CORS origins for (overrides CLI configuration)",
2250
+ "helpGroup": "OVERRIDE",
2251
+ "name": "project-id",
2252
+ "hasDynamicHelp": false,
2253
+ "helpValue": "<id>",
2254
+ "multiple": false,
2255
+ "type": "option"
2256
+ }
2257
+ },
2258
+ "hasDynamicHelp": false,
2259
+ "hiddenAliases": [],
2260
+ "id": "cors:list",
2261
+ "pluginAlias": "@sanity/cli",
2262
+ "pluginName": "@sanity/cli",
2263
+ "pluginType": "core",
2264
+ "strict": true,
2265
+ "isESM": true,
2266
+ "relativePath": [
2267
+ "dist",
2268
+ "commands",
2269
+ "cors",
2270
+ "list.js"
2271
+ ]
2272
+ },
2273
+ "datasets:copy": {
2274
+ "aliases": [],
2275
+ "args": {
2276
+ "source": {
2277
+ "description": "Name of the dataset to copy from",
2278
+ "name": "source",
2279
+ "required": false
2280
+ },
2281
+ "target": {
2282
+ "description": "Name of the dataset to copy to",
2283
+ "name": "target",
2284
+ "required": false
2285
+ }
2286
+ },
2287
+ "description": "Copy a dataset or manage copy jobs",
2288
+ "examples": [
2289
+ {
2290
+ "command": "<%= config.bin %> <%= command.id %>",
2291
+ "description": "Interactively copy a dataset"
2292
+ },
2293
+ {
2294
+ "command": "<%= config.bin %> <%= command.id %> source-dataset",
2295
+ "description": "Copy from source-dataset (prompts for target)"
2296
+ },
2297
+ {
2298
+ "command": "<%= config.bin %> <%= command.id %> source-dataset target-dataset",
2299
+ "description": "Copy from source-dataset to target-dataset"
2300
+ },
2301
+ {
2302
+ "command": "<%= config.bin %> <%= command.id %> --skip-history source target",
2303
+ "description": "Copy without preserving document history (faster for large datasets)"
2304
+ },
2305
+ {
2306
+ "command": "<%= config.bin %> <%= command.id %> --skip-content-releases source target",
2307
+ "description": "Copy without content release documents"
2308
+ },
2309
+ {
2310
+ "command": "<%= config.bin %> <%= command.id %> --detach source target",
2311
+ "description": "Start copy job without waiting for completion"
2312
+ },
2313
+ {
2314
+ "command": "<%= config.bin %> <%= command.id %> --attach <job-id>",
2315
+ "description": "Attach to a running copy job to follow progress"
2316
+ },
2317
+ {
2318
+ "command": "<%= config.bin %> <%= command.id %> --list",
2319
+ "description": "List all dataset copy jobs"
2320
+ },
2321
+ {
2322
+ "command": "<%= config.bin %> <%= command.id %> --list --offset 2 --limit 10",
2323
+ "description": "List copy jobs with pagination"
2324
+ }
2325
+ ],
2326
+ "flags": {
2327
+ "project-id": {
2328
+ "char": "p",
2329
+ "description": "Project ID to copy dataset in (overrides CLI configuration)",
2330
+ "helpGroup": "OVERRIDE",
2331
+ "name": "project-id",
2332
+ "hasDynamicHelp": false,
2333
+ "helpValue": "<id>",
2334
+ "multiple": false,
2335
+ "type": "option"
2336
+ },
2337
+ "attach": {
2338
+ "description": "Attach to the running copy process to show progress",
2339
+ "exclusive": [
2340
+ "list",
2341
+ "detach",
2342
+ "skip-history"
2343
+ ],
2344
+ "name": "attach",
2345
+ "required": false,
2346
+ "hasDynamicHelp": false,
2347
+ "multiple": false,
2348
+ "type": "option"
2349
+ },
2350
+ "detach": {
2351
+ "description": "Start the copy without waiting for it to finish",
2352
+ "exclusive": [
2353
+ "list",
2354
+ "attach"
2355
+ ],
2356
+ "name": "detach",
2357
+ "required": false,
2358
+ "allowNo": false,
2359
+ "type": "boolean"
2360
+ },
2361
+ "limit": {
2362
+ "dependsOn": [
2363
+ "list"
2364
+ ],
2365
+ "description": "Maximum number of jobs returned (default 10, max 1000)",
2366
+ "name": "limit",
2367
+ "required": false,
2359
2368
  "hasDynamicHelp": false,
2360
2369
  "multiple": false,
2361
2370
  "type": "option"
@@ -2883,37 +2892,161 @@
2883
2892
  "list.js"
2884
2893
  ]
2885
2894
  },
2886
- "documents:create": {
2895
+ "docs:browse": {
2896
+ "aliases": [],
2897
+ "args": {},
2898
+ "description": "Open Sanity docs in your browser",
2899
+ "flags": {},
2900
+ "hasDynamicHelp": false,
2901
+ "hiddenAliases": [],
2902
+ "id": "docs:browse",
2903
+ "pluginAlias": "@sanity/cli",
2904
+ "pluginName": "@sanity/cli",
2905
+ "pluginType": "core",
2906
+ "strict": true,
2907
+ "enableJsonFlag": false,
2908
+ "isESM": true,
2909
+ "relativePath": [
2910
+ "dist",
2911
+ "commands",
2912
+ "docs",
2913
+ "browse.js"
2914
+ ]
2915
+ },
2916
+ "docs:read": {
2887
2917
  "aliases": [],
2888
2918
  "args": {
2889
- "file": {
2890
- "description": "JSON file to create document(s) from",
2891
- "name": "file",
2892
- "required": false
2919
+ "path": {
2920
+ "description": "Path or URL to article, found in search results and docs content as links",
2921
+ "name": "path",
2922
+ "required": true
2893
2923
  }
2894
2924
  },
2895
- "description": "Create one or more documents",
2925
+ "description": "Read an article in terminal",
2896
2926
  "examples": [
2897
2927
  {
2898
- "command": "<%= config.bin %> <%= command.id %> myDocument.json",
2899
- "description": "Create the document specified in \"myDocument.json\""
2900
- },
2901
- {
2902
- "command": "<%= config.bin %> <%= command.id %>",
2903
- "description": "Open configured $EDITOR and create the specified document(s)"
2928
+ "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation",
2929
+ "description": "Read as markdown in terminal"
2904
2930
  },
2905
2931
  {
2906
- "command": "<%= config.bin %> <%= command.id %> --id myDocId --replace",
2907
- "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"
2932
+ "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation",
2933
+ "description": "Read using full URL"
2908
2934
  },
2909
2935
  {
2910
- "command": "<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5",
2911
- "description": "Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax."
2936
+ "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation --web",
2937
+ "description": "Open in web browser"
2912
2938
  },
2913
2939
  {
2914
- "command": "<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123",
2915
- "description": "Create documents in a specific project"
2916
- }
2940
+ "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation -w",
2941
+ "description": "Open using full URL in web browser"
2942
+ }
2943
+ ],
2944
+ "flags": {
2945
+ "web": {
2946
+ "aliases": [
2947
+ "w"
2948
+ ],
2949
+ "description": "Open in a web browser",
2950
+ "name": "web",
2951
+ "allowNo": false,
2952
+ "type": "boolean"
2953
+ }
2954
+ },
2955
+ "hasDynamicHelp": false,
2956
+ "hiddenAliases": [],
2957
+ "id": "docs:read",
2958
+ "pluginAlias": "@sanity/cli",
2959
+ "pluginName": "@sanity/cli",
2960
+ "pluginType": "core",
2961
+ "strict": true,
2962
+ "isESM": true,
2963
+ "relativePath": [
2964
+ "dist",
2965
+ "commands",
2966
+ "docs",
2967
+ "read.js"
2968
+ ]
2969
+ },
2970
+ "docs:search": {
2971
+ "aliases": [],
2972
+ "args": {
2973
+ "query": {
2974
+ "description": "Search query for documentation",
2975
+ "name": "query",
2976
+ "required": true
2977
+ }
2978
+ },
2979
+ "description": "Search Sanity docs",
2980
+ "examples": [
2981
+ {
2982
+ "command": "<%= config.bin %> <%= command.id %> schema",
2983
+ "description": "Search for documentation about schemas"
2984
+ },
2985
+ {
2986
+ "command": "<%= config.bin %> <%= command.id %> \"groq functions\"",
2987
+ "description": "Search with phrase"
2988
+ },
2989
+ {
2990
+ "command": "<%= config.bin %> <%= command.id %> \"deployment\" --limit=5",
2991
+ "description": "Limit search results"
2992
+ }
2993
+ ],
2994
+ "flags": {
2995
+ "limit": {
2996
+ "description": "Maximum number of results to return",
2997
+ "name": "limit",
2998
+ "default": 10,
2999
+ "hasDynamicHelp": false,
3000
+ "multiple": false,
3001
+ "type": "option"
3002
+ }
3003
+ },
3004
+ "hasDynamicHelp": false,
3005
+ "hiddenAliases": [],
3006
+ "id": "docs:search",
3007
+ "pluginAlias": "@sanity/cli",
3008
+ "pluginName": "@sanity/cli",
3009
+ "pluginType": "core",
3010
+ "strict": true,
3011
+ "isESM": true,
3012
+ "relativePath": [
3013
+ "dist",
3014
+ "commands",
3015
+ "docs",
3016
+ "search.js"
3017
+ ]
3018
+ },
3019
+ "documents:create": {
3020
+ "aliases": [],
3021
+ "args": {
3022
+ "file": {
3023
+ "description": "JSON file to create document(s) from",
3024
+ "name": "file",
3025
+ "required": false
3026
+ }
3027
+ },
3028
+ "description": "Create one or more documents",
3029
+ "examples": [
3030
+ {
3031
+ "command": "<%= config.bin %> <%= command.id %> myDocument.json",
3032
+ "description": "Create the document specified in \"myDocument.json\""
3033
+ },
3034
+ {
3035
+ "command": "<%= config.bin %> <%= command.id %>",
3036
+ "description": "Open configured $EDITOR and create the specified document(s)"
3037
+ },
3038
+ {
3039
+ "command": "<%= config.bin %> <%= command.id %> --id myDocId --replace",
3040
+ "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"
3041
+ },
3042
+ {
3043
+ "command": "<%= config.bin %> <%= command.id %> --id myDocId --watch --replace --json5",
3044
+ "description": "Open configured $EDITOR and replace the document with the given content on each save. Use JSON5 file extension and parser for simplified syntax."
3045
+ },
3046
+ {
3047
+ "command": "<%= config.bin %> <%= command.id %> myDocument.json --project-id abc123",
3048
+ "description": "Create documents in a specific project"
3049
+ }
2917
3050
  ],
2918
3051
  "flags": {
2919
3052
  "project-id": {
@@ -3356,130 +3489,6 @@
3356
3489
  "validate.js"
3357
3490
  ]
3358
3491
  },
3359
- "docs:browse": {
3360
- "aliases": [],
3361
- "args": {},
3362
- "description": "Open Sanity docs in your browser",
3363
- "flags": {},
3364
- "hasDynamicHelp": false,
3365
- "hiddenAliases": [],
3366
- "id": "docs:browse",
3367
- "pluginAlias": "@sanity/cli",
3368
- "pluginName": "@sanity/cli",
3369
- "pluginType": "core",
3370
- "strict": true,
3371
- "enableJsonFlag": false,
3372
- "isESM": true,
3373
- "relativePath": [
3374
- "dist",
3375
- "commands",
3376
- "docs",
3377
- "browse.js"
3378
- ]
3379
- },
3380
- "docs:read": {
3381
- "aliases": [],
3382
- "args": {
3383
- "path": {
3384
- "description": "Path or URL to article, found in search results and docs content as links",
3385
- "name": "path",
3386
- "required": true
3387
- }
3388
- },
3389
- "description": "Read an article in terminal",
3390
- "examples": [
3391
- {
3392
- "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation",
3393
- "description": "Read as markdown in terminal"
3394
- },
3395
- {
3396
- "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation",
3397
- "description": "Read using full URL"
3398
- },
3399
- {
3400
- "command": "<%= config.bin %> <%= command.id %> /docs/studio/installation --web",
3401
- "description": "Open in web browser"
3402
- },
3403
- {
3404
- "command": "<%= config.bin %> <%= command.id %> https://www.sanity.io/docs/studio/installation -w",
3405
- "description": "Open using full URL in web browser"
3406
- }
3407
- ],
3408
- "flags": {
3409
- "web": {
3410
- "aliases": [
3411
- "w"
3412
- ],
3413
- "description": "Open in a web browser",
3414
- "name": "web",
3415
- "allowNo": false,
3416
- "type": "boolean"
3417
- }
3418
- },
3419
- "hasDynamicHelp": false,
3420
- "hiddenAliases": [],
3421
- "id": "docs:read",
3422
- "pluginAlias": "@sanity/cli",
3423
- "pluginName": "@sanity/cli",
3424
- "pluginType": "core",
3425
- "strict": true,
3426
- "isESM": true,
3427
- "relativePath": [
3428
- "dist",
3429
- "commands",
3430
- "docs",
3431
- "read.js"
3432
- ]
3433
- },
3434
- "docs:search": {
3435
- "aliases": [],
3436
- "args": {
3437
- "query": {
3438
- "description": "Search query for documentation",
3439
- "name": "query",
3440
- "required": true
3441
- }
3442
- },
3443
- "description": "Search Sanity docs",
3444
- "examples": [
3445
- {
3446
- "command": "<%= config.bin %> <%= command.id %> schema",
3447
- "description": "Search for documentation about schemas"
3448
- },
3449
- {
3450
- "command": "<%= config.bin %> <%= command.id %> \"groq functions\"",
3451
- "description": "Search with phrase"
3452
- },
3453
- {
3454
- "command": "<%= config.bin %> <%= command.id %> \"deployment\" --limit=5",
3455
- "description": "Limit search results"
3456
- }
3457
- ],
3458
- "flags": {
3459
- "limit": {
3460
- "description": "Maximum number of results to return",
3461
- "name": "limit",
3462
- "default": 10,
3463
- "hasDynamicHelp": false,
3464
- "multiple": false,
3465
- "type": "option"
3466
- }
3467
- },
3468
- "hasDynamicHelp": false,
3469
- "hiddenAliases": [],
3470
- "id": "docs:search",
3471
- "pluginAlias": "@sanity/cli",
3472
- "pluginName": "@sanity/cli",
3473
- "pluginType": "core",
3474
- "strict": true,
3475
- "isESM": true,
3476
- "relativePath": [
3477
- "dist",
3478
- "commands",
3479
- "docs",
3480
- "search.js"
3481
- ]
3482
- },
3483
3492
  "graphql:deploy": {
3484
3493
  "aliases": [],
3485
3494
  "args": {},
@@ -3731,29 +3740,94 @@
3731
3740
  "undeploy.js"
3732
3741
  ]
3733
3742
  },
3734
- "hooks:attempt": {
3743
+ "manifest:extract": {
3735
3744
  "aliases": [],
3736
- "args": {
3737
- "attemptId": {
3738
- "description": "The delivery attempt ID to get details for",
3739
- "name": "attemptId",
3740
- "required": true
3741
- }
3742
- },
3743
- "description": "Print details of a given webhook delivery attempt",
3745
+ "args": {},
3746
+ "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.",
3744
3747
  "examples": [
3745
3748
  {
3746
- "command": "<%= config.bin %> <%= command.id %> abc123",
3747
- "description": "Print details of webhook delivery attempt with ID abc123"
3749
+ "command": "<%= config.bin %> <%= command.id %>",
3750
+ "description": "Extracts manifests"
3748
3751
  },
3749
3752
  {
3750
- "command": "<%= config.bin %> <%= command.id %> abc123 --project-id projectId",
3751
- "description": "Get attempt details for a specific project"
3753
+ "command": "<%= config.bin %> <%= command.id %> --path /public/static",
3754
+ "description": "Extracts manifests into /public/static"
3752
3755
  }
3753
3756
  ],
3754
3757
  "flags": {
3755
- "project-id": {
3756
- "char": "p",
3758
+ "path": {
3759
+ "description": "Optional path to specify destination directory of the manifest files",
3760
+ "name": "path",
3761
+ "default": "dist/static",
3762
+ "hasDynamicHelp": false,
3763
+ "multiple": false,
3764
+ "type": "option"
3765
+ }
3766
+ },
3767
+ "hasDynamicHelp": false,
3768
+ "hiddenAliases": [],
3769
+ "id": "manifest:extract",
3770
+ "pluginAlias": "@sanity/cli",
3771
+ "pluginName": "@sanity/cli",
3772
+ "pluginType": "core",
3773
+ "strict": true,
3774
+ "isESM": true,
3775
+ "relativePath": [
3776
+ "dist",
3777
+ "commands",
3778
+ "manifest",
3779
+ "extract.js"
3780
+ ]
3781
+ },
3782
+ "mcp:configure": {
3783
+ "aliases": [],
3784
+ "args": {},
3785
+ "description": "Configure Sanity MCP server for AI editors (Antigravity, Claude Code, Cline, Cline CLI, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, MCPorter, OpenCode, VS Code, VS Code Insiders, Zed)",
3786
+ "examples": [
3787
+ {
3788
+ "command": "<%= config.bin %> <%= command.id %>",
3789
+ "description": "Configure Sanity MCP server for detected AI editors"
3790
+ }
3791
+ ],
3792
+ "flags": {},
3793
+ "hasDynamicHelp": false,
3794
+ "hiddenAliases": [],
3795
+ "id": "mcp:configure",
3796
+ "pluginAlias": "@sanity/cli",
3797
+ "pluginName": "@sanity/cli",
3798
+ "pluginType": "core",
3799
+ "strict": true,
3800
+ "isESM": true,
3801
+ "relativePath": [
3802
+ "dist",
3803
+ "commands",
3804
+ "mcp",
3805
+ "configure.js"
3806
+ ]
3807
+ },
3808
+ "hooks:attempt": {
3809
+ "aliases": [],
3810
+ "args": {
3811
+ "attemptId": {
3812
+ "description": "The delivery attempt ID to get details for",
3813
+ "name": "attemptId",
3814
+ "required": true
3815
+ }
3816
+ },
3817
+ "description": "Print details of a given webhook delivery attempt",
3818
+ "examples": [
3819
+ {
3820
+ "command": "<%= config.bin %> <%= command.id %> abc123",
3821
+ "description": "Print details of webhook delivery attempt with ID abc123"
3822
+ },
3823
+ {
3824
+ "command": "<%= config.bin %> <%= command.id %> abc123 --project-id projectId",
3825
+ "description": "Get attempt details for a specific project"
3826
+ }
3827
+ ],
3828
+ "flags": {
3829
+ "project-id": {
3830
+ "char": "p",
3757
3831
  "description": "Project ID to view webhook attempt for (overrides CLI configuration)",
3758
3832
  "helpGroup": "OVERRIDE",
3759
3833
  "name": "project-id",
@@ -3979,32 +4053,6 @@
3979
4053
  "logs.js"
3980
4054
  ]
3981
4055
  },
3982
- "mcp:configure": {
3983
- "aliases": [],
3984
- "args": {},
3985
- "description": "Configure Sanity MCP server for AI editors (Antigravity, Claude Code, Cline, Cline CLI, Codex CLI, Cursor, Gemini CLI, GitHub Copilot CLI, MCPorter, OpenCode, VS Code, VS Code Insiders, Zed)",
3986
- "examples": [
3987
- {
3988
- "command": "<%= config.bin %> <%= command.id %>",
3989
- "description": "Configure Sanity MCP server for detected AI editors"
3990
- }
3991
- ],
3992
- "flags": {},
3993
- "hasDynamicHelp": false,
3994
- "hiddenAliases": [],
3995
- "id": "mcp:configure",
3996
- "pluginAlias": "@sanity/cli",
3997
- "pluginName": "@sanity/cli",
3998
- "pluginType": "core",
3999
- "strict": true,
4000
- "isESM": true,
4001
- "relativePath": [
4002
- "dist",
4003
- "commands",
4004
- "mcp",
4005
- "configure.js"
4006
- ]
4007
- },
4008
4056
  "media:create-aspect": {
4009
4057
  "aliases": [],
4010
4058
  "args": {},
@@ -4468,45 +4516,6 @@
4468
4516
  "run.js"
4469
4517
  ]
4470
4518
  },
4471
- "manifest:extract": {
4472
- "aliases": [],
4473
- "args": {},
4474
- "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.",
4475
- "examples": [
4476
- {
4477
- "command": "<%= config.bin %> <%= command.id %>",
4478
- "description": "Extracts manifests"
4479
- },
4480
- {
4481
- "command": "<%= config.bin %> <%= command.id %> --path /public/static",
4482
- "description": "Extracts manifests into /public/static"
4483
- }
4484
- ],
4485
- "flags": {
4486
- "path": {
4487
- "description": "Optional path to specify destination directory of the manifest files",
4488
- "name": "path",
4489
- "default": "dist/static",
4490
- "hasDynamicHelp": false,
4491
- "multiple": false,
4492
- "type": "option"
4493
- }
4494
- },
4495
- "hasDynamicHelp": false,
4496
- "hiddenAliases": [],
4497
- "id": "manifest:extract",
4498
- "pluginAlias": "@sanity/cli",
4499
- "pluginName": "@sanity/cli",
4500
- "pluginType": "core",
4501
- "strict": true,
4502
- "isESM": true,
4503
- "relativePath": [
4504
- "dist",
4505
- "commands",
4506
- "manifest",
4507
- "extract.js"
4508
- ]
4509
- },
4510
4519
  "openapi:get": {
4511
4520
  "aliases": [],
4512
4521
  "args": {
@@ -4866,73 +4875,74 @@
4866
4875
  "update.js"
4867
4876
  ]
4868
4877
  },
4869
- "schemas:delete": {
4878
+ "projects:create": {
4870
4879
  "aliases": [],
4871
- "args": {},
4872
- "description": "Delete schema documents by id",
4880
+ "args": {
4881
+ "projectName": {
4882
+ "description": "Name of the project to create",
4883
+ "name": "projectName",
4884
+ "required": false
4885
+ }
4886
+ },
4887
+ "description": "Create a new Sanity project",
4873
4888
  "examples": [
4874
4889
  {
4875
- "command": "<%= config.bin %> <%= command.id %> --ids sanity.workspace.schema.workspaceName",
4876
- "description": "Delete a single schema"
4890
+ "command": "<%= config.bin %> <%= command.id %>",
4891
+ "description": "Interactively create a project"
4877
4892
  },
4878
4893
  {
4879
- "command": "<%= config.bin %> <%= command.id %> --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace",
4880
- "description": "Delete multiple schemas"
4894
+ "command": "<%= config.bin %> <%= command.id %> \"My New Project\"",
4895
+ "description": "Create a project named \"My New Project\""
4896
+ },
4897
+ {
4898
+ "command": "<%= config.bin %> <%= command.id %> \"My Project\" --organization=my-org",
4899
+ "description": "Create a project in a specific organization"
4900
+ },
4901
+ {
4902
+ "command": "<%= config.bin %> <%= command.id %> \"My Project\" --dataset=staging --dataset-visibility=private",
4903
+ "description": "Create a project with a private dataset named \"staging\""
4904
+ },
4905
+ {
4906
+ "command": "<%= config.bin %> <%= command.id %> \"CI Project\" --yes --json",
4907
+ "description": "Create a project non-interactively with JSON output"
4881
4908
  }
4882
4909
  ],
4883
4910
  "flags": {
4884
- "project-id": {
4885
- "char": "p",
4886
- "description": "Project ID to delete schema from (overrides CLI configuration)",
4887
- "helpGroup": "OVERRIDE",
4888
- "name": "project-id",
4889
- "hasDynamicHelp": false,
4890
- "helpValue": "<id>",
4891
- "multiple": false,
4892
- "type": "option"
4893
- },
4894
4911
  "dataset": {
4895
- "char": "d",
4896
- "description": "Delete schemas from a specific dataset",
4912
+ "description": "Create a dataset. Prompts for visibility unless specified or --yes used",
4897
4913
  "name": "dataset",
4898
4914
  "hasDynamicHelp": false,
4899
- "helpValue": "<name>",
4900
4915
  "multiple": false,
4901
4916
  "type": "option"
4902
4917
  },
4903
- "extract-manifest": {
4904
- "description": "Generate manifest file (disable with --no-extract-manifest)",
4905
- "hidden": true,
4906
- "name": "extract-manifest",
4907
- "allowNo": true,
4908
- "type": "boolean"
4909
- },
4910
- "ids": {
4911
- "description": "Comma-separated list of schema ids to delete",
4912
- "name": "ids",
4913
- "required": true,
4918
+ "dataset-visibility": {
4919
+ "description": "Dataset visibility: public or private",
4920
+ "name": "dataset-visibility",
4914
4921
  "hasDynamicHelp": false,
4915
4922
  "multiple": false,
4923
+ "options": [
4924
+ "private",
4925
+ "public"
4926
+ ],
4916
4927
  "type": "option"
4917
4928
  },
4918
- "manifest-dir": {
4919
- "description": "Directory containing manifest file",
4920
- "hidden": true,
4921
- "name": "manifest-dir",
4922
- "default": "./dist/static",
4929
+ "json": {
4930
+ "description": "Output in JSON format",
4931
+ "name": "json",
4932
+ "allowNo": false,
4933
+ "type": "boolean"
4934
+ },
4935
+ "organization": {
4936
+ "description": "Organization to create the project in",
4937
+ "name": "organization",
4923
4938
  "hasDynamicHelp": false,
4939
+ "helpValue": "<slug|id>",
4924
4940
  "multiple": false,
4925
4941
  "type": "option"
4926
4942
  },
4927
- "verbose": {
4928
- "description": "Enable verbose logging",
4929
- "name": "verbose",
4930
- "allowNo": false,
4931
- "type": "boolean"
4932
- },
4933
4943
  "yes": {
4934
4944
  "char": "y",
4935
- "description": "Delete schemas without prompting for confirmation",
4945
+ "description": "Skip prompts and use defaults (project: \"My Sanity Project\", dataset: production, visibility: public)",
4936
4946
  "name": "yes",
4937
4947
  "allowNo": false,
4938
4948
  "type": "boolean"
@@ -4940,9 +4950,9 @@
4940
4950
  },
4941
4951
  "hasDynamicHelp": false,
4942
4952
  "hiddenAliases": [
4943
- "schema:delete"
4953
+ "project:create"
4944
4954
  ],
4945
- "id": "schemas:delete",
4955
+ "id": "projects:create",
4946
4956
  "pluginAlias": "@sanity/cli",
4947
4957
  "pluginName": "@sanity/cli",
4948
4958
  "pluginType": "core",
@@ -4951,38 +4961,227 @@
4951
4961
  "relativePath": [
4952
4962
  "dist",
4953
4963
  "commands",
4954
- "schemas",
4955
- "delete.js"
4964
+ "projects",
4965
+ "create.js"
4956
4966
  ]
4957
4967
  },
4958
- "schemas:deploy": {
4968
+ "projects:list": {
4959
4969
  "aliases": [],
4960
4970
  "args": {},
4961
- "description": "Deploy schema documents into workspace datasets.\n\nNote: This command is experimental and subject to change.\n\nRegenerates a manifest file by default. To re-use an existing manifest, use --no-extract-manifest.",
4971
+ "description": "List your projects",
4962
4972
  "examples": [
4963
4973
  {
4964
4974
  "command": "<%= config.bin %> <%= command.id %>",
4965
- "description": "Deploy all workspace schemas"
4975
+ "description": "List projects"
4966
4976
  },
4967
4977
  {
4968
- "command": "<%= config.bin %> <%= command.id %> --workspace default",
4969
- "description": "Deploy the schema for only the workspace \"default\""
4978
+ "command": "<%= config.bin %> <%= command.id %> --sort=members --order=asc",
4979
+ "description": "List projects sorted by member count, ascending"
4970
4980
  }
4971
4981
  ],
4972
4982
  "flags": {
4973
- "extract-manifest": {
4974
- "description": "Regenerate manifest before deploying (use --no-extract-manifest to skip)",
4975
- "name": "extract-manifest",
4976
- "allowNo": true,
4977
- "type": "boolean"
4978
- },
4979
- "manifest-dir": {
4980
- "description": "Directory containing manifest file",
4981
- "name": "manifest-dir",
4982
- "default": "./dist/static",
4983
- "hasDynamicHelp": false,
4984
- "helpValue": "<directory>",
4985
- "multiple": false,
4983
+ "order": {
4984
+ "description": "Sort direction",
4985
+ "name": "order",
4986
+ "default": "desc",
4987
+ "hasDynamicHelp": false,
4988
+ "multiple": false,
4989
+ "options": [
4990
+ "asc",
4991
+ "desc"
4992
+ ],
4993
+ "type": "option"
4994
+ },
4995
+ "sort": {
4996
+ "description": "Sort field",
4997
+ "name": "sort",
4998
+ "default": "created",
4999
+ "hasDynamicHelp": false,
5000
+ "multiple": false,
5001
+ "options": [
5002
+ "id",
5003
+ "members",
5004
+ "name",
5005
+ "url",
5006
+ "created"
5007
+ ],
5008
+ "type": "option"
5009
+ }
5010
+ },
5011
+ "hasDynamicHelp": false,
5012
+ "hiddenAliases": [
5013
+ "project:list"
5014
+ ],
5015
+ "id": "projects:list",
5016
+ "pluginAlias": "@sanity/cli",
5017
+ "pluginName": "@sanity/cli",
5018
+ "pluginType": "core",
5019
+ "strict": true,
5020
+ "isESM": true,
5021
+ "relativePath": [
5022
+ "dist",
5023
+ "commands",
5024
+ "projects",
5025
+ "list.js"
5026
+ ]
5027
+ },
5028
+ "projects:unclaimed": {
5029
+ "aliases": [],
5030
+ "args": {},
5031
+ "description": "Recover details for unclaimed projects created on this machine",
5032
+ "examples": [
5033
+ {
5034
+ "command": "<%= config.bin %> <%= command.id %>",
5035
+ "description": "List locally recorded unclaimed projects"
5036
+ },
5037
+ {
5038
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5039
+ "description": "Show recovery details for one project"
5040
+ }
5041
+ ],
5042
+ "flags": {
5043
+ "project-id": {
5044
+ "description": "Project ID to recover",
5045
+ "name": "project-id",
5046
+ "hasDynamicHelp": false,
5047
+ "multiple": false,
5048
+ "type": "option"
5049
+ }
5050
+ },
5051
+ "hasDynamicHelp": false,
5052
+ "hiddenAliases": [
5053
+ "project:unclaimed"
5054
+ ],
5055
+ "id": "projects:unclaimed",
5056
+ "pluginAlias": "@sanity/cli",
5057
+ "pluginName": "@sanity/cli",
5058
+ "pluginType": "core",
5059
+ "strict": true,
5060
+ "isESM": true,
5061
+ "relativePath": [
5062
+ "dist",
5063
+ "commands",
5064
+ "projects",
5065
+ "unclaimed.js"
5066
+ ]
5067
+ },
5068
+ "schemas:delete": {
5069
+ "aliases": [],
5070
+ "args": {},
5071
+ "description": "Delete schema documents by id",
5072
+ "examples": [
5073
+ {
5074
+ "command": "<%= config.bin %> <%= command.id %> --ids sanity.workspace.schema.workspaceName",
5075
+ "description": "Delete a single schema"
5076
+ },
5077
+ {
5078
+ "command": "<%= config.bin %> <%= command.id %> --ids sanity.workspace.schema.workspaceName,prefix.sanity.workspace.schema.otherWorkspace",
5079
+ "description": "Delete multiple schemas"
5080
+ }
5081
+ ],
5082
+ "flags": {
5083
+ "project-id": {
5084
+ "char": "p",
5085
+ "description": "Project ID to delete schema from (overrides CLI configuration)",
5086
+ "helpGroup": "OVERRIDE",
5087
+ "name": "project-id",
5088
+ "hasDynamicHelp": false,
5089
+ "helpValue": "<id>",
5090
+ "multiple": false,
5091
+ "type": "option"
5092
+ },
5093
+ "dataset": {
5094
+ "char": "d",
5095
+ "description": "Delete schemas from a specific dataset",
5096
+ "name": "dataset",
5097
+ "hasDynamicHelp": false,
5098
+ "helpValue": "<name>",
5099
+ "multiple": false,
5100
+ "type": "option"
5101
+ },
5102
+ "extract-manifest": {
5103
+ "description": "Generate manifest file (disable with --no-extract-manifest)",
5104
+ "hidden": true,
5105
+ "name": "extract-manifest",
5106
+ "allowNo": true,
5107
+ "type": "boolean"
5108
+ },
5109
+ "ids": {
5110
+ "description": "Comma-separated list of schema ids to delete",
5111
+ "name": "ids",
5112
+ "required": true,
5113
+ "hasDynamicHelp": false,
5114
+ "multiple": false,
5115
+ "type": "option"
5116
+ },
5117
+ "manifest-dir": {
5118
+ "description": "Directory containing manifest file",
5119
+ "hidden": true,
5120
+ "name": "manifest-dir",
5121
+ "default": "./dist/static",
5122
+ "hasDynamicHelp": false,
5123
+ "multiple": false,
5124
+ "type": "option"
5125
+ },
5126
+ "verbose": {
5127
+ "description": "Enable verbose logging",
5128
+ "name": "verbose",
5129
+ "allowNo": false,
5130
+ "type": "boolean"
5131
+ },
5132
+ "yes": {
5133
+ "char": "y",
5134
+ "description": "Delete schemas without prompting for confirmation",
5135
+ "name": "yes",
5136
+ "allowNo": false,
5137
+ "type": "boolean"
5138
+ }
5139
+ },
5140
+ "hasDynamicHelp": false,
5141
+ "hiddenAliases": [
5142
+ "schema:delete"
5143
+ ],
5144
+ "id": "schemas:delete",
5145
+ "pluginAlias": "@sanity/cli",
5146
+ "pluginName": "@sanity/cli",
5147
+ "pluginType": "core",
5148
+ "strict": true,
5149
+ "isESM": true,
5150
+ "relativePath": [
5151
+ "dist",
5152
+ "commands",
5153
+ "schemas",
5154
+ "delete.js"
5155
+ ]
5156
+ },
5157
+ "schemas:deploy": {
5158
+ "aliases": [],
5159
+ "args": {},
5160
+ "description": "Deploy schema documents into workspace datasets.\n\nNote: This command is experimental and subject to change.\n\nRegenerates a manifest file by default. To re-use an existing manifest, use --no-extract-manifest.",
5161
+ "examples": [
5162
+ {
5163
+ "command": "<%= config.bin %> <%= command.id %>",
5164
+ "description": "Deploy all workspace schemas"
5165
+ },
5166
+ {
5167
+ "command": "<%= config.bin %> <%= command.id %> --workspace default",
5168
+ "description": "Deploy the schema for only the workspace \"default\""
5169
+ }
5170
+ ],
5171
+ "flags": {
5172
+ "extract-manifest": {
5173
+ "description": "Regenerate manifest before deploying (use --no-extract-manifest to skip)",
5174
+ "name": "extract-manifest",
5175
+ "allowNo": true,
5176
+ "type": "boolean"
5177
+ },
5178
+ "manifest-dir": {
5179
+ "description": "Directory containing manifest file",
5180
+ "name": "manifest-dir",
5181
+ "default": "./dist/static",
5182
+ "hasDynamicHelp": false,
5183
+ "helpValue": "<directory>",
5184
+ "multiple": false,
4986
5185
  "type": "option"
4987
5186
  },
4988
5187
  "tag": {
@@ -5291,118 +5490,40 @@
5291
5490
  "install.js"
5292
5491
  ]
5293
5492
  },
5294
- "telemetry:disable": {
5493
+ "tokens:create": {
5295
5494
  "aliases": [],
5296
- "args": {},
5297
- "description": "Disable telemetry for your account",
5495
+ "args": {
5496
+ "label": {
5497
+ "description": "Label for the new token",
5498
+ "name": "label",
5499
+ "required": false
5500
+ }
5501
+ },
5502
+ "description": "Create a new API token for the project",
5298
5503
  "examples": [
5299
5504
  {
5300
- "command": "<%= config.bin %> telemetry <%= command.id %>",
5301
- "description": "Disable telemetry for your account"
5302
- }
5303
- ],
5304
- "flags": {},
5305
- "hasDynamicHelp": false,
5306
- "hiddenAliases": [],
5307
- "id": "telemetry:disable",
5308
- "pluginAlias": "@sanity/cli",
5309
- "pluginName": "@sanity/cli",
5310
- "pluginType": "core",
5311
- "strict": true,
5312
- "isESM": true,
5313
- "relativePath": [
5314
- "dist",
5315
- "commands",
5316
- "telemetry",
5317
- "disable.js"
5318
- ]
5319
- },
5320
- "telemetry:enable": {
5321
- "aliases": [],
5322
- "args": {},
5323
- "description": "Enable telemetry for your account",
5324
- "examples": [
5325
- {
5326
- "command": "<%= config.bin %> telemetry <%= command.id %>",
5327
- "description": "Enable telemetry for your account"
5328
- }
5329
- ],
5330
- "flags": {},
5331
- "hasDynamicHelp": false,
5332
- "hiddenAliases": [],
5333
- "id": "telemetry:enable",
5334
- "pluginAlias": "@sanity/cli",
5335
- "pluginName": "@sanity/cli",
5336
- "pluginType": "core",
5337
- "strict": true,
5338
- "isESM": true,
5339
- "relativePath": [
5340
- "dist",
5341
- "commands",
5342
- "telemetry",
5343
- "enable.js"
5344
- ]
5345
- },
5346
- "telemetry:status": {
5347
- "aliases": [],
5348
- "args": {},
5349
- "description": "Check telemetry status for your account",
5350
- "examples": [
5351
- {
5352
- "command": "<%= config.bin %> telemetry <%= command.id %>",
5353
- "description": "Check telemetry status for your account"
5354
- }
5355
- ],
5356
- "flags": {},
5357
- "hasDynamicHelp": false,
5358
- "hiddenAliases": [],
5359
- "id": "telemetry:status",
5360
- "pluginAlias": "@sanity/cli",
5361
- "pluginName": "@sanity/cli",
5362
- "pluginType": "core",
5363
- "strict": true,
5364
- "isESM": true,
5365
- "relativePath": [
5366
- "dist",
5367
- "commands",
5368
- "telemetry",
5369
- "status.js"
5370
- ]
5371
- },
5372
- "tokens:create": {
5373
- "aliases": [],
5374
- "args": {
5375
- "label": {
5376
- "description": "Label for the new token",
5377
- "name": "label",
5378
- "required": false
5379
- }
5380
- },
5381
- "description": "Create a new API token for the project",
5382
- "examples": [
5383
- {
5384
- "command": "<%= config.bin %> <%= command.id %> \"My API Token\"",
5385
- "description": "Create a token with a label"
5386
- },
5387
- {
5388
- "command": "<%= config.bin %> <%= command.id %> \"My API Token\" --role=editor",
5389
- "description": "Create a token with editor role"
5390
- },
5391
- {
5392
- "command": "<%= config.bin %> <%= command.id %> \"CI Token\" --role=editor --yes",
5393
- "description": "Create a token in unattended mode"
5394
- },
5395
- {
5396
- "command": "<%= config.bin %> <%= command.id %> \"Build Token\" --expires-at 2027-01-01",
5397
- "description": "Create a token that expires on a given date"
5398
- },
5399
- {
5400
- "command": "<%= config.bin %> <%= command.id %> \"API Token\" --json",
5401
- "description": "Output token information as JSON"
5402
- },
5403
- {
5404
- "command": "<%= config.bin %> <%= command.id %> \"My Token\" --project-id abc123 --role=editor",
5405
- "description": "Create a token for a specific project"
5505
+ "command": "<%= config.bin %> <%= command.id %> \"My API Token\"",
5506
+ "description": "Create a token with a label"
5507
+ },
5508
+ {
5509
+ "command": "<%= config.bin %> <%= command.id %> \"My API Token\" --role=editor",
5510
+ "description": "Create a token with editor role"
5511
+ },
5512
+ {
5513
+ "command": "<%= config.bin %> <%= command.id %> \"CI Token\" --role=editor --yes",
5514
+ "description": "Create a token in unattended mode"
5515
+ },
5516
+ {
5517
+ "command": "<%= config.bin %> <%= command.id %> \"Build Token\" --expires-at 2027-01-01",
5518
+ "description": "Create a token that expires on a given date"
5519
+ },
5520
+ {
5521
+ "command": "<%= config.bin %> <%= command.id %> \"API Token\" --json",
5522
+ "description": "Output token information as JSON"
5523
+ },
5524
+ {
5525
+ "command": "<%= config.bin %> <%= command.id %> \"My Token\" --project-id abc123 --role=editor",
5526
+ "description": "Create a token for a specific project"
5406
5527
  }
5407
5528
  ],
5408
5529
  "flags": {
@@ -5634,100 +5755,20 @@
5634
5755
  "rotate.js"
5635
5756
  ]
5636
5757
  },
5637
- "typegen:generate": {
5758
+ "telemetry:disable": {
5638
5759
  "aliases": [],
5639
5760
  "args": {},
5640
- "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.",
5641
- "examples": [
5642
- {
5643
- "command": "<%= config.bin %> <%= command.id %>",
5644
- "description": "Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract` command."
5645
- }
5646
- ],
5647
- "flags": {
5648
- "config-path": {
5649
- "description": "[Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file should be a JSON file that contains settings for the type generation process.",
5650
- "name": "config-path",
5651
- "hasDynamicHelp": false,
5652
- "multiple": false,
5653
- "type": "option"
5654
- },
5655
- "watch": {
5656
- "description": "[Default: false] Run the typegen in watch mode",
5657
- "name": "watch",
5658
- "allowNo": false,
5659
- "type": "boolean"
5660
- }
5661
- },
5662
- "hasDynamicHelp": false,
5663
- "hiddenAliases": [
5664
- "typegen:generate"
5665
- ],
5666
- "id": "typegen:generate",
5667
- "pluginAlias": "@sanity/cli",
5668
- "pluginName": "@sanity/cli",
5669
- "pluginType": "core",
5670
- "strict": true,
5671
- "isESM": true,
5672
- "relativePath": [
5673
- "dist",
5674
- "commands",
5675
- "typegen",
5676
- "generate.js"
5677
- ]
5678
- },
5679
- "users:invite": {
5680
- "aliases": [],
5681
- "args": {
5682
- "email": {
5683
- "description": "Email address to invite",
5684
- "name": "email",
5685
- "required": false
5686
- }
5687
- },
5688
- "description": "Invite a new user to the project",
5761
+ "description": "Disable telemetry for your account",
5689
5762
  "examples": [
5690
5763
  {
5691
- "command": "<%= config.bin %> <%= command.id %>",
5692
- "description": "Invite a new user to the project (prompt for details)"
5693
- },
5694
- {
5695
- "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io",
5696
- "description": "Send a new user invite to the email \"pippi@sanity.io\", prompt for role"
5697
- },
5698
- {
5699
- "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io --role administrator",
5700
- "description": "Send a new user invite to the email \"pippi@sanity.io\", as administrator"
5701
- },
5702
- {
5703
- "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io --project-id abc123",
5704
- "description": "Invite a user to a specific project"
5764
+ "command": "<%= config.bin %> telemetry <%= command.id %>",
5765
+ "description": "Disable telemetry for your account"
5705
5766
  }
5706
5767
  ],
5707
- "flags": {
5708
- "project-id": {
5709
- "char": "p",
5710
- "description": "Project ID to invite user to (overrides CLI configuration)",
5711
- "helpGroup": "OVERRIDE",
5712
- "name": "project-id",
5713
- "hasDynamicHelp": false,
5714
- "helpValue": "<id>",
5715
- "multiple": false,
5716
- "type": "option"
5717
- },
5718
- "role": {
5719
- "description": "Role to invite the user as",
5720
- "name": "role",
5721
- "hasDynamicHelp": false,
5722
- "multiple": false,
5723
- "type": "option"
5724
- }
5725
- },
5768
+ "flags": {},
5726
5769
  "hasDynamicHelp": false,
5727
- "hiddenAliases": [
5728
- "user:invite"
5729
- ],
5730
- "id": "users:invite",
5770
+ "hiddenAliases": [],
5771
+ "id": "telemetry:disable",
5731
5772
  "pluginAlias": "@sanity/cli",
5732
5773
  "pluginName": "@sanity/cli",
5733
5774
  "pluginType": "core",
@@ -5736,87 +5777,24 @@
5736
5777
  "relativePath": [
5737
5778
  "dist",
5738
5779
  "commands",
5739
- "users",
5740
- "invite.js"
5780
+ "telemetry",
5781
+ "disable.js"
5741
5782
  ]
5742
5783
  },
5743
- "users:list": {
5784
+ "telemetry:enable": {
5744
5785
  "aliases": [],
5745
5786
  "args": {},
5746
- "description": "List project members",
5787
+ "description": "Enable telemetry for your account",
5747
5788
  "examples": [
5748
5789
  {
5749
- "command": "<%= config.bin %> <%= command.id %>",
5750
- "description": "List all users of the project"
5751
- },
5752
- {
5753
- "command": "<%= config.bin %> <%= command.id %> --no-invitations --no-robots",
5754
- "description": "List all users of the project, but exclude pending invitations and robots"
5755
- },
5756
- {
5757
- "command": "<%= config.bin %> <%= command.id %> --sort role",
5758
- "description": "List all users, sorted by role"
5759
- },
5760
- {
5761
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5762
- "description": "List users for a specific project"
5790
+ "command": "<%= config.bin %> telemetry <%= command.id %>",
5791
+ "description": "Enable telemetry for your account"
5763
5792
  }
5764
5793
  ],
5765
- "flags": {
5766
- "project-id": {
5767
- "char": "p",
5768
- "description": "Project ID to list users for (overrides CLI configuration)",
5769
- "helpGroup": "OVERRIDE",
5770
- "name": "project-id",
5771
- "hasDynamicHelp": false,
5772
- "helpValue": "<id>",
5773
- "multiple": false,
5774
- "type": "option"
5775
- },
5776
- "invitations": {
5777
- "description": "Includes or excludes pending invitations",
5778
- "name": "invitations",
5779
- "allowNo": true,
5780
- "type": "boolean"
5781
- },
5782
- "order": {
5783
- "description": "Sort output ascending/descending",
5784
- "name": "order",
5785
- "default": "asc",
5786
- "hasDynamicHelp": false,
5787
- "multiple": false,
5788
- "options": [
5789
- "asc",
5790
- "desc"
5791
- ],
5792
- "type": "option"
5793
- },
5794
- "robots": {
5795
- "description": "Includes or excludes robots (token users)",
5796
- "name": "robots",
5797
- "allowNo": true,
5798
- "type": "boolean"
5799
- },
5800
- "sort": {
5801
- "description": "Sort users by specified column",
5802
- "name": "sort",
5803
- "default": "date",
5804
- "hasDynamicHelp": false,
5805
- "multiple": false,
5806
- "options": [
5807
- "id",
5808
- "name",
5809
- "role",
5810
- "date"
5811
- ],
5812
- "type": "option"
5813
- }
5814
- },
5794
+ "flags": {},
5815
5795
  "hasDynamicHelp": false,
5816
- "hiddenAliases": [
5817
- "user:list"
5818
- ],
5819
- "id": "users:list",
5796
+ "hiddenAliases": [],
5797
+ "id": "telemetry:enable",
5820
5798
  "pluginAlias": "@sanity/cli",
5821
5799
  "pluginName": "@sanity/cli",
5822
5800
  "pluginType": "core",
@@ -5825,88 +5803,24 @@
5825
5803
  "relativePath": [
5826
5804
  "dist",
5827
5805
  "commands",
5828
- "users",
5829
- "list.js"
5806
+ "telemetry",
5807
+ "enable.js"
5830
5808
  ]
5831
5809
  },
5832
- "projects:create": {
5810
+ "telemetry:status": {
5833
5811
  "aliases": [],
5834
- "args": {
5835
- "projectName": {
5836
- "description": "Name of the project to create",
5837
- "name": "projectName",
5838
- "required": false
5839
- }
5840
- },
5841
- "description": "Create a new Sanity project",
5812
+ "args": {},
5813
+ "description": "Check telemetry status for your account",
5842
5814
  "examples": [
5843
5815
  {
5844
- "command": "<%= config.bin %> <%= command.id %>",
5845
- "description": "Interactively create a project"
5846
- },
5847
- {
5848
- "command": "<%= config.bin %> <%= command.id %> \"My New Project\"",
5849
- "description": "Create a project named \"My New Project\""
5850
- },
5851
- {
5852
- "command": "<%= config.bin %> <%= command.id %> \"My Project\" --organization=my-org",
5853
- "description": "Create a project in a specific organization"
5854
- },
5855
- {
5856
- "command": "<%= config.bin %> <%= command.id %> \"My Project\" --dataset=staging --dataset-visibility=private",
5857
- "description": "Create a project with a private dataset named \"staging\""
5858
- },
5859
- {
5860
- "command": "<%= config.bin %> <%= command.id %> \"CI Project\" --yes --json",
5861
- "description": "Create a project non-interactively with JSON output"
5862
- }
5863
- ],
5864
- "flags": {
5865
- "dataset": {
5866
- "description": "Create a dataset. Prompts for visibility unless specified or --yes used",
5867
- "name": "dataset",
5868
- "hasDynamicHelp": false,
5869
- "multiple": false,
5870
- "type": "option"
5871
- },
5872
- "dataset-visibility": {
5873
- "description": "Dataset visibility: public or private",
5874
- "name": "dataset-visibility",
5875
- "hasDynamicHelp": false,
5876
- "multiple": false,
5877
- "options": [
5878
- "private",
5879
- "public"
5880
- ],
5881
- "type": "option"
5882
- },
5883
- "json": {
5884
- "description": "Output in JSON format",
5885
- "name": "json",
5886
- "allowNo": false,
5887
- "type": "boolean"
5888
- },
5889
- "organization": {
5890
- "description": "Organization to create the project in",
5891
- "name": "organization",
5892
- "hasDynamicHelp": false,
5893
- "helpValue": "<slug|id>",
5894
- "multiple": false,
5895
- "type": "option"
5896
- },
5897
- "yes": {
5898
- "char": "y",
5899
- "description": "Skip prompts and use defaults (project: \"My Sanity Project\", dataset: production, visibility: public)",
5900
- "name": "yes",
5901
- "allowNo": false,
5902
- "type": "boolean"
5903
- }
5904
- },
5905
- "hasDynamicHelp": false,
5906
- "hiddenAliases": [
5907
- "project:create"
5816
+ "command": "<%= config.bin %> telemetry <%= command.id %>",
5817
+ "description": "Check telemetry status for your account"
5818
+ }
5908
5819
  ],
5909
- "id": "projects:create",
5820
+ "flags": {},
5821
+ "hasDynamicHelp": false,
5822
+ "hiddenAliases": [],
5823
+ "id": "telemetry:status",
5910
5824
  "pluginAlias": "@sanity/cli",
5911
5825
  "pluginName": "@sanity/cli",
5912
5826
  "pluginType": "core",
@@ -5915,58 +5829,40 @@
5915
5829
  "relativePath": [
5916
5830
  "dist",
5917
5831
  "commands",
5918
- "projects",
5919
- "create.js"
5832
+ "telemetry",
5833
+ "status.js"
5920
5834
  ]
5921
5835
  },
5922
- "projects:list": {
5836
+ "typegen:generate": {
5923
5837
  "aliases": [],
5924
5838
  "args": {},
5925
- "description": "List your projects",
5839
+ "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.",
5926
5840
  "examples": [
5927
5841
  {
5928
5842
  "command": "<%= config.bin %> <%= command.id %>",
5929
- "description": "List projects"
5930
- },
5931
- {
5932
- "command": "<%= config.bin %> <%= command.id %> --sort=members --order=asc",
5933
- "description": "List projects sorted by member count, ascending"
5843
+ "description": "Generate TypeScript type definitions from a Sanity Studio schema extracted using the `sanity schema extract` command."
5934
5844
  }
5935
5845
  ],
5936
5846
  "flags": {
5937
- "order": {
5938
- "description": "Sort direction",
5939
- "name": "order",
5940
- "default": "desc",
5847
+ "config-path": {
5848
+ "description": "[Default: sanity-typegen.json] Specifies the path to the typegen configuration file. This file should be a JSON file that contains settings for the type generation process.",
5849
+ "name": "config-path",
5941
5850
  "hasDynamicHelp": false,
5942
5851
  "multiple": false,
5943
- "options": [
5944
- "asc",
5945
- "desc"
5946
- ],
5947
5852
  "type": "option"
5948
5853
  },
5949
- "sort": {
5950
- "description": "Sort field",
5951
- "name": "sort",
5952
- "default": "created",
5953
- "hasDynamicHelp": false,
5954
- "multiple": false,
5955
- "options": [
5956
- "id",
5957
- "members",
5958
- "name",
5959
- "url",
5960
- "created"
5961
- ],
5962
- "type": "option"
5854
+ "watch": {
5855
+ "description": "[Default: false] Run the typegen in watch mode",
5856
+ "name": "watch",
5857
+ "allowNo": false,
5858
+ "type": "boolean"
5963
5859
  }
5964
5860
  },
5965
5861
  "hasDynamicHelp": false,
5966
5862
  "hiddenAliases": [
5967
- "project:list"
5863
+ "typegen:generate"
5968
5864
  ],
5969
- "id": "projects:list",
5865
+ "id": "typegen:generate",
5970
5866
  "pluginAlias": "@sanity/cli",
5971
5867
  "pluginName": "@sanity/cli",
5972
5868
  "pluginType": "core",
@@ -5975,38 +5871,62 @@
5975
5871
  "relativePath": [
5976
5872
  "dist",
5977
5873
  "commands",
5978
- "projects",
5979
- "list.js"
5874
+ "typegen",
5875
+ "generate.js"
5980
5876
  ]
5981
5877
  },
5982
- "projects:unclaimed": {
5878
+ "users:invite": {
5983
5879
  "aliases": [],
5984
- "args": {},
5985
- "description": "Recover details for unclaimed projects created on this machine",
5880
+ "args": {
5881
+ "email": {
5882
+ "description": "Email address to invite",
5883
+ "name": "email",
5884
+ "required": false
5885
+ }
5886
+ },
5887
+ "description": "Invite a new user to the project",
5986
5888
  "examples": [
5987
5889
  {
5988
5890
  "command": "<%= config.bin %> <%= command.id %>",
5989
- "description": "List locally recorded unclaimed projects"
5891
+ "description": "Invite a new user to the project (prompt for details)"
5990
5892
  },
5991
5893
  {
5992
- "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5993
- "description": "Show recovery details for one project"
5894
+ "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io",
5895
+ "description": "Send a new user invite to the email \"pippi@sanity.io\", prompt for role"
5896
+ },
5897
+ {
5898
+ "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io --role administrator",
5899
+ "description": "Send a new user invite to the email \"pippi@sanity.io\", as administrator"
5900
+ },
5901
+ {
5902
+ "command": "<%= config.bin %> <%= command.id %> pippi@sanity.io --project-id abc123",
5903
+ "description": "Invite a user to a specific project"
5994
5904
  }
5995
5905
  ],
5996
5906
  "flags": {
5997
5907
  "project-id": {
5998
- "description": "Project ID to recover",
5908
+ "char": "p",
5909
+ "description": "Project ID to invite user to (overrides CLI configuration)",
5910
+ "helpGroup": "OVERRIDE",
5999
5911
  "name": "project-id",
6000
5912
  "hasDynamicHelp": false,
5913
+ "helpValue": "<id>",
5914
+ "multiple": false,
5915
+ "type": "option"
5916
+ },
5917
+ "role": {
5918
+ "description": "Role to invite the user as",
5919
+ "name": "role",
5920
+ "hasDynamicHelp": false,
6001
5921
  "multiple": false,
6002
5922
  "type": "option"
6003
5923
  }
6004
5924
  },
6005
5925
  "hasDynamicHelp": false,
6006
5926
  "hiddenAliases": [
6007
- "project:unclaimed"
5927
+ "user:invite"
6008
5928
  ],
6009
- "id": "projects:unclaimed",
5929
+ "id": "users:invite",
6010
5930
  "pluginAlias": "@sanity/cli",
6011
5931
  "pluginName": "@sanity/cli",
6012
5932
  "pluginType": "core",
@@ -6015,52 +5935,87 @@
6015
5935
  "relativePath": [
6016
5936
  "dist",
6017
5937
  "commands",
6018
- "projects",
6019
- "unclaimed.js"
5938
+ "users",
5939
+ "invite.js"
6020
5940
  ]
6021
5941
  },
6022
- "context:jobs:get": {
5942
+ "users:list": {
6023
5943
  "aliases": [],
6024
- "args": {
6025
- "knowledgeBaseId": {
6026
- "description": "Knowledge base ID",
6027
- "name": "knowledgeBaseId",
6028
- "required": true
6029
- },
6030
- "jobId": {
6031
- "description": "Job ID",
6032
- "name": "jobId",
6033
- "required": true
6034
- }
6035
- },
6036
- "description": "Get the status of a knowledge base job",
5944
+ "args": {},
5945
+ "description": "List project members",
6037
5946
  "examples": [
6038
5947
  {
6039
- "command": "<%= config.bin %> <%= command.id %> kb-abc123 job-def456",
6040
- "description": "Get the current status of a job"
5948
+ "command": "<%= config.bin %> <%= command.id %>",
5949
+ "description": "List all users of the project"
6041
5950
  },
6042
5951
  {
6043
- "command": "<%= config.bin %> <%= command.id %> kb-abc123 job-def456 --watch",
6044
- "description": "Wait for the job to finish (non-zero exit if it does not succeed)"
5952
+ "command": "<%= config.bin %> <%= command.id %> --no-invitations --no-robots",
5953
+ "description": "List all users of the project, but exclude pending invitations and robots"
5954
+ },
5955
+ {
5956
+ "command": "<%= config.bin %> <%= command.id %> --sort role",
5957
+ "description": "List all users, sorted by role"
5958
+ },
5959
+ {
5960
+ "command": "<%= config.bin %> <%= command.id %> --project-id abc123",
5961
+ "description": "List users for a specific project"
6045
5962
  }
6046
5963
  ],
6047
5964
  "flags": {
6048
- "json": {
6049
- "description": "Output the job in JSON format",
6050
- "name": "json",
6051
- "allowNo": false,
5965
+ "project-id": {
5966
+ "char": "p",
5967
+ "description": "Project ID to list users for (overrides CLI configuration)",
5968
+ "helpGroup": "OVERRIDE",
5969
+ "name": "project-id",
5970
+ "hasDynamicHelp": false,
5971
+ "helpValue": "<id>",
5972
+ "multiple": false,
5973
+ "type": "option"
5974
+ },
5975
+ "invitations": {
5976
+ "description": "Includes or excludes pending invitations",
5977
+ "name": "invitations",
5978
+ "allowNo": true,
6052
5979
  "type": "boolean"
6053
5980
  },
6054
- "watch": {
6055
- "description": "Poll until the job reaches a terminal state",
6056
- "name": "watch",
6057
- "allowNo": false,
5981
+ "order": {
5982
+ "description": "Sort output ascending/descending",
5983
+ "name": "order",
5984
+ "default": "asc",
5985
+ "hasDynamicHelp": false,
5986
+ "multiple": false,
5987
+ "options": [
5988
+ "asc",
5989
+ "desc"
5990
+ ],
5991
+ "type": "option"
5992
+ },
5993
+ "robots": {
5994
+ "description": "Includes or excludes robots (token users)",
5995
+ "name": "robots",
5996
+ "allowNo": true,
6058
5997
  "type": "boolean"
5998
+ },
5999
+ "sort": {
6000
+ "description": "Sort users by specified column",
6001
+ "name": "sort",
6002
+ "default": "date",
6003
+ "hasDynamicHelp": false,
6004
+ "multiple": false,
6005
+ "options": [
6006
+ "id",
6007
+ "name",
6008
+ "role",
6009
+ "date"
6010
+ ],
6011
+ "type": "option"
6059
6012
  }
6060
6013
  },
6061
6014
  "hasDynamicHelp": false,
6062
- "hiddenAliases": [],
6063
- "id": "context:jobs:get",
6015
+ "hiddenAliases": [
6016
+ "user:list"
6017
+ ],
6018
+ "id": "users:list",
6064
6019
  "pluginAlias": "@sanity/cli",
6065
6020
  "pluginName": "@sanity/cli",
6066
6021
  "pluginType": "core",
@@ -6069,9 +6024,8 @@
6069
6024
  "relativePath": [
6070
6025
  "dist",
6071
6026
  "commands",
6072
- "context",
6073
- "jobs",
6074
- "get.js"
6027
+ "users",
6028
+ "list.js"
6075
6029
  ]
6076
6030
  },
6077
6031
  "context:imports:create": {
@@ -6440,6 +6394,61 @@
6440
6394
  "list.js"
6441
6395
  ]
6442
6396
  },
6397
+ "context:jobs:get": {
6398
+ "aliases": [],
6399
+ "args": {
6400
+ "knowledgeBaseId": {
6401
+ "description": "Knowledge base ID",
6402
+ "name": "knowledgeBaseId",
6403
+ "required": true
6404
+ },
6405
+ "jobId": {
6406
+ "description": "Job ID",
6407
+ "name": "jobId",
6408
+ "required": true
6409
+ }
6410
+ },
6411
+ "description": "Get the status of a knowledge base job",
6412
+ "examples": [
6413
+ {
6414
+ "command": "<%= config.bin %> <%= command.id %> kb-abc123 job-def456",
6415
+ "description": "Get the current status of a job"
6416
+ },
6417
+ {
6418
+ "command": "<%= config.bin %> <%= command.id %> kb-abc123 job-def456 --watch",
6419
+ "description": "Wait for the job to finish (non-zero exit if it does not succeed)"
6420
+ }
6421
+ ],
6422
+ "flags": {
6423
+ "json": {
6424
+ "description": "Output the job in JSON format",
6425
+ "name": "json",
6426
+ "allowNo": false,
6427
+ "type": "boolean"
6428
+ },
6429
+ "watch": {
6430
+ "description": "Poll until the job reaches a terminal state",
6431
+ "name": "watch",
6432
+ "allowNo": false,
6433
+ "type": "boolean"
6434
+ }
6435
+ },
6436
+ "hasDynamicHelp": false,
6437
+ "hiddenAliases": [],
6438
+ "id": "context:jobs:get",
6439
+ "pluginAlias": "@sanity/cli",
6440
+ "pluginName": "@sanity/cli",
6441
+ "pluginType": "core",
6442
+ "strict": true,
6443
+ "isESM": true,
6444
+ "relativePath": [
6445
+ "dist",
6446
+ "commands",
6447
+ "context",
6448
+ "jobs",
6449
+ "get.js"
6450
+ ]
6451
+ },
6443
6452
  "datasets:alias:create": {
6444
6453
  "aliases": [],
6445
6454
  "args": {
@@ -6955,5 +6964,5 @@
6955
6964
  ]
6956
6965
  }
6957
6966
  },
6958
- "version": "8.9.1"
6967
+ "version": "8.10.0"
6959
6968
  }