Skip to content

Commit 75d5154

Browse files
chore: update CLI README (#765)
Co-authored-by: binoy14 <6476108+binoy14@users.noreply.github.com>
1 parent e093ac3 commit 75d5154

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

packages/@sanity/cli/README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ Code for sanity cli
8888
- [`sanity media deploy-aspect [ASPECTNAME]`](#sanity-media-deploy-aspect-aspectname)
8989
- [`sanity media export [DESTINATION]`](#sanity-media-export-destination)
9090
- [`sanity media import SOURCE`](#sanity-media-import-source)
91-
- [`sanity migration create [TITLE]`](#sanity-migration-create-title)
92-
- [`sanity migration list`](#sanity-migration-list)
93-
- [`sanity migration run [ID]`](#sanity-migration-run-id)
91+
- [`sanity migrations create [TITLE]`](#sanity-migrations-create-title)
92+
- [`sanity migrations list`](#sanity-migrations-list)
93+
- [`sanity migrations run [ID]`](#sanity-migrations-run-id)
9494
- [`sanity openapi get SLUG`](#sanity-openapi-get-slug)
9595
- [`sanity openapi list`](#sanity-openapi-list)
9696
- [`sanity preview [OUTPUTDIR]`](#sanity-preview-outputdir)
@@ -307,7 +307,7 @@ EXAMPLES
307307
$ sanity blueprints add function --name my-function --fn-type document-create --fn-type document-update --lang js
308308
```
309309

310-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/add.ts)_
310+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/add.ts)_
311311

312312
## `sanity blueprints config`
313313

@@ -342,7 +342,7 @@ EXAMPLES
342342
$ sanity blueprints config --edit --project-id <projectId> --stack <name-or-id>
343343
```
344344

345-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/config.ts)_
345+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/config.ts)_
346346

347347
## `sanity blueprints deploy`
348348

@@ -379,7 +379,7 @@ EXAMPLES
379379
$ sanity blueprints deploy --fn-installer npm
380380
```
381381

382-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/deploy.ts)_
382+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/deploy.ts)_
383383

384384
## `sanity blueprints destroy`
385385

@@ -411,7 +411,7 @@ EXAMPLES
411411
$ sanity blueprints destroy --stack <name-or-id> --project-id <projectId> --force --no-wait
412412
```
413413

414-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/destroy.ts)_
414+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/destroy.ts)_
415415

416416
## `sanity blueprints doctor`
417417

@@ -437,7 +437,7 @@ DESCRIPTION
437437
issues.
438438
```
439439

440-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/doctor.ts)_
440+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/doctor.ts)_
441441

442442
## `sanity blueprints info`
443443

@@ -467,7 +467,7 @@ EXAMPLES
467467
$ sanity blueprints info --stack <name-or-id>
468468
```
469469

470-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/info.ts)_
470+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/info.ts)_
471471

472472
## `sanity blueprints init [DIR]`
473473

@@ -517,7 +517,7 @@ EXAMPLES
517517
$ sanity blueprints init --blueprint-type <json|js|ts> --stack-name <stackName>
518518
```
519519

520-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/init.ts)_
520+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/init.ts)_
521521

522522
## `sanity blueprints logs`
523523

@@ -546,7 +546,7 @@ EXAMPLES
546546
$ sanity blueprints logs --watch
547547
```
548548

549-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/logs.ts)_
549+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/logs.ts)_
550550

551551
## `sanity blueprints plan`
552552

@@ -572,7 +572,7 @@ EXAMPLES
572572
$ sanity blueprints plan
573573
```
574574

575-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/plan.ts)_
575+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/plan.ts)_
576576

577577
## `sanity blueprints stacks`
578578

@@ -601,7 +601,7 @@ EXAMPLES
601601
$ sanity blueprints stacks --organization-id <organizationId>
602602
```
603603

604-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/blueprints/stacks.ts)_
604+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/blueprints/stacks.ts)_
605605

606606
## `sanity build [OUTPUTDIR]`
607607

@@ -1861,7 +1861,7 @@ EXAMPLES
18611861
$ sanity functions add --name my-function --type document-create --type document-update --lang js
18621862
```
18631863

1864-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/add.ts)_
1864+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/add.ts)_
18651865

18661866
## `sanity functions dev`
18671867

@@ -1895,7 +1895,7 @@ EXAMPLES
18951895
$ sanity functions dev --timeout 60
18961896
```
18971897

1898-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/dev.ts)_
1898+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/dev.ts)_
18991899

19001900
## `sanity functions env add NAME KEY VALUE`
19011901

@@ -1922,7 +1922,7 @@ EXAMPLES
19221922
$ sanity functions env add MyFunction API_URL https://api.example.com/
19231923
```
19241924

1925-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/env/add.ts)_
1925+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/add.ts)_
19261926

19271927
## `sanity functions env list NAME`
19281928

@@ -1946,7 +1946,7 @@ EXAMPLES
19461946
$ sanity functions env list MyFunction
19471947
```
19481948

1949-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/env/list.ts)_
1949+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/list.ts)_
19501950

