@teambit/harmony.content.cli-reference 1.95.160 → 1.95.162
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 +46 -36
- package/cli-reference.mdx +66 -64
- package/dist/cli-reference.json +46 -36
- package/dist/cli-reference.mdx.js +60 -32
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1687750044063.js → preview-1688181390351.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.162.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.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
|
|
|
@@ -616,6 +616,7 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
616
616
|
| `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
|
|
617
617
|
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
|
|
618
618
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
619
|
+
| `--env <string>` | `-e` | set the environment for the new component |
|
|
619
620
|
| `--skip-config` | | do not copy the config (aspects-config) to the new component. helpful when it fails during aspect loading |
|
|
620
621
|
| `--preserve` | | avoid renaming files and variables/classes according to the new component name |
|
|
621
622
|
| `--no-link` | | avoid saving a reference to the original component |
|
|
@@ -650,7 +651,7 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
650
651
|
|
|
651
652
|
## graph
|
|
652
653
|
|
|
653
|
-
**Description**:
|
|
654
|
+
**Description**: generate an image file with the dependencies graph
|
|
654
655
|
|
|
655
656
|
`bit graph [id]`
|
|
656
657
|
|
|
@@ -693,12 +694,13 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
693
694
|
| `--json` | `-j` | return the output as JSON |
|
|
694
695
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
695
696
|
| `--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` | |
|
|
697
|
+
| `--dependencies` | | import all dependencies and write them to the workspace |
|
|
698
|
+
| `--dependents` | | import components found while traversing from the given ids upwards to the workspace components |
|
|
699
|
+
| `--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
700
|
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
700
701
|
| `--fetch-deps` | | fetch dependencies objects |
|
|
701
702
|
| `--track-only` | | do not write any file, just create .bitmap entries of the imported components |
|
|
703
|
+
| `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
|
|
702
704
|
|
|
703
705
|
---
|
|
704
706
|
|
|
@@ -786,7 +788,7 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
786
788
|
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
787
789
|
| `--get-all` | `-a` | checkout all components in a lane include ones that do not exist in the workspace |
|
|
788
790
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
789
|
-
| `--pattern <component-pattern>` | `-p` |
|
|
791
|
+
| `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works only when the workspace is empty |
|
|
790
792
|
| `--json` | `-j` | return the output as JSON |
|
|
791
793
|
|
|
792
794
|
### lane show
|
|
@@ -855,9 +857,9 @@ bit lane diff => diff between the current lane and default lane. (only inside wo
|
|
|
855
857
|
bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
|
|
856
858
|
bit lane diff from to => diff between "from" lane and "to" lane.
|
|
857
859
|
|
|
858
|
-
| **Option** | **Option alias** | **Description**
|
|
859
|
-
| ------------------------------- | :--------------: |
|
|
860
|
-
| `--pattern <component-pattern>` | |
|
|
860
|
+
| **Option** | **Option alias** | **Description** |
|
|
861
|
+
| ------------------------------- | :--------------: | ------------------------------------------------------- |
|
|
862
|
+
| `--pattern <component-pattern>` | | show lane-diff for the specified component-pattern only |
|
|
861
863
|
|
|
862
864
|
### lane add-readme
|
|
863
865
|
|
|
@@ -877,10 +879,10 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
877
879
|
|
|
878
880
|
**Description**: import a remote lane to your workspace
|
|
879
881
|
|
|
880
|
-
| **Option** | **Option alias** | **Description**
|
|
881
|
-
| -------------------------------- | :--------------: |
|
|
882
|
-
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components
|
|
883
|
-
| `--pattern <component-pattern>` | `-p` |
|
|
882
|
+
| **Option** | **Option alias** | **Description** |
|
|
883
|
+
| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------- |
|
|
884
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
885
|
+
| `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works only when the workspace is empty |
|
|
884
886
|
|
|
885
887
|
### lane remove-comp
|
|
886
888
|
|
|
@@ -908,25 +910,25 @@ to merge the lane from the local scope without updating it first, use "--skip-fe
|
|
|
908
910
|
when the current and the other lanes are diverged in history and the files could be merged with no conflicts,
|
|
909
911
|
it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
|
|
910
912
|
|
|
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]` | |
|
|
913
|
+
| **Option** | **Option alias** | **Description** |
|
|
914
|
+
| -------------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
915
|
+
| `--ours` | | in case of a conflict, override the used version with the current modification |
|
|
916
|
+
| `--theirs` | | in case of a conflict, override the current modification with the specified version |
|
|
917
|
+
| `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
918
|
+
| `--workspace` | | merge only components in a lane that exist in the workspace |
|
|
919
|
+
| `--no-snap` | | do not auto snap in case the merge completed without conflicts |
|
|
920
|
+
| `--tag` | | tag all lane components after merging into main (also tag-merge in case of snap-merge) |
|
|
921
|
+
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
922
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
923
|
+
| `--keep-readme` | | skip deleting the lane readme component after merging |
|
|
924
|
+
| `--no-squash` | | relevant for merging lanes into main, which by default squash |
|
|
925
|
+
| `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash |
|
|
926
|
+
| `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files |
|
|
927
|
+
| `--verbose` | | show details of components that were not merged legitimately |
|
|
928
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
929
|
+
| `--skip-fetch` | | use the current target-lane if exits locally without updating it from the remote |
|
|
930
|
+
| `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the given components |
|
|
931
|
+
| `--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
932
|
|
|
931
933
|
| **Option** | **Option alias** | **Description** |
|
|
932
934
|
| ------------------- | :--------------: | ------------------------------------------------------------- |
|
|
@@ -944,13 +946,13 @@ it will snap-merge these components to complete the merge. use "no-snap" to opt-
|
|
|
944
946
|
|
|
945
947
|
`bit link [component-names...]`
|
|
946
948
|
|
|
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
|
|
949
|
+
| **Option** | **Option alias** | **Description** |
|
|
950
|
+
| ------------------------- | :--------------: | ------------------------------------------------------------------------------------------------ |
|
|
951
|
+
| `--json` | `-j` | return the output as JSON |
|
|
952
|
+
| `--verbose` | | verbose output |
|
|
953
|
+
| `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
|
|
954
|
+
| `--target <dir>` | | link to an external directory (similar to npm-link) so other projects could use these components |
|
|
955
|
+
| `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking |
|
|
954
956
|
|
|
955
957
|
---
|
|
956
958
|
|
|
@@ -993,12 +995,12 @@ https://bit.dev/docs/reference/cli-reference#list
|
|
|
993
995
|
|
|
994
996
|
`bit log <id>`
|
|
995
997
|
|
|
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
|
|
998
|
+
| **Option** | **Option alias** | **Description** |
|
|
999
|
+
| ------------ | :--------------: | ------------------------------- |
|
|
1000
|
+
| `--remote` | `-r` | show log of a remote component |
|
|
1001
|
+
| `--parents` | | show parents and lanes data |
|
|
1002
|
+
| `--one-line` | `-o` | show each log entry in one line |
|
|
1003
|
+
| `--json` | `-j` | json format |
|
|
1002
1004
|
|
|
1003
1005
|
---
|
|
1004
1006
|
|
|
@@ -1054,20 +1056,20 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
|
|
|
1054
1056
|
| `--ours` | | in case of a conflict, override the used version with the current modification |
|
|
1055
1057
|
| `--theirs` | | in case of a conflict, override the current modification with the specified version |
|
|
1056
1058
|
| `--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` | |
|
|
1059
|
+
| `--abort` | | in case of an unresolved merge, revert to the state before the merge began |
|
|
1060
|
+
| `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes |
|
|
1061
|
+
| `--no-snap` | | do not auto snap in case the merge completed without conflicts |
|
|
1060
1062
|
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
1061
1063
|
| `--verbose` | | show details of components that were not merged legitimately |
|
|
1062
1064
|
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
1063
|
-
| `--message <message>` | `-m` |
|
|
1065
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
1064
1066
|
|
|
1065
1067
|
---
|
|
1066
1068
|
|
|
1067
1069
|
## mini-status
|
|
1068
1070
|
|
|
1069
1071
|
**Alias**: `ms`
|
|
1070
|
-
**Description**: basic status for fast execution
|
|
1072
|
+
**Description**: EXPERIMENTAL. basic status for fast execution
|
|
1071
1073
|
shows only modified/new components. for the full status, use "bit status".
|
|
1072
1074
|
the modified are components that their source code have changed, it doesn't check for config/aspect changes
|
|
1073
1075
|
|
|
@@ -1138,7 +1140,7 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
|
|
|
1138
1140
|
|
|
1139
1141
|
## refactor
|
|
1140
1142
|
|
|
1141
|
-
**Description**:
|
|
1143
|
+
**Description**: source code refactoring / codemod
|
|
1142
1144
|
|
|
1143
1145
|
`bit refactor <sub-command>`
|
|
1144
1146
|
|
|
@@ -1212,7 +1214,7 @@ to remove components from lanes, use "bit lane remove-comp".
|
|
|
1212
1214
|
|
|
1213
1215
|
## rename
|
|
1214
1216
|
|
|
1215
|
-
**Description**:
|
|
1217
|
+
**Description**: rename component. if tagged/exported, create a new component and deprecate the original component
|
|
1216
1218
|
|
|
1217
1219
|
`bit rename <current-name> <new-name>`
|
|
1218
1220
|
|
|
@@ -1276,7 +1278,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1276
1278
|
|
|
1277
1279
|
## scope
|
|
1278
1280
|
|
|
1279
|
-
**Description**:
|
|
1281
|
+
**Description**: manage the scope-name for components
|
|
1280
1282
|
|
|
1281
1283
|
`bit scope <sub-command>`
|
|
1282
1284
|
|
|
@@ -1381,7 +1383,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1381
1383
|
|
|
1382
1384
|
## snap
|
|
1383
1385
|
|
|
1384
|
-
**Description**:
|
|
1386
|
+
**Description**: create an immutable and exportable component snapshot (no release version)
|
|
1385
1387
|
|
|
1386
1388
|
`bit snap [component-pattern]`
|
|
1387
1389
|
|
|
@@ -1389,9 +1391,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1389
1391
|
| -------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1390
1392
|
| `--message <message>` | `-m` | log message describing the latest changes |
|
|
1391
1393
|
| `--unmodified` | | include unmodified components (by default, only new and modified components are snapped) |
|
|
1392
|
-
| `--unmerged` | |
|
|
1393
|
-
| `--build` | `-b` |
|
|
1394
|
-
| `--editor [editor]` | |
|
|
1394
|
+
| `--unmerged` | | complete a merge process by snapping the unmerged components |
|
|
1395
|
+
| `--build` | `-b` | not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled |
|
|
1396
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
1395
1397
|
| `--skip-tests` | | skip running component tests during snap process |
|
|
1396
1398
|
| `--skip-auto-snap` | | skip auto snapping dependents |
|
|
1397
1399
|
| `--disable-snap-pipeline` | | skip the snap pipeline |
|
|
@@ -1466,7 +1468,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1466
1468
|
| ---------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1467
1469
|
| `--message <message>` | `-m` | a log message describing latest changes |
|
|
1468
1470
|
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
|
|
1469
|
-
| `--editor [editor]` | |
|
|
1471
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
1470
1472
|
| `--ver <version>` | `-v` | tag with the given version |
|
|
1471
1473
|
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
1472
1474
|
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
@@ -1474,8 +1476,8 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1474
1476
|
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
1475
1477
|
| `--major` | | syntactic sugar for "--increment major" |
|
|
1476
1478
|
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
1477
|
-
| `--snapped` | |
|
|
1478
|
-
| `--unmerged` | |
|
|
1479
|
+
| `--snapped` | | tag components that their head is a snap (not a tag) |
|
|
1480
|
+
| `--unmerged` | | complete a merge process by tagging the unmerged components |
|
|
1479
1481
|
| `--skip-tests` | | skip running component tests during tag process |
|
|
1480
1482
|
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
1481
1483
|
| `--soft` | | do not persist. only keep note of the changes to be made |
|
|
@@ -1486,7 +1488,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1486
1488
|
| `--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
1489
|
| `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
|
|
1488
1490
|
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
|
|
1489
|
-
| `--build` | `-b` |
|
|
1491
|
+
| `--build` | `-b` | not needed for now. run the pipeline build and complete the tag |
|
|
1490
1492
|
| `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
|
|
1491
1493
|
| `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |
|
|
1492
1494
|
| `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
|