@teambit/harmony.content.cli-reference 1.95.160 → 1.95.161
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.json +36 -36
- package/cli-reference.mdx +64 -64
- package/dist/cli-reference.json +36 -36
- package/dist/cli-reference.mdx.js +31 -31
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1687750044063.js → preview-1687922429426.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.161.tgz +0 -0
- package/package.json +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.160.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -228,7 +228,7 @@
|
|
|
228
228
|
"name": "dependents <component-name>",
|
|
229
229
|
"alias": "",
|
|
230
230
|
"options": [],
|
|
231
|
-
"description": "
|
|
231
|
+
"description": "show dependents of the given component",
|
|
232
232
|
"extendedDescription": "",
|
|
233
233
|
"group": "info",
|
|
234
234
|
"private": false
|
|
@@ -628,7 +628,7 @@
|
|
|
628
628
|
"output the commands info as JSON"
|
|
629
629
|
]
|
|
630
630
|
],
|
|
631
|
-
"description": "
|
|
631
|
+
"description": "generate an .md file with all commands details",
|
|
632
632
|
"extendedDescription": "",
|
|
633
633
|
"group": "general",
|
|
634
634
|
"private": false
|
|
@@ -967,7 +967,7 @@
|
|
|
967
967
|
"json format"
|
|
968
968
|
]
|
|
969
969
|
],
|
|
970
|
-
"description": "
|
|
970
|
+
"description": "generate an image file with the dependencies graph",
|
|
971
971
|
"extendedDescription": "",
|
|
972
972
|
"group": "discover",
|
|
973
973
|
"private": false,
|
|
@@ -977,7 +977,7 @@
|
|
|
977
977
|
"name": "scope <sub-command>",
|
|
978
978
|
"alias": "",
|
|
979
979
|
"options": [],
|
|
980
|
-
"description": "
|
|
980
|
+
"description": "manage the scope-name for components",
|
|
981
981
|
"extendedDescription": "",
|
|
982
982
|
"group": "development",
|
|
983
983
|
"private": false,
|
|
@@ -1822,7 +1822,7 @@
|
|
|
1822
1822
|
[
|
|
1823
1823
|
"",
|
|
1824
1824
|
"target <dir>",
|
|
1825
|
-
"
|
|
1825
|
+
"link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1826
1826
|
],
|
|
1827
1827
|
[
|
|
1828
1828
|
"",
|
|
@@ -1907,17 +1907,17 @@
|
|
|
1907
1907
|
[
|
|
1908
1908
|
"",
|
|
1909
1909
|
"dependencies",
|
|
1910
|
-
"
|
|
1910
|
+
"import all dependencies and write them to the workspace"
|
|
1911
1911
|
],
|
|
1912
1912
|
[
|
|
1913
1913
|
"",
|
|
1914
1914
|
"dependents",
|
|
1915
|
-
"
|
|
1915
|
+
"import components found while traversing from the given ids upwards to the workspace components"
|
|
1916
1916
|
],
|
|
1917
1917
|
[
|
|
1918
1918
|
"",
|
|
1919
1919
|
"save-in-lane",
|
|
1920
|
-
"
|
|
1920
|
+
"when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
|
|
1921
1921
|
],
|
|
1922
1922
|
[
|
|
1923
1923
|
"",
|
|
@@ -1954,7 +1954,7 @@
|
|
|
1954
1954
|
[
|
|
1955
1955
|
"l",
|
|
1956
1956
|
"lanes",
|
|
1957
|
-
"
|
|
1957
|
+
"fetch component objects from lanes. note, it does not save the remote lanes objects locally, only the refs"
|
|
1958
1958
|
],
|
|
1959
1959
|
[
|
|
1960
1960
|
"c",
|
|
@@ -2149,7 +2149,7 @@
|
|
|
2149
2149
|
[
|
|
2150
2150
|
"",
|
|
2151
2151
|
"editor [editor]",
|
|
2152
|
-
"
|
|
2152
|
+
"open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
|
|
2153
2153
|
],
|
|
2154
2154
|
[
|
|
2155
2155
|
"v",
|
|
@@ -2189,12 +2189,12 @@
|
|
|
2189
2189
|
[
|
|
2190
2190
|
"",
|
|
2191
2191
|
"snapped",
|
|
2192
|
-
"
|
|
2192
|
+
"tag components that their head is a snap (not a tag)"
|
|
2193
2193
|
],
|
|
2194
2194
|
[
|
|
2195
2195
|
"",
|
|
2196
2196
|
"unmerged",
|
|
2197
|
-
"
|
|
2197
|
+
"complete a merge process by tagging the unmerged components"
|
|
2198
2198
|
],
|
|
2199
2199
|
[
|
|
2200
2200
|
"",
|
|
@@ -2249,7 +2249,7 @@
|
|
|
2249
2249
|
[
|
|
2250
2250
|
"b",
|
|
2251
2251
|
"build",
|
|
2252
|
-
"
|
|
2252
|
+
"not needed for now. run the pipeline build and complete the tag"
|
|
2253
2253
|
],
|
|
2254
2254
|
[
|
|
2255
2255
|
"a",
|
|
@@ -2307,17 +2307,17 @@
|
|
|
2307
2307
|
[
|
|
2308
2308
|
"",
|
|
2309
2309
|
"unmerged",
|
|
2310
|
-
"
|
|
2310
|
+
"complete a merge process by snapping the unmerged components"
|
|
2311
2311
|
],
|
|
2312
2312
|
[
|
|
2313
2313
|
"b",
|
|
2314
2314
|
"build",
|
|
2315
|
-
"
|
|
2315
|
+
"not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled"
|
|
2316
2316
|
],
|
|
2317
2317
|
[
|
|
2318
2318
|
"",
|
|
2319
2319
|
"editor [editor]",
|
|
2320
|
-
"
|
|
2320
|
+
"open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
|
|
2321
2321
|
],
|
|
2322
2322
|
[
|
|
2323
2323
|
"",
|
|
@@ -2360,7 +2360,7 @@
|
|
|
2360
2360
|
"DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
|
|
2361
2361
|
]
|
|
2362
2362
|
],
|
|
2363
|
-
"description": "
|
|
2363
|
+
"description": "create an immutable and exportable component snapshot (no release version)",
|
|
2364
2364
|
"extendedDescription": "",
|
|
2365
2365
|
"group": "development",
|
|
2366
2366
|
"private": false,
|
|
@@ -2705,17 +2705,17 @@
|
|
|
2705
2705
|
[
|
|
2706
2706
|
"",
|
|
2707
2707
|
"abort",
|
|
2708
|
-
"
|
|
2708
|
+
"in case of an unresolved merge, revert to the state before the merge began"
|
|
2709
2709
|
],
|
|
2710
2710
|
[
|
|
2711
2711
|
"",
|
|
2712
2712
|
"resolve",
|
|
2713
|
-
"
|
|
2713
|
+
"mark an unresolved merge as resolved and create a new snap with the changes"
|
|
2714
2714
|
],
|
|
2715
2715
|
[
|
|
2716
2716
|
"",
|
|
2717
2717
|
"no-snap",
|
|
2718
|
-
"
|
|
2718
|
+
"do not auto snap in case the merge completed without conflicts"
|
|
2719
2719
|
],
|
|
2720
2720
|
[
|
|
2721
2721
|
"",
|
|
@@ -2735,7 +2735,7 @@
|
|
|
2735
2735
|
[
|
|
2736
2736
|
"m",
|
|
2737
2737
|
"message <message>",
|
|
2738
|
-
"
|
|
2738
|
+
"override the default message for the auto snap"
|
|
2739
2739
|
]
|
|
2740
2740
|
],
|
|
2741
2741
|
"description": "merge changes of the remote head into local",
|
|
@@ -2864,7 +2864,7 @@
|
|
|
2864
2864
|
[
|
|
2865
2865
|
"p",
|
|
2866
2866
|
"pattern <component-pattern>",
|
|
2867
|
-
"
|
|
2867
|
+
"switch only the specified component-pattern. works only when the workspace is empty"
|
|
2868
2868
|
],
|
|
2869
2869
|
[
|
|
2870
2870
|
"j",
|
|
@@ -3001,7 +3001,7 @@
|
|
|
3001
3001
|
[
|
|
3002
3002
|
"",
|
|
3003
3003
|
"pattern <component-pattern>",
|
|
3004
|
-
"
|
|
3004
|
+
"show lane-diff for the specified component-pattern only"
|
|
3005
3005
|
]
|
|
3006
3006
|
],
|
|
3007
3007
|
"description": "show diff between lanes",
|
|
@@ -3053,7 +3053,7 @@
|
|
|
3053
3053
|
[
|
|
3054
3054
|
"p",
|
|
3055
3055
|
"pattern <component-pattern>",
|
|
3056
|
-
"
|
|
3056
|
+
"switch only the specified component-pattern. works only when the workspace is empty"
|
|
3057
3057
|
]
|
|
3058
3058
|
],
|
|
3059
3059
|
"description": "import a remote lane to your workspace",
|
|
@@ -3175,12 +3175,12 @@
|
|
|
3175
3175
|
[
|
|
3176
3176
|
"",
|
|
3177
3177
|
"include-deps",
|
|
3178
|
-
"
|
|
3178
|
+
"relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
|
|
3179
3179
|
],
|
|
3180
3180
|
[
|
|
3181
3181
|
"",
|
|
3182
3182
|
"resolve-unrelated [merge-strategy]",
|
|
3183
|
-
"
|
|
3183
|
+
"relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be \"ours\" (default) or \"theirs\""
|
|
3184
3184
|
]
|
|
3185
3185
|
],
|
|
3186
3186
|
"description": "merge a local or a remote lane",
|
|
@@ -3194,7 +3194,7 @@
|
|
|
3194
3194
|
},
|
|
3195
3195
|
{
|
|
3196
3196
|
"name": "pattern",
|
|
3197
|
-
"description": "
|
|
3197
|
+
"description": "partially merge the lane with the specified component-pattern"
|
|
3198
3198
|
}
|
|
3199
3199
|
]
|
|
3200
3200
|
}
|
|
@@ -3227,7 +3227,7 @@
|
|
|
3227
3227
|
[
|
|
3228
3228
|
"p",
|
|
3229
3229
|
"pattern <component-pattern>",
|
|
3230
|
-
"
|
|
3230
|
+
"switch only the specified component-pattern. works only when the workspace is empty"
|
|
3231
3231
|
],
|
|
3232
3232
|
[
|
|
3233
3233
|
"j",
|
|
@@ -3268,12 +3268,12 @@
|
|
|
3268
3268
|
[
|
|
3269
3269
|
"",
|
|
3270
3270
|
"no-squash",
|
|
3271
|
-
"
|
|
3271
|
+
"relevant for merging lanes into main, which by default squash."
|
|
3272
3272
|
],
|
|
3273
3273
|
[
|
|
3274
3274
|
"",
|
|
3275
3275
|
"include-deps",
|
|
3276
|
-
"
|
|
3276
|
+
"relevant for \"--pattern\". merge also dependencies of the given components"
|
|
3277
3277
|
],
|
|
3278
3278
|
[
|
|
3279
3279
|
"j",
|
|
@@ -3586,7 +3586,7 @@
|
|
|
3586
3586
|
"name": "refactor <sub-command>",
|
|
3587
3587
|
"alias": "",
|
|
3588
3588
|
"options": [],
|
|
3589
|
-
"description": "
|
|
3589
|
+
"description": "source code refactoring / codemod",
|
|
3590
3590
|
"extendedDescription": "",
|
|
3591
3591
|
"group": "development",
|
|
3592
3592
|
"private": false,
|
|
@@ -3636,7 +3636,7 @@
|
|
|
3636
3636
|
"name": "mini-status [component-pattern]",
|
|
3637
3637
|
"alias": "ms",
|
|
3638
3638
|
"options": [],
|
|
3639
|
-
"description": "basic status for fast execution",
|
|
3639
|
+
"description": "EXPERIMENTAL. basic status for fast execution",
|
|
3640
3640
|
"extendedDescription": "shows only modified/new components. for the full status, use \"bit status\".\nthe modified are components that their source code have changed, it doesn't check for config/aspect changes",
|
|
3641
3641
|
"group": "development",
|
|
3642
3642
|
"private": false,
|
|
@@ -3944,7 +3944,7 @@
|
|
|
3944
3944
|
"name": "aspect <sub-command>",
|
|
3945
3945
|
"alias": "",
|
|
3946
3946
|
"options": [],
|
|
3947
|
-
"description": "
|
|
3947
|
+
"description": "manage aspects",
|
|
3948
3948
|
"extendedDescription": "",
|
|
3949
3949
|
"group": "development",
|
|
3950
3950
|
"private": false,
|
|
@@ -4103,7 +4103,7 @@
|
|
|
4103
4103
|
[
|
|
4104
4104
|
"",
|
|
4105
4105
|
"parents",
|
|
4106
|
-
"
|
|
4106
|
+
"show parents and lanes data"
|
|
4107
4107
|
],
|
|
4108
4108
|
[
|
|
4109
4109
|
"o",
|
|
@@ -4209,7 +4209,7 @@
|
|
|
4209
4209
|
"avoid renaming files and variables/classes according to the new component name"
|
|
4210
4210
|
]
|
|
4211
4211
|
],
|
|
4212
|
-
"description": "
|
|
4212
|
+
"description": "rename component. if tagged/exported, create a new component and deprecate the original component",
|
|
4213
4213
|
"extendedDescription": "",
|
|
4214
4214
|
"group": "collaborate",
|
|
4215
4215
|
"private": false,
|
|
@@ -4266,7 +4266,7 @@
|
|
|
4266
4266
|
"avoid saving a reference to the original component"
|
|
4267
4267
|
]
|
|
4268
4268
|
],
|
|
4269
|
-
"description": "
|
|
4269
|
+
"description": "create a new component out of an existing one (copies source files and config)",
|
|
4270
4270
|
"extendedDescription": "",
|
|
4271
4271
|
"group": "collaborate",
|
|
4272
4272
|
"private": false,
|
package/cli-reference.mdx
CHANGED
|
@@ -90,7 +90,7 @@ and a package.tgz file generated by pkg aspect.
|
|
|
90
90
|
|
|
91
91
|
## aspect
|
|
92
92
|
|
|
93
|
-
**Description**:
|
|
93
|
+
**Description**: manage aspects
|
|
94
94
|
|
|
95
95
|
`bit aspect <sub-command>`
|
|
96
96
|
|
|
@@ -282,7 +282,7 @@ The following gets removed by this command:
|
|
|
282
282
|
|
|
283
283
|
**Usage**: `cli generate`
|
|
284
284
|
|
|
285
|
-
**Description**:
|
|
285
|
+
**Description**: generate an .md file with all commands details
|
|
286
286
|
|
|
287
287
|
| **Option** | **Option alias** | **Description** |
|
|
288
288
|
| ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -366,7 +366,7 @@ https://bit.dev/docs/config/bit-config
|
|
|
366
366
|
|
|
367
367
|
## dependents
|
|
368
368
|
|
|
369
|
-
**Description**:
|
|
369
|
+
**Description**: show dependents of the given component
|
|
370
370
|
|
|
371
371
|
`bit dependents <component-name>`
|
|
372
372
|
|
|
@@ -606,7 +606,7 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
606
606
|
|
|
607
607
|
## fork
|
|
608
608
|
|
|
609
|
-
**Description**:
|
|
609
|
+
**Description**: create a new component out of an existing one (copies source files and config)
|
|
610
610
|
|
|
611
611
|
`bit fork <source-component-id> [target-component-name]`
|
|
612
612
|
|
|
@@ -650,7 +650,7 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
650
650
|
|
|
651
651
|
## graph
|
|
652
652
|
|
|
653
|
-
**Description**:
|
|
653
|
+
**Description**: generate an image file with the dependencies graph
|
|
654
654
|
|
|
655
655
|
`bit graph [id]`
|
|
656
656
|
|
|
@@ -693,9 +693,9 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
693
693
|
| `--json` | `-j` | return the output as JSON |
|
|
694
694
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
695
695
|
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
|
|
696
|
-
| `--dependencies` | |
|
|
697
|
-
| `--dependents` | |
|
|
698
|
-
| `--save-in-lane` | |
|
|
696
|
+
| `--dependencies` | | import all dependencies and write them to the workspace |
|
|
697
|
+
| `--dependents` | | import components found while traversing from the given ids upwards to the workspace components |
|
|
698
|
+
| `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
|
|
699
699
|
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
700
700
|
| `--fetch-deps` | | fetch dependencies objects |
|
|
701
701
|
| `--track-only` | | do not write any file, just create .bitmap entries of the imported components |
|
|
@@ -786,7 +786,7 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
786
786
|
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
787
787
|
| `--get-all` | `-a` | checkout all components in a lane include ones that do not exist in the workspace |
|
|
788
788
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
789
|
-
| `--pattern <component-pattern>` | `-p` |
|
|
789
|
+
| `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works only when the workspace is empty |
|
|
790
790
|
| `--json` | `-j` | return the output as JSON |
|
|
791
791
|
|
|
792
792
|
### lane show
|
|
@@ -855,9 +855,9 @@ bit lane diff => diff between the current lane and default lane. (only inside wo
|
|
|
855
855
|
bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
|
|
856
856
|
bit lane diff from to => diff between "from" lane and "to" lane.
|
|
857
857
|
|
|
858
|
-
| **Option** | **Option alias** | **Description**
|
|
859
|
-
| ------------------------------- | :--------------: |
|
|
860
|
-
| `--pattern <component-pattern>` | |
|
|
858
|
+
| **Option** | **Option alias** | **Description** |
|
|
859
|
+
| ------------------------------- | :--------------: | ------------------------------------------------------- |
|
|
860
|
+
| `--pattern <component-pattern>` | | show lane-diff for the specified component-pattern only |
|
|
861
861
|
|
|
862
862
|
### lane add-readme
|
|
863
863
|
|
|
@@ -877,10 +877,10 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
877
877
|
|
|
878
878
|
**Description**: import a remote lane to your workspace
|
|
879
879
|
|
|
880
|
-
| **Option** | **Option alias** | **Description**
|
|
881
|
-
| -------------------------------- | :--------------: |
|
|
882
|
-
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components
|
|
883
|
-
| `--pattern <component-pattern>` | `-p` |
|
|
880
|
+
| **Option** | **Option alias** | **Description** |
|
|
881
|
+
| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------- |
|
|
882
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
883
|
+
| `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works only when the workspace is empty |
|
|
884
884
|
|
|
885
885
|
### lane remove-comp
|
|
886
886
|
|
|
@@ -908,25 +908,25 @@ to merge the lane from the local scope without updating it first, use "--skip-fe
|
|
|
908
908
|
when the current and the other lanes are diverged in history and the files could be merged with no conflicts,
|
|
909
909
|
it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
|
|
910
910
|
|
|
911
|
-
| **Option** | **Option alias** | **Description**
|
|
912
|
-
| -------------------------------------- | :--------------: |
|
|
913
|
-
| `--ours` | | in case of a conflict, override the used version with the current modification
|
|
914
|
-
| `--theirs` | | in case of a conflict, override the current modification with the specified version
|
|
915
|
-
| `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later
|
|
916
|
-
| `--workspace` | | merge only components in a lane that exist in the workspace
|
|
917
|
-
| `--no-snap` | | do not auto snap in case the merge completed without conflicts
|
|
918
|
-
| `--tag` | | tag all lane components after merging into main (also tag-merge in case of snap-merge)
|
|
919
|
-
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build)
|
|
920
|
-
| `--message <message>` | `-m` | override the default message for the auto snap
|
|
921
|
-
| `--keep-readme` | | skip deleting the lane readme component after merging
|
|
922
|
-
| `--no-squash` | | relevant for merging lanes into main, which by default squash
|
|
923
|
-
| `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash
|
|
924
|
-
| `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files
|
|
925
|
-
| `--verbose` | | show details of components that were not merged legitimately
|
|
926
|
-
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components
|
|
927
|
-
| `--skip-fetch` | | use the current target-lane if exits locally without updating it from the remote
|
|
928
|
-
| `--include-deps` | |
|
|
929
|
-
| `--resolve-unrelated [merge-strategy]` | |
|
|
911
|
+
| **Option** | **Option alias** | **Description** |
|
|
912
|
+
| -------------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
913
|
+
| `--ours` | | in case of a conflict, override the used version with the current modification |
|
|
914
|
+
| `--theirs` | | in case of a conflict, override the current modification with the specified version |
|
|
915
|
+
| `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
916
|
+
| `--workspace` | | merge only components in a lane that exist in the workspace |
|
|
917
|
+
| `--no-snap` | | do not auto snap in case the merge completed without conflicts |
|
|
918
|
+
| `--tag` | | tag all lane components after merging into main (also tag-merge in case of snap-merge) |
|
|
919
|
+
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
920
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
921
|
+
| `--keep-readme` | | skip deleting the lane readme component after merging |
|
|
922
|
+
| `--no-squash` | | relevant for merging lanes into main, which by default squash |
|
|
923
|
+
| `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash |
|
|
924
|
+
| `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files |
|
|
925
|
+
| `--verbose` | | show details of components that were not merged legitimately |
|
|
926
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
927
|
+
| `--skip-fetch` | | use the current target-lane if exits locally without updating it from the remote |
|
|
928
|
+
| `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the given components |
|
|
929
|
+
| `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be "ours" (default) or "theirs" |
|
|
930
930
|
|
|
931
931
|
| **Option** | **Option alias** | **Description** |
|
|
932
932
|
| ------------------- | :--------------: | ------------------------------------------------------------- |
|
|
@@ -944,13 +944,13 @@ it will snap-merge these components to complete the merge. use "no-snap" to opt-
|
|
|
944
944
|
|
|
945
945
|
`bit link [component-names...]`
|
|
946
946
|
|
|
947
|
-
| **Option** | **Option alias** | **Description**
|
|
948
|
-
| ------------------------- | :--------------: |
|
|
949
|
-
| `--json` | `-j` | return the output as JSON
|
|
950
|
-
| `--verbose` | | verbose output
|
|
951
|
-
| `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo")
|
|
952
|
-
| `--target <dir>` | |
|
|
953
|
-
| `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking
|
|
947
|
+
| **Option** | **Option alias** | **Description** |
|
|
948
|
+
| ------------------------- | :--------------: | ------------------------------------------------------------------------------------------------ |
|
|
949
|
+
| `--json` | `-j` | return the output as JSON |
|
|
950
|
+
| `--verbose` | | verbose output |
|
|
951
|
+
| `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
|
|
952
|
+
| `--target <dir>` | | link to an external directory (similar to npm-link) so other projects could use these components |
|
|
953
|
+
| `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking |
|
|
954
954
|
|
|
955
955
|
---
|
|
956
956
|
|
|
@@ -993,12 +993,12 @@ https://bit.dev/docs/reference/cli-reference#list
|
|
|
993
993
|
|
|
994
994
|
`bit log <id>`
|
|
995
995
|
|
|
996
|
-
| **Option** | **Option alias** | **Description**
|
|
997
|
-
| ------------ | :--------------: |
|
|
998
|
-
| `--remote` | `-r` | show log of a remote component
|
|
999
|
-
| `--parents` | |
|
|
1000
|
-
| `--one-line` | `-o` | show each log entry in one line
|
|
1001
|
-
| `--json` | `-j` | json format
|
|
996
|
+
| **Option** | **Option alias** | **Description** |
|
|
997
|
+
| ------------ | :--------------: | ------------------------------- |
|
|
998
|
+
| `--remote` | `-r` | show log of a remote component |
|
|
999
|
+
| `--parents` | | show parents and lanes data |
|
|
1000
|
+
| `--one-line` | `-o` | show each log entry in one line |
|
|
1001
|
+
| `--json` | `-j` | json format |
|
|
1002
1002
|
|
|
1003
1003
|
---
|
|
1004
1004
|
|
|
@@ -1054,20 +1054,20 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
|
|
|
1054
1054
|
| `--ours` | | in case of a conflict, override the used version with the current modification |
|
|
1055
1055
|
| `--theirs` | | in case of a conflict, override the current modification with the specified version |
|
|
1056
1056
|
| `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
1057
|
-
| `--abort` | |
|
|
1058
|
-
| `--resolve` | |
|
|
1059
|
-
| `--no-snap` | |
|
|
1057
|
+
| `--abort` | | in case of an unresolved merge, revert to the state before the merge began |
|
|
1058
|
+
| `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes |
|
|
1059
|
+
| `--no-snap` | | do not auto snap in case the merge completed without conflicts |
|
|
1060
1060
|
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
1061
1061
|
| `--verbose` | | show details of components that were not merged legitimately |
|
|
1062
1062
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
1063
|
-
| `--message <message>` | `-m` |
|
|
1063
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
1064
1064
|
|
|
1065
1065
|
---
|
|
1066
1066
|
|
|
1067
1067
|
## mini-status
|
|
1068
1068
|
|
|
1069
1069
|
**Alias**: `ms`
|
|
1070
|
-
**Description**: basic status for fast execution
|
|
1070
|
+
**Description**: EXPERIMENTAL. basic status for fast execution
|
|
1071
1071
|
shows only modified/new components. for the full status, use "bit status".
|
|
1072
1072
|
the modified are components that their source code have changed, it doesn't check for config/aspect changes
|
|
1073
1073
|
|
|
@@ -1138,7 +1138,7 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
|
|
|
1138
1138
|
|
|
1139
1139
|
## refactor
|
|
1140
1140
|
|
|
1141
|
-
**Description**:
|
|
1141
|
+
**Description**: source code refactoring / codemod
|
|
1142
1142
|
|
|
1143
1143
|
`bit refactor <sub-command>`
|
|
1144
1144
|
|
|
@@ -1212,7 +1212,7 @@ to remove components from lanes, use "bit lane remove-comp".
|
|
|
1212
1212
|
|
|
1213
1213
|
## rename
|
|
1214
1214
|
|
|
1215
|
-
**Description**:
|
|
1215
|
+
**Description**: rename component. if tagged/exported, create a new component and deprecate the original component
|
|
1216
1216
|
|
|
1217
1217
|
`bit rename <current-name> <new-name>`
|
|
1218
1218
|
|
|
@@ -1276,7 +1276,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1276
1276
|
|
|
1277
1277
|
## scope
|
|
1278
1278
|
|
|
1279
|
-
**Description**:
|
|
1279
|
+
**Description**: manage the scope-name for components
|
|
1280
1280
|
|
|
1281
1281
|
`bit scope <sub-command>`
|
|
1282
1282
|
|
|
@@ -1381,7 +1381,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1381
1381
|
|
|
1382
1382
|
## snap
|
|
1383
1383
|
|
|
1384
|
-
**Description**:
|
|
1384
|
+
**Description**: create an immutable and exportable component snapshot (no release version)
|
|
1385
1385
|
|
|
1386
1386
|
`bit snap [component-pattern]`
|
|
1387
1387
|
|
|
@@ -1389,9 +1389,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1389
1389
|
| -------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1390
1390
|
| `--message <message>` | `-m` | log message describing the latest changes |
|
|
1391
1391
|
| `--unmodified` | | include unmodified components (by default, only new and modified components are snapped) |
|
|
1392
|
-
| `--unmerged` | |
|
|
1393
|
-
| `--build` | `-b` |
|
|
1394
|
-
| `--editor [editor]` | |
|
|
1392
|
+
| `--unmerged` | | complete a merge process by snapping the unmerged components |
|
|
1393
|
+
| `--build` | `-b` | not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled |
|
|
1394
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
1395
1395
|
| `--skip-tests` | | skip running component tests during snap process |
|
|
1396
1396
|
| `--skip-auto-snap` | | skip auto snapping dependents |
|
|
1397
1397
|
| `--disable-snap-pipeline` | | skip the snap pipeline |
|
|
@@ -1466,7 +1466,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1466
1466
|
| ---------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1467
1467
|
| `--message <message>` | `-m` | a log message describing latest changes |
|
|
1468
1468
|
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
|
|
1469
|
-
| `--editor [editor]` | |
|
|
1469
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
1470
1470
|
| `--ver <version>` | `-v` | tag with the given version |
|
|
1471
1471
|
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
1472
1472
|
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
@@ -1474,8 +1474,8 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1474
1474
|
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
1475
1475
|
| `--major` | | syntactic sugar for "--increment major" |
|
|
1476
1476
|
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
1477
|
-
| `--snapped` | |
|
|
1478
|
-
| `--unmerged` | |
|
|
1477
|
+
| `--snapped` | | tag components that their head is a snap (not a tag) |
|
|
1478
|
+
| `--unmerged` | | complete a merge process by tagging the unmerged components |
|
|
1479
1479
|
| `--skip-tests` | | skip running component tests during tag process |
|
|
1480
1480
|
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
1481
1481
|
| `--soft` | | do not persist. only keep note of the changes to be made |
|
|
@@ -1486,7 +1486,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1486
1486
|
| `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
|
|
1487
1487
|
| `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
|
|
1488
1488
|
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
|
|
1489
|
-
| `--build` | `-b` |
|
|
1489
|
+
| `--build` | `-b` | not needed for now. run the pipeline build and complete the tag |
|
|
1490
1490
|
| `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
|
|
1491
1491
|
| `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |
|
|
1492
1492
|
| `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
|