19511951
## `sanity functions env remove NAME KEY`
19521952

@@ -1972,7 +1972,7 @@ EXAMPLES
19721972
$ sanity functions env remove MyFunction API_URL
19731973
```
19741974

1975-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/env/remove.ts)_
1975+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/env/remove.ts)_
19761976

19771977
## `sanity functions logs [NAME]`
19781978

@@ -2012,7 +2012,7 @@ EXAMPLES
20122012
$ sanity functions logs <name> --delete
20132013
```
20142014

2015-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/logs.ts)_
2015+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/logs.ts)_
20162016

20172017
## `sanity functions test [NAME]`
20182018

@@ -2066,7 +2066,7 @@ EXAMPLES
20662066
$ sanity functions test <name> --event update --data-before '{ "title": "before" }' --data-after '{ "title": "after" }'
20672067
```
20682068

2069-
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.5.1/src/commands/functions/test.ts)_
2069+
_See code: [@sanity/runtime-cli](https://github.com/sanity-io/runtime-cli/blob/v14.6.1/src/commands/functions/test.ts)_
20702070

20712071
## `sanity graphql deploy`
20722072

@@ -2732,13 +2732,13 @@ EXAMPLES
27322732

27332733
_See code: [src/commands/media/import.ts](https://github.com/sanity-io/cli/blob/v6.2.0/src/commands/media/import.ts)_
27342734

2735-
## `sanity migration create [TITLE]`
2735+
## `sanity migrations create [TITLE]`
27362736

27372737
Create a new migration within your project
27382738

27392739
```
27402740
USAGE
2741-
$ sanity migration create [TITLE]
2741+
$ sanity migrations create [TITLE]
27422742
27432743
ARGUMENTS
27442744
[TITLE] Title of migration
@@ -2749,41 +2749,41 @@ DESCRIPTION
27492749
EXAMPLES
27502750
Create a new migration, prompting for title and options
27512751
2752-
$ sanity migration create
2752+
$ sanity migrations create
27532753
27542754
Create a new migration with the provided title, prompting for options
27552755
2756-
$ sanity migration create "Rename field from location to address"
2756+
$ sanity migrations create "Rename field from location to address"
27572757
```
27582758

2759-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/create.ts)_
2759+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/create.ts)_
27602760

2761-
## `sanity migration list`
2761+
## `sanity migrations list`
27622762

27632763
List available migrations
27642764

27652765
```
27662766
USAGE
2767-
$ sanity migration list
2767+
$ sanity migrations list
27682768
27692769
DESCRIPTION
27702770
List available migrations
27712771
27722772
EXAMPLES
27732773
List all available migrations in the project
27742774
2775-
$ sanity migration list
2775+
$ sanity migrations list
27762776
```
27772777

2778-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/list.ts)_
2778+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/list.ts)_
27792779

2780-
## `sanity migration run [ID]`
2780+
## `sanity migrations run [ID]`
27812781

27822782
Run a migration against a dataset
27832783

27842784
```
27852785
USAGE
2786-
$ sanity migration run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
2786+
$ sanity migrations run [ID] [--api-version <value>] [--concurrency <value>] [--confirm] [--dataset <value>]
27872787
[--dry-run] [--from-export <value>] [--progress] [--project <value>]
27882788
27892789
ARGUMENTS
@@ -2808,18 +2808,18 @@ DESCRIPTION
28082808
EXAMPLES
28092809
dry run the migration
28102810
2811-
$ sanity migration run <id>
2811+
$ sanity migrations run <id>
28122812
28132813
execute the migration against a dataset
28142814
2815-
$ sanity migration run <id> --no-dry-run --project xyz --dataset staging
2815+
$ sanity migrations run <id> --no-dry-run --project xyz --dataset staging
28162816
28172817
execute the migration using a dataset export as the source
28182818
2819-
$ sanity migration run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
2819+
$ sanity migrations run <id> --from-export=production.tar.gz --no-dry-run --project xyz --dataset staging
28202820
```
28212821

2822-
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.0.0/src/commands/migration/run.ts)_
2822+
_See code: [@sanity/migrate](https://github.com/sanity-io/migrate/blob/v6.1.0/src/commands/migrations/run.ts)_
28232823

28242824
## `sanity openapi get SLUG`
28252825

0 commit comments

Comments
 (0)