@teambit/harmony.content.cli-reference 2.0.1132 → 2.0.1134
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-1784226359095.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/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",
|
package/cli-reference.mdx
CHANGED
|
@@ -168,9 +168,9 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
168
168
|
| `aspect-id` | the aspect's component id |
|
|
169
169
|
| `config` | the aspect config. enter the config as a stringified JSON (e.g. `{"foo":"bar"}` ). when no config is provided, an aspect is set with an empty config ({}). |
|
|
170
170
|
|
|
171
|
-
| **Option** | **Option alias** | **Description**
|
|
172
|
-
| ---------- | :--------------: |
|
|
173
|
-
| `--merge` | `-m` | merge with an existing config if
|
|
171
|
+
| **Option** | **Option alias** | **Description** |
|
|
172
|
+
| ---------- | :--------------: | ----------------------------------------------------------------------------------------------- |
|
|
173
|
+
| `--merge` | `-m` | merge with an existing config if exists. (by default, it replaces overlapping existing configs) |
|
|
174
174
|
|
|
175
175
|
### aspect unset
|
|
176
176
|
|
|
@@ -602,7 +602,7 @@ to remove components from your local workspace only, use "bit remove" instead.
|
|
|
602
602
|
| `--range <string>` | | EXPERIMENTAL. enter a Semver range to delete specific tags (cannot be used for snaps). see https://www.npmjs.com/package/semver#ranges for the range syntax |
|
|
603
603
|
| `--silent` | `-s` | skip confirmation |
|
|
604
604
|
| `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. |
|
|
605
|
-
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will
|
|
605
|
+
| `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted |
|
|
606
606
|
| `--snaps <string>` | | comma-separated list of snap hashes to mark as deleted (e.g. --snaps "hash1,hash2,hash3") |
|
|
607
607
|
|
|
608
608
|
---
|
|
@@ -918,10 +918,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
918
918
|
|
|
919
919
|
`bit eject-conf <pattern>`
|
|
920
920
|
|
|
921
|
-
| **Option** | **Option alias** | **Description**
|
|
922
|
-
| ------------- | :--------------: |
|
|
923
|
-
| `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be
|
|
924
|
-
| `--override` | `-o` | override file if
|
|
921
|
+
| **Option** | **Option alias** | **Description** |
|
|
922
|
+
| ------------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
923
|
+
| `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be merged with workspace configs |
|
|
924
|
+
| `--override` | `-o` | override the file if it exists |
|
|
925
925
|
|
|
926
926
|
---
|
|
927
927
|
|
|
@@ -971,8 +971,8 @@ environments control how components are built, tested, linted, and deployed.
|
|
|
971
971
|
|
|
972
972
|
**Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
|
|
973
973
|
keep in mind that this doesn't remove envs that are set via variants.
|
|
974
|
-
|
|
975
|
-
the purpose of this command is to reset previously assigned envs to either allow variants configure the env or use the base node env.
|
|
974
|
+
it only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
|
|
975
|
+
the purpose of this command is to reset previously assigned envs to either allow variants to configure the env or use the base node env.
|
|
976
976
|
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
|
|
977
977
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
978
978
|
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
@@ -1142,7 +1142,7 @@ by default shows only workspace components; use --include-dependencies for full
|
|
|
1142
1142
|
| **Option** | **Option alias** | **Description** |
|
|
1143
1143
|
| ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
1144
1144
|
| `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
|
|
1145
|
-
| `--layout <name>` | |
|
|
1145
|
+
| `--layout <name>` | | Graphviz layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
|
|
1146
1146
|
| `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
|
|
1147
1147
|
| `--cycles` | | generate a graph of cycles only |
|
|
1148
1148
|
| `--include-local-only` | | DEPRECATED: include only the components in the workspace (or local scope). This is now the default behavior. |
|
|
@@ -1194,12 +1194,12 @@ without arguments, fetches all workspace components' latest versions from their
|
|
|
1194
1194
|
| `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
|
|
1195
1195
|
| `--dependents-via <string>` | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |
|
|
1196
1196
|
| `--dependents-all` | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |
|
|
1197
|
-
| `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and
|
|
1197
|
+
| `--dependents-dry-run` | | DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and waits for confirmation before importing them |
|
|
1198
1198
|
| `--silent` | | no prompt for --dependents/--dependents-via flags |
|
|
1199
1199
|
| `--filter-envs <envs>` | | only import components that have the specified environment (e.g., "teambit.react/react-env") |
|
|
1200
1200
|
| `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
|
|
1201
1201
|
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
1202
|
-
| `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but
|
|
1202
|
+
| `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but don't add to the workspace. Useful to resolve errors about missing dependency data |
|
|
1203
1203
|
| `--write-deps <target>` | | write all workspace component dependencies to the specified target ("package.json" or "workspace.jsonc"), resolving conflicts by picking the ranges that match the highest versions |
|
|
1204
1204
|
| `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
|
|
1205
1205
|
| `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
|
|
@@ -1226,7 +1226,7 @@ supports various reset options to recover from corrupted state or restart from s
|
|
|
1226
1226
|
| `--no-package-json` | | do not generate package.json |
|
|
1227
1227
|
| `--reset` | `-r` | write missing or damaged Bit files |
|
|
1228
1228
|
| `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
|
|
1229
|
-
| `--reset-lane-new` | | same as reset-new, but it only resets components
|
|
1229
|
+
| `--reset-lane-new` | | same as reset-new, but it only resets components belonging to lanes. main components are left intact |
|
|
1230
1230
|
| `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch |
|
|
1231
1231
|
| `--reset-scope` | | removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact |
|
|
1232
1232
|
| `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
|
|
@@ -1265,7 +1265,7 @@ automatically imports components, compiles components, links to node_modules, an
|
|
|
1265
1265
|
| `--skip-compile` | | do not compile components |
|
|
1266
1266
|
| `--skip-write-config-files` | | do not write config files (such as eslint, tsconfig, prettier, etc...) |
|
|
1267
1267
|
| `--add-missing-deps` | `-a` | install all missing dependencies |
|
|
1268
|
-
| `--skip-unavailable` | | when adding missing dependencies, skip those that are not found in the
|
|
1268
|
+
| `--skip-unavailable` | | when adding missing dependencies, skip those that are not found in the registry |
|
|
1269
1269
|
| `--add-missing-peers` | | install all missing peer dependencies |
|
|
1270
1270
|
| `--recurring-install` | | automatically run install again if there are non loaded old envs in your workspace |
|
|
1271
1271
|
| `--no-optional [noOptional]` | | do not install optional dependencies (works with pnpm only) |
|
|
@@ -1341,7 +1341,7 @@ without a sub-command, lists all available lanes.
|
|
|
1341
1341
|
| `--workspace-only` | | checkout only the components in the workspace to the selected lane |
|
|
1342
1342
|
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1343
1343
|
| `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1344
|
-
| `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
1344
|
+
| `--alias <string>` | `-n` | 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) |
|
|
1345
1345
|
| `--verbose` | | display detailed information about components that legitimately were not switched |
|
|
1346
1346
|
| `--json` | `-j` | return the output as JSON |
|
|
1347
1347
|
| `--branch` | | create and checkout a new git branch named after the lane |
|
|
@@ -1562,9 +1562,9 @@ run "bit lane history" to find history-ids
|
|
|
1562
1562
|
**Usage**: `lane revert <history-id>`
|
|
1563
1563
|
|
|
1564
1564
|
**Description**: revert to a previous history of the current lane. see also "bit lane checkout"
|
|
1565
|
-
revert is similar to "lane checkout", but it keeps the versions and only
|
|
1565
|
+
revert is similar to "lane checkout", but it keeps the versions and only changes the files.
|
|
1566
1566
|
choose one or the other based on your needs.
|
|
1567
|
-
if you want to continue working on this lane and
|
|
1567
|
+
if you want to continue working on this lane and need the changes from the history to be the head, then use "lane revert".
|
|
1568
1568
|
if you want to fork the lane from a certain point in history, use "lane checkout" and create a new lane from it.
|
|
1569
1569
|
|
|
1570
1570
|
| **Arg** | **Description** |
|
|
@@ -1592,7 +1592,7 @@ when the components are not diverged in history, and the current lane is behind
|
|
|
1592
1592
|
simply update the components and the heads according to the merge candidate.
|
|
1593
1593
|
to opt-out, use "--no-snap", the components will be written as the merge candidate, and will be left as modified.
|
|
1594
1594
|
|
|
1595
|
-
in case a component
|
|
1595
|
+
in case a component on both ends doesn't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.
|
|
1596
1596
|
this 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:
|
|
1597
1597
|
|
|
1598
1598
|
1. if the component exists on main, then the history linked to main will be kept.
|
|
@@ -1626,7 +1626,7 @@ this flag keeps the history of one end and saves a reference to the other end. t
|
|
|
1626
1626
|
| `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
|
|
1627
1627
|
| `--verbose` | | display detailed information about components that were legitimately unmerged |
|
|
1628
1628
|
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1629
|
-
| `--skip-fetch` | | use the local state of target-lane if
|
|
1629
|
+
| `--skip-fetch` | | use the local state of target-lane if exists locally, without updating it from the remote |
|
|
1630
1630
|
| `--include-deps` | | relevant for "pattern" and "--workspace". merge also dependencies of the specified components |
|
|
1631
1631
|
| `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
|
|
1632
1632
|
| `--include-non-lane-comps` | | DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
|
|
@@ -1652,8 +1652,8 @@ also, checkout the workspace components according to the restored lane state
|
|
|
1652
1652
|
**Usage**: `lane merge-move <new-lane-name>`
|
|
1653
1653
|
|
|
1654
1654
|
**Description**: EXPERIMENT. move the current merge state into a new lane. the current lane will be reset
|
|
1655
|
-
this command is useful when you got a messy merge state that
|
|
1656
|
-
to
|
|
1655
|
+
this command is useful when you got a messy merge state that on one hand you don't want
|
|
1656
|
+
to lose the changes, but on the other hand, you want to keep your lane without those changes.
|
|
1657
1657
|
this command does the following:
|
|
1658
1658
|
|
|
1659
1659
|
1. create a new lane with the current merge state. including all the filesystem changes. (in practice, it leaves the fs intact)
|
|
@@ -1841,7 +1841,7 @@ supports custom cloud domains, CI/machine authentication, and manual token refre
|
|
|
1841
1841
|
| `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
|
|
1842
1842
|
| `--no-browser` | | do not open a browser for authentication |
|
|
1843
1843
|
| `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token) |
|
|
1844
|
-
| `--suppress-browser-launch` | |
|
|
1844
|
+
| `--suppress-browser-launch` | | DEPRECATED. use --no-browser instead |
|
|
1845
1845
|
|
|
1846
1846
|
---
|
|
1847
1847
|
|
|
@@ -1995,7 +1995,7 @@ installs dependencies and configures the workspace for immediate development.
|
|
|
1995
1995
|
| `--standalone` | | DEPRECATED. use --skip-git instead |
|
|
1996
1996
|
| `--skip-git` | `-s` | skip generation of Git repository in the new workspace |
|
|
1997
1997
|
| `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
|
|
1998
|
-
| `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during
|
|
1998
|
+
| `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during the development of a workspace-template |
|
|
1999
1999
|
| `--current-dir` | `-c` | create the new workspace in current directory (default is to create a new directory, inside the current dir) |
|
|
2000
2000
|
| `--agent [type]` | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |
|
|
2001
2001
|
|
|
@@ -2176,7 +2176,7 @@ for local components: simply renames the existing component in place.
|
|
|
2176
2176
|
| `--preserve` | | avoid renaming files and variables/classes according to the new component name |
|
|
2177
2177
|
| `--ast` | | use ast to transform files instead of regex |
|
|
2178
2178
|
| `--delete` | | DEPRECATED. this is now the default |
|
|
2179
|
-
| `--deprecate` | | instead of deleting the original component,
|
|
2179
|
+
| `--deprecate` | | instead of deleting the original component, deprecate it |
|
|
2180
2180
|
| `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
|
|
2181
2181
|
|
|
2182
2182
|
---
|
|
@@ -2392,7 +2392,7 @@ essential for organizing components and managing component namespaces across tea
|
|
|
2392
2392
|
|
|
2393
2393
|
**Description**: Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace
|
|
2394
2394
|
default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
|
|
2395
|
-
a component is set with a scope (as
|
|
2395
|
+
a component is set with a scope (as opposed to default scope) only once it is versioned.
|
|
2396
2396
|
|
|
2397
2397
|
you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
|
|
2398
2398
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
@@ -2444,7 +2444,7 @@ as a result of this change
|
|
|
2444
2444
|
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
2445
2445
|
| `--preserve` | | avoid renaming files and variables/classes according to the new scope name |
|
|
2446
2446
|
| `--refactor` | `-r` | update the import statements in all dependent components to the new package name (i.e. with the new scope name) |
|
|
2447
|
-
| `--deprecate` | | for exported components, instead of deleting the original components,
|
|
2447
|
+
| `--deprecate` | | for exported components, instead of deleting the original components, deprecate them |
|
|
2448
2448
|
| `--skip-dependency-installation` | `-x` | do not install dependencies after the rename |
|
|
2449
2449
|
|
|
2450
2450
|
### scope rename-owner
|
|
@@ -2614,7 +2614,7 @@ includes hot module reloading for development.
|
|
|
2614
2614
|
| `--port [port-number]` | `-p` | port of the UI server. |
|
|
2615
2615
|
| `--rebuild` | `-r` | rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case) |
|
|
2616
2616
|
| `--skip-ui-build` | | skip building UI |
|
|
2617
|
-
| `--verbose` | `-v` | show verbose output for inspection and
|
|
2617
|
+
| `--verbose` | `-v` | show verbose output for inspection and print stack trace |
|
|
2618
2618
|
| `--no-browser` | `-n` | do not automatically open browser when ready |
|
|
2619
2619
|
| `--show-internal-urls` | | show urls for all internal dev servers |
|
|
2620
2620
|
| `--skip-compilation` | | skip the auto-compilation before starting the web-server |
|
|
@@ -2729,9 +2729,9 @@ use for official releases. for development versions, use 'bit snap' instead.
|
|
|
2729
2729
|
|
|
2730
2730
|
`bit tag [component-patterns...]`
|
|
2731
2731
|
|
|
2732
|
-
| **Arg** |
|
|
2733
|
-
| ----------------------- |
|
|
2734
|
-
| `component-patterns...` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
|
|
2732
|
+
| **Arg** | **Description** |
|
|
2733
|
+
| ----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2734
|
+
| `component-patterns...` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified components are tagged. |
|
|
2735
2735
|
|
|
2736
2736
|
| **Option** | **Option alias** | **Description** |
|
|
2737
2737
|
| ------------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|