@teambit/harmony.content.cli-reference 2.0.1132 → 2.0.1133
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.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +31 -25
- package/cli-reference.mdx +31 -31
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +31 -25
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1784148848422.js → preview-1784214251112.js} +2 -2
- package/package.json +2 -2
package/dist/cli-reference.json
CHANGED
|
@@ -219,6 +219,12 @@
|
|
|
219
219
|
"name": "component-name",
|
|
220
220
|
"description": "the 'component name' or 'component id' of the component whose env you'd like to inspect"
|
|
221
221
|
}
|
|
222
|
+
],
|
|
223
|
+
"examples": [
|
|
224
|
+
{
|
|
225
|
+
"cmd": "get ui/button",
|
|
226
|
+
"description": "show config information from the env configured for ui/button"
|
|
227
|
+
}
|
|
222
228
|
]
|
|
223
229
|
},
|
|
224
230
|
{
|
|
@@ -255,7 +261,7 @@
|
|
|
255
261
|
"name": "unset <component-pattern>",
|
|
256
262
|
"options": [],
|
|
257
263
|
"description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
|
|
258
|
-
"extendedDescription": "keep in mind that this doesn't remove envs that are set via variants.\
|
|
264
|
+
"extendedDescription": "keep in mind that this doesn't remove envs that are set via variants.\nit only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to reset previously assigned envs to either allow variants to configure the env or use the base node env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
259
265
|
"group": "component-config",
|
|
260
266
|
"arguments": [
|
|
261
267
|
{
|
|
@@ -532,7 +538,7 @@
|
|
|
532
538
|
[
|
|
533
539
|
"v",
|
|
534
540
|
"verbose",
|
|
535
|
-
"show verbose output for inspection and
|
|
541
|
+
"show verbose output for inspection and print stack trace"
|
|
536
542
|
],
|
|
537
543
|
[
|
|
538
544
|
"n",
|
|
@@ -597,7 +603,7 @@
|
|
|
597
603
|
[
|
|
598
604
|
"",
|
|
599
605
|
"layout <name>",
|
|
600
|
-
"
|
|
606
|
+
"Graphviz layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
|
|
601
607
|
],
|
|
602
608
|
[
|
|
603
609
|
"",
|
|
@@ -644,7 +650,7 @@
|
|
|
644
650
|
"name": "set <scope-name> [component-pattern]",
|
|
645
651
|
"options": [],
|
|
646
652
|
"description": "Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace",
|
|
647
|
-
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.\na component is set with a scope (as
|
|
653
|
+
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.\na component is set with a scope (as opposed to default scope) only once it is versioned.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
648
654
|
"group": "component-config",
|
|
649
655
|
"arguments": [
|
|
650
656
|
{
|
|
@@ -690,7 +696,7 @@
|
|
|
690
696
|
[
|
|
691
697
|
"",
|
|
692
698
|
"deprecate",
|
|
693
|
-
"for exported components, instead of deleting the original components,
|
|
699
|
+
"for exported components, instead of deleting the original components, deprecate them"
|
|
694
700
|
],
|
|
695
701
|
[
|
|
696
702
|
"x",
|
|
@@ -863,12 +869,12 @@
|
|
|
863
869
|
[
|
|
864
870
|
"p",
|
|
865
871
|
"propagate",
|
|
866
|
-
"mark propagate true in the config file, so that component.json configs will be
|
|
872
|
+
"mark propagate true in the config file, so that component.json configs will be merged with workspace configs"
|
|
867
873
|
],
|
|
868
874
|
[
|
|
869
875
|
"o",
|
|
870
876
|
"override",
|
|
871
|
-
"override file if
|
|
877
|
+
"override the file if it exists"
|
|
872
878
|
]
|
|
873
879
|
],
|
|
874
880
|
"description": "create component.json configuration files for components",
|
|
@@ -1241,7 +1247,7 @@
|
|
|
1241
1247
|
[
|
|
1242
1248
|
"",
|
|
1243
1249
|
"suppress-browser-launch",
|
|
1244
|
-
"
|
|
1250
|
+
"DEPRECATED. use --no-browser instead"
|
|
1245
1251
|
]
|
|
1246
1252
|
],
|
|
1247
1253
|
"description": "authenticate with Bit Cloud for component publishing and collaboration",
|
|
@@ -1883,7 +1889,7 @@
|
|
|
1883
1889
|
},
|
|
1884
1890
|
{
|
|
1885
1891
|
"cmd": "bit create mdx docs/create-components --aspect teambit.mdx/mdx-env --scope my-org.my-scope",
|
|
1886
|
-
"description": "creates an mdx component named 'docs/create-components' and sets
|
|
1892
|
+
"description": "creates an mdx component named 'docs/create-components' and sets its scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
|
|
1887
1893
|
},
|
|
1888
1894
|
{
|
|
1889
1895
|
"cmd": "bit create react my-org.my-scope/hooks/use-session",
|
|
@@ -1962,7 +1968,7 @@
|
|
|
1962
1968
|
[
|
|
1963
1969
|
"",
|
|
1964
1970
|
"load-from <path-to-template>",
|
|
1965
|
-
"local path to the workspace containing the template. Helpful during
|
|
1971
|
+
"local path to the workspace containing the template. Helpful during the development of a workspace-template"
|
|
1966
1972
|
],
|
|
1967
1973
|
[
|
|
1968
1974
|
"c",
|
|
@@ -2388,7 +2394,7 @@
|
|
|
2388
2394
|
[
|
|
2389
2395
|
"",
|
|
2390
2396
|
"skip-unavailable",
|
|
2391
|
-
"when adding missing dependencies, skip those that are not found in the
|
|
2397
|
+
"when adding missing dependencies, skip those that are not found in the registry"
|
|
2392
2398
|
],
|
|
2393
2399
|
[
|
|
2394
2400
|
"",
|
|
@@ -2635,7 +2641,7 @@
|
|
|
2635
2641
|
[
|
|
2636
2642
|
"",
|
|
2637
2643
|
"dependents-dry-run",
|
|
2638
|
-
"DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and
|
|
2644
|
+
"DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and waits for confirmation before importing them"
|
|
2639
2645
|
],
|
|
2640
2646
|
[
|
|
2641
2647
|
"",
|
|
@@ -2660,7 +2666,7 @@
|
|
|
2660
2666
|
[
|
|
2661
2667
|
"",
|
|
2662
2668
|
"fetch-deps",
|
|
2663
|
-
"fetch dependencies (bit components) objects to the local scope, but
|
|
2669
|
+
"fetch dependencies (bit components) objects to the local scope, but don't add to the workspace. Useful to resolve errors about missing dependency data"
|
|
2664
2670
|
],
|
|
2665
2671
|
[
|
|
2666
2672
|
"",
|
|
@@ -2816,7 +2822,7 @@
|
|
|
2816
2822
|
[
|
|
2817
2823
|
"f",
|
|
2818
2824
|
"force",
|
|
2819
|
-
"relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will
|
|
2825
|
+
"relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted"
|
|
2820
2826
|
],
|
|
2821
2827
|
[
|
|
2822
2828
|
"",
|
|
@@ -3589,7 +3595,7 @@
|
|
|
3589
3595
|
"arguments": [
|
|
3590
3596
|
{
|
|
3591
3597
|
"name": "component-patterns...",
|
|
3592
|
-
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged."
|
|
3598
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified components are tagged."
|
|
3593
3599
|
}
|
|
3594
3600
|
],
|
|
3595
3601
|
"examples": [
|
|
@@ -4171,7 +4177,7 @@
|
|
|
4171
4177
|
[
|
|
4172
4178
|
"n",
|
|
4173
4179
|
"alias <string>",
|
|
4174
|
-
"relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
4180
|
+
"relevant when the specified lane is a remote lane. create a local alias for the lane (doesn't affect the lane's name on the remote)"
|
|
4175
4181
|
],
|
|
4176
4182
|
[
|
|
4177
4183
|
"",
|
|
@@ -4565,7 +4571,7 @@
|
|
|
4565
4571
|
]
|
|
4566
4572
|
],
|
|
4567
4573
|
"description": "revert to a previous history of the current lane. see also \"bit lane checkout\"",
|
|
4568
|
-
"extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only
|
|
4574
|
+
"extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only changes the files.\nchoose one or the other based on your needs.\nif you want to continue working on this lane and need the changes from the history to be the head, then use \"lane revert\".\nif you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it.",
|
|
4569
4575
|
"group": "ungrouped",
|
|
4570
4576
|
"private": false,
|
|
4571
4577
|
"arguments": [
|
|
@@ -4667,7 +4673,7 @@
|
|
|
4667
4673
|
[
|
|
4668
4674
|
"",
|
|
4669
4675
|
"skip-fetch",
|
|
4670
|
-
"use the local state of target-lane if
|
|
4676
|
+
"use the local state of target-lane if exists locally, without updating it from the remote"
|
|
4671
4677
|
],
|
|
4672
4678
|
[
|
|
4673
4679
|
"",
|
|
@@ -4696,7 +4702,7 @@
|
|
|
4696
4702
|
]
|
|
4697
4703
|
],
|
|
4698
4704
|
"description": "merge a local or a remote lane to the current lane",
|
|
4699
|
-
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-auto-snap\" to opt-out, or \"tag\" to tag instead.\n\nwhen the components are not diverged in history, and the current lane is behind the merge candidate, the merge will\nsimply update the components and the heads according to the merge candidate.\nto opt-out, use \"--no-snap\", the components will be written as the merge candidate, and will be left as modified.\n\nin case a component
|
|
4705
|
+
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-auto-snap\" to opt-out, or \"tag\" to tag instead.\n\nwhen the components are not diverged in history, and the current lane is behind the merge candidate, the merge will\nsimply update the components and the heads according to the merge candidate.\nto opt-out, use \"--no-snap\", the components will be written as the merge candidate, and will be left as modified.\n\nin case a component on both ends doesn't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.\nthis flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:\n1. if the component exists on main, then the history linked to main will be kept.\nin this case, the strategy of \"--resolve-unrelated\" only determines which source-code to keep. it's not about the history.\n2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.\nunless \"--resolve-unrelated\" is set to \"theirs\", in which case the history of the other lane will be kept.\n2. a. an edge case: if the component is deleted on the current lane, the strategy will always be \"theirs\".\nso then the history (and the source-code) of the other lane will be kept.\n",
|
|
4700
4706
|
"private": true,
|
|
4701
4707
|
"remoteOp": true,
|
|
4702
4708
|
"arguments": [
|
|
@@ -4746,7 +4752,7 @@
|
|
|
4746
4752
|
]
|
|
4747
4753
|
],
|
|
4748
4754
|
"description": "EXPERIMENT. move the current merge state into a new lane. the current lane will be reset",
|
|
4749
|
-
"extendedDescription": "this command is useful when you got a messy merge state that
|
|
4755
|
+
"extendedDescription": "this command is useful when you got a messy merge state that on one hand you don't want\nto lose the changes, but on the other hand, you want to keep your lane without those changes.\nthis command does the following:\n1. create a new lane with the current merge state. including all the filesystem changes. (in practice, it leaves the fs intact)\n2. reset the current lane to the state before the merge. so then once done with the new lane, you can switch to the current lane and it'll be clean.",
|
|
4750
4756
|
"remoteOp": true
|
|
4751
4757
|
}
|
|
4752
4758
|
]
|
|
@@ -4803,7 +4809,7 @@
|
|
|
4803
4809
|
[
|
|
4804
4810
|
"n",
|
|
4805
4811
|
"alias <string>",
|
|
4806
|
-
"relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
4812
|
+
"relevant when the specified lane is a remote lane. create a local alias for the lane (doesn't affect the lane's name on the remote)"
|
|
4807
4813
|
],
|
|
4808
4814
|
[
|
|
4809
4815
|
"",
|
|
@@ -5328,7 +5334,7 @@
|
|
|
5328
5334
|
[
|
|
5329
5335
|
"",
|
|
5330
5336
|
"reset-lane-new",
|
|
5331
|
-
"same as reset-new, but it only resets components
|
|
5337
|
+
"same as reset-new, but it only resets components belonging to lanes. main components are left intact"
|
|
5332
5338
|
],
|
|
5333
5339
|
[
|
|
5334
5340
|
"",
|
|
@@ -5418,7 +5424,7 @@
|
|
|
5418
5424
|
[
|
|
5419
5425
|
"l",
|
|
5420
5426
|
"layout <name>",
|
|
5421
|
-
"
|
|
5427
|
+
"Graphviz layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
|
|
5422
5428
|
],
|
|
5423
5429
|
[
|
|
5424
5430
|
"",
|
|
@@ -5839,7 +5845,7 @@
|
|
|
5839
5845
|
[
|
|
5840
5846
|
"",
|
|
5841
5847
|
"deprecate",
|
|
5842
|
-
"instead of deleting the original component,
|
|
5848
|
+
"instead of deleting the original component, deprecate it"
|
|
5843
5849
|
],
|
|
5844
5850
|
[
|
|
5845
5851
|
"p",
|
|
@@ -6051,7 +6057,7 @@
|
|
|
6051
6057
|
[
|
|
6052
6058
|
"m",
|
|
6053
6059
|
"merge",
|
|
6054
|
-
"merge with an existing config if
|
|
6060
|
+
"merge with an existing config if exists. (by default, it replaces overlapping existing configs)"
|
|
6055
6061
|
]
|
|
6056
6062
|
],
|
|
6057
6063
|
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|