Skip to content

Commit 77aa551

Browse files
Document non-interactive theme command flags
1 parent 4c70839 commit 77aa551

11 files changed

Lines changed: 283 additions & 128 deletions

File tree

docs-shopify.dev/generated/generated_docs_data_v2.json

Lines changed: 30 additions & 30 deletions
Large diffs are not rendered by default.

packages/cli/README.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4078,19 +4078,20 @@ USAGE
40784078
40794079
FLAGS
40804080
-a, --show-all
4081-
Include others development themes in theme list.
4081+
Include other development themes in the theme list. Use --show-all, --development, or --theme in non-interactive
4082+
environments.
40824083
[env: SHOPIFY_FLAG_SHOW_ALL]
40834084
40844085
-d, --development
4085-
Delete your development theme.
4086+
Delete your development theme. Use --show-all, --development, or --theme in non-interactive environments.
40864087
[env: SHOPIFY_FLAG_DEVELOPMENT]
40874088
40884089
-e, --environment=<value>...
40894090
The environment to apply to the current command.
40904091
[env: SHOPIFY_FLAG_ENVIRONMENT]
40914092
40924093
-f, --force
4093-
Skip confirmation.
4094+
Skip confirmation. Required if non interactive.
40944095
[env: SHOPIFY_FLAG_FORCE]
40954096
40964097
-s, --store=<value>
@@ -4099,7 +4100,7 @@ FLAGS
40994100
[env: SHOPIFY_FLAG_STORE]
41004101
41014102
-t, --theme=<value>...
4102-
Theme ID or name of the remote theme.
4103+
Theme ID or name of the remote theme. Use --show-all, --development, or --theme in non-interactive environments.
41034104
[env: SHOPIFY_FLAG_THEME_ID]
41044105
41054106
--auth-alias=<value>
@@ -4302,7 +4303,7 @@ FLAGS
43024303
[env: SHOPIFY_FLAG_ENVIRONMENT]
43034304
43044305
-f, --force
4305-
Force the duplicate operation to run without prompts or confirmations.
4306+
Force the duplicate operation to run without prompts or confirmations. Required if non interactive outside CI.
43064307
[env: SHOPIFY_FLAG_FORCE]
43074308
43084309
-j, --json
@@ -4319,7 +4320,7 @@ FLAGS
43194320
[env: SHOPIFY_FLAG_STORE]
43204321
43214322
-t, --theme=<value>
4322-
Theme ID or name of the remote theme.
4323+
Theme ID or name of the remote theme. Required if non interactive.
43234324
[env: SHOPIFY_FLAG_THEME_ID]
43244325
43254326
--auth-alias=<value>
@@ -4632,15 +4633,15 @@ FLAGS
46324633
[env: SHOPIFY_FLAG_EDITOR]
46334634

46344635
-d, --development
4635-
Open your development theme.
4636+
Open your development theme. Use --development, --live, or --theme in non-interactive environments.
46364637
[env: SHOPIFY_FLAG_DEVELOPMENT]
46374638

46384639
-e, --environment=<value>...
46394640
The environment to apply to the current command.
46404641
[env: SHOPIFY_FLAG_ENVIRONMENT]
46414642

46424643
-l, --live
4643-
Open your live (published) theme.
4644+
Open your live (published) theme. Use --development, --live, or --theme in non-interactive environments.
46444645
[env: SHOPIFY_FLAG_LIVE]
46454646

46464647
-s, --store=<value>
@@ -4649,7 +4650,7 @@ FLAGS
46494650
[env: SHOPIFY_FLAG_STORE]
46504651

46514652
-t, --theme=<value>
4652-
Theme ID or name of the remote theme.
4653+
Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.
46534654
[env: SHOPIFY_FLAG_THEME_ID]
46544655

46554656
--auth-alias=<value>
@@ -4874,7 +4875,7 @@ FLAGS
48744875
[env: SHOPIFY_FLAG_ENVIRONMENT]
48754876

48764877
-f, --force
4877-
Skip confirmation.
4878+
Skip confirmation. Required if non interactive.
48784879
[env: SHOPIFY_FLAG_FORCE]
48794880

48804881
-s, --store=<value>
@@ -4883,7 +4884,7 @@ FLAGS
48834884
[env: SHOPIFY_FLAG_STORE]
48844885

48854886
-t, --theme=<value>
4886-
Theme ID or name of the remote theme.
4887+
Theme ID or name of the remote theme. Required if non interactive.
48874888
[env: SHOPIFY_FLAG_THEME_ID]
48884889

48894890
--auth-alias=<value>
@@ -4932,15 +4933,16 @@ USAGE
49324933

49334934
FLAGS
49344935
-d, --development
4935-
Pull theme files from your remote development theme.
4936+
Pull theme files from your remote development theme. Use --development, --live, or --theme in non-interactive
4937+
environments.
49364938
[env: SHOPIFY_FLAG_DEVELOPMENT]
49374939

49384940
-e, --environment=<value>...
49394941
The environment to apply to the current command.
49404942
[env: SHOPIFY_FLAG_ENVIRONMENT]
49414943

49424944
-l, --live
4943-
Pull theme files from your remote live theme.
4945+
Pull theme files from your remote live theme. Use --development, --live, or --theme in non-interactive environments.
49444946
[env: SHOPIFY_FLAG_LIVE]
49454947

49464948
-n, --nodelete
@@ -4958,7 +4960,7 @@ FLAGS
49584960
[env: SHOPIFY_FLAG_STORE]
49594961

49604962
-t, --theme=<value>
4961-
Theme ID or name of the remote theme.
4963+
Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.
49624964
[env: SHOPIFY_FLAG_THEME_ID]
49634965

49644966
-x, --ignore=<value>...
@@ -5005,7 +5007,7 @@ USAGE
50055007

50065008
FLAGS
50075009
-a, --allow-live
5008-
Allow push to a live theme.
5010+
Allow push to a live theme. Required in non-interactive environments when targeting the live theme.
50095011
[env: SHOPIFY_FLAG_ALLOW_LIVE]
50105012

50115013
-c, --development-context=<value>
@@ -5014,7 +5016,8 @@ FLAGS
50145016
[env: SHOPIFY_FLAG_DEVELOPMENT_CONTEXT]
50155017

50165018
-d, --development
5017-
Push theme files from your remote development theme.
5019+
Push theme files from your remote development theme. Use --development, --live, --theme, or --unpublished in
5020+
non-interactive environments.
50185021
[env: SHOPIFY_FLAG_DEVELOPMENT]
50195022

50205023
-e, --environment=<value>...
@@ -5026,7 +5029,8 @@ FLAGS
50265029
[env: SHOPIFY_FLAG_JSON]
50275030

50285031
-l, --live
5029-
Push theme files from your remote live theme.
5032+
Push theme files from your remote live theme. Use --development, --live, --theme, or --unpublished in
5033+
non-interactive environments.
50305034
[env: SHOPIFY_FLAG_LIVE]
50315035

50325036
-n, --nodelete
@@ -5047,11 +5051,14 @@ FLAGS
50475051
[env: SHOPIFY_FLAG_STORE]
50485052

50495053
-t, --theme=<value>
5050-
Theme ID or name of the remote theme.
5054+
Theme ID or name of the remote theme. Use --development, --live, --theme, or --unpublished in non-interactive
5055+
environments. When using --unpublished without --development, use --theme to provide the new theme name.
50515056
[env: SHOPIFY_FLAG_THEME_ID]
50525057

50535058
-u, --unpublished
5054-
Create a new unpublished theme and push to it.
5059+
Create a new unpublished theme and push to it. Use --development, --live, --theme, or --unpublished in
5060+
non-interactive environments. When using --unpublished without --development, use --theme to provide the new theme
5061+
name.
50555062
[env: SHOPIFY_FLAG_UNPUBLISHED]
50565063

50575064
-x, --ignore=<value>...
@@ -5135,19 +5142,19 @@ USAGE
51355142

51365143
FLAGS
51375144
-d, --development
5138-
Rename your development theme.
5145+
Rename your development theme. Use --development, --live, or --theme in non-interactive environments.
51395146
[env: SHOPIFY_FLAG_DEVELOPMENT]
51405147

51415148
-e, --environment=<value>...
51425149
The environment to apply to the current command.
51435150
[env: SHOPIFY_FLAG_ENVIRONMENT]
51445151

51455152
-l, --live
5146-
Rename your remote live theme.
5153+
Rename your remote live theme. Use --development, --live, or --theme in non-interactive environments.
51475154
[env: SHOPIFY_FLAG_LIVE]
51485155

51495156
-n, --name=<value>
5150-
The new name for the theme.
5157+
The new name for the theme. Required if non interactive.
51515158
[env: SHOPIFY_FLAG_NEW_NAME]
51525159

51535160
-s, --store=<value>
@@ -5156,7 +5163,7 @@ FLAGS
51565163
[env: SHOPIFY_FLAG_STORE]
51575164

51585165
-t, --theme=<value>
5159-
Theme ID or name of the remote theme.
5166+
Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.
51605167
[env: SHOPIFY_FLAG_THEME_ID]
51615168

51625169
--auth-alias=<value>

0 commit comments

Comments
 (0)