@teambit/harmony.content.cli-reference 1.95.159 → 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.
Files changed (9) hide show
  1. package/cli-reference.json +37 -37
  2. package/cli-reference.mdx +65 -64
  3. package/dist/cli-reference.json +37 -37
  4. package/dist/cli-reference.mdx.js +37 -31
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/dist/{preview-1687663176769.js → preview-1687922429426.js} +2 -2
  7. package/package-tar/teambit-harmony.content.cli-reference-1.95.161.tgz +0 -0
  8. package/package.json +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.159.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -39,6 +39,7 @@ Learn the recommended workflow for tracking directories as components, in the li
39
39
 
40
40
  ## app
41
41
 
42
+ **Alias**: `apps`
42
43
  **Description**: Manages apps
43
44
 
44
45
  `bit app <sub-command>`
@@ -89,7 +90,7 @@ and a package.tgz file generated by pkg aspect.
89
90
 
90
91
  ## aspect
91
92
 
92
- **Description**: EXPERIMENTAL. manage aspects
93
+ **Description**: manage aspects
93
94
 
94
95
  `bit aspect <sub-command>`
95
96
 
@@ -281,7 +282,7 @@ The following gets removed by this command:
281
282
 
282
283
  **Usage**: `cli generate`
283
284
 
284
- **Description**: EXPERIMENTAL. generate an .md file with all commands details
285
+ **Description**: generate an .md file with all commands details
285
286
 
286
287
  | **Option** | **Option alias** | **Description** |
287
288
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -365,7 +366,7 @@ https://bit.dev/docs/config/bit-config
365
366
 
366
367
  ## dependents
367
368
 
368
- **Description**: EXPERIMENTAL. show dependents of the given component
369
+ **Description**: show dependents of the given component
369
370
 
370
371
  `bit dependents <component-name>`
371
372
 
@@ -605,7 +606,7 @@ bit export => export all staged components to their current scope, if checked ou
605
606
 
606
607
  ## fork
607
608
 
608
- **Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
609
+ **Description**: create a new component out of an existing one (copies source files and config)
609
610
 
610
611
  `bit fork <source-component-id> [target-component-name]`
611
612
 
@@ -649,7 +650,7 @@ bit export => export all staged components to their current scope, if checked ou
649
650
 
650
651
  ## graph
651
652
 
652
- **Description**: EXPERIMENTAL. generate an image file with the dependencies graph
653
+ **Description**: generate an image file with the dependencies graph
653
654
 
654
655
  `bit graph [id]`
655
656
 
@@ -692,9 +693,9 @@ bit export => export all staged components to their current scope, if checked ou
692
693
  | `--json` | `-j` | return the output as JSON |
693
694
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
694
695
  | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
695
- | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
696
- | `--dependents` | | EXPERIMENTAL. import components found while traversing from the given ids upwards to the workspace components |
697
- | `--save-in-lane` | | EXPERIMENTAL. 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) |
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) |
698
699
  | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
699
700
  | `--fetch-deps` | | fetch dependencies objects |
700
701
  | `--track-only` | | do not write any file, just create .bitmap entries of the imported components |
@@ -785,7 +786,7 @@ when no package is specified, all workspace dependencies are installed and all w
785
786
  | `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
786
787
  | `--get-all` | `-a` | checkout all components in a lane include ones that do not exist in the workspace |
787
788
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
788
- | `--pattern <component-pattern>` | `-p` | EXPERIMENTAL. switch only the specified component-pattern. works only when the workspace is empty |
789
+ | `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works only when the workspace is empty |
789
790
  | `--json` | `-j` | return the output as JSON |
790
791
 
791
792
  ### lane show
@@ -854,9 +855,9 @@ bit lane diff => diff between the current lane and default lane. (only inside wo
854
855
  bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
855
856
  bit lane diff from to => diff between "from" lane and "to" lane.
856
857
 
857
- | **Option** | **Option alias** | **Description** |
858
- | ------------------------------- | :--------------: | --------------------------------------------------------------------- |
859
- | `--pattern <component-pattern>` | | EXPERIMENTAL. show lane-diff for the specified component-pattern only |
858
+ | **Option** | **Option alias** | **Description** |
859
+ | ------------------------------- | :--------------: | ------------------------------------------------------- |
860
+ | `--pattern <component-pattern>` | | show lane-diff for the specified component-pattern only |
860
861
 
861
862
  ### lane add-readme
862
863
 
@@ -876,10 +877,10 @@ bit lane diff from to => diff between "from" lane and "to" lane.
876
877
 
877
878
  **Description**: import a remote lane to your workspace
878
879
 
879
- | **Option** | **Option alias** | **Description** |
880
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------- |
881
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
882
- | `--pattern <component-pattern>` | `-p` | EXPERIMENTAL. switch only the specified component-pattern. works only when the workspace is empty |
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 |
883
884
 
884
885
  ### lane remove-comp
885
886
 
@@ -907,25 +908,25 @@ to merge the lane from the local scope without updating it first, use "--skip-fe
907
908
  when the current and the other lanes are diverged in history and the files could be merged with no conflicts,
908
909
  it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
909
910
 
910
- | **Option** | **Option alias** | **Description** |
911
- | -------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
912
- | `--ours` | | in case of a conflict, override the used version with the current modification |
913
- | `--theirs` | | in case of a conflict, override the current modification with the specified version |
914
- | `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
915
- | `--workspace` | | merge only components in a lane that exist in the workspace |
916
- | `--no-snap` | | do not auto snap in case the merge completed without conflicts |
917
- | `--tag` | | tag all lane components after merging into main (also tag-merge in case of snap-merge) |
918
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
919
- | `--message <message>` | `-m` | override the default message for the auto snap |
920
- | `--keep-readme` | | skip deleting the lane readme component after merging |
921
- | `--no-squash` | | relevant for merging lanes into main, which by default squash |
922
- | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash |
923
- | `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files |
924
- | `--verbose` | | show details of components that were not merged legitimately |
925
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
926
- | `--skip-fetch` | | use the current target-lane if exits locally without updating it from the remote |
927
- | `--include-deps` | | EXPERIMENTAL. relevant for "--pattern" and "--workspace". merge also dependencies of the given components |
928
- | `--resolve-unrelated [merge-strategy]` | | EXPERIMENTAL. relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be "ours" (default) or "theirs" |
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" |
929
930
 
930
931
  | **Option** | **Option alias** | **Description** |
931
932
  | ------------------- | :--------------: | ------------------------------------------------------------- |
@@ -943,13 +944,13 @@ it will snap-merge these components to complete the merge. use "no-snap" to opt-
943
944
 
944
945
  `bit link [component-names...]`
945
946
 
946
- | **Option** | **Option alias** | **Description** |
947
- | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
948
- | `--json` | `-j` | return the output as JSON |
949
- | `--verbose` | | verbose output |
950
- | `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
951
- | `--target <dir>` | | EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components |
952
- | `--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 |
953
954
 
954
955
  ---
955
956
 
@@ -992,12 +993,12 @@ https://bit.dev/docs/reference/cli-reference#list
992
993
 
993
994
  `bit log <id>`
994
995
 
995
- | **Option** | **Option alias** | **Description** |
996
- | ------------ | :--------------: | ----------------------------------------- |
997
- | `--remote` | `-r` | show log of a remote component |
998
- | `--parents` | | EXPERIMENTAL. show parents and lanes data |
999
- | `--one-line` | `-o` | show each log entry in one line |
1000
- | `--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 |
1001
1002
 
1002
1003
  ---
1003
1004
 
@@ -1053,20 +1054,20 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
1053
1054
  | `--ours` | | in case of a conflict, override the used version with the current modification |
1054
1055
  | `--theirs` | | in case of a conflict, override the current modification with the specified version |
1055
1056
  | `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
1056
- | `--abort` | | EXPERIMENTAL. in case of an unresolved merge, revert to the state before the merge began |
1057
- | `--resolve` | | EXPERIMENTAL. mark an unresolved merge as resolved and create a new snap with the changes |
1058
- | `--no-snap` | | EXPERIMENTAL. do not auto snap in case the merge completed without conflicts |
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 |
1059
1060
  | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1060
1061
  | `--verbose` | | show details of components that were not merged legitimately |
1061
1062
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
1062
- | `--message <message>` | `-m` | EXPERIMENTAL. override the default message for the auto snap |
1063
+ | `--message <message>` | `-m` | override the default message for the auto snap |
1063
1064
 
1064
1065
  ---
1065
1066
 
1066
1067
  ## mini-status
1067
1068
 
1068
1069
  **Alias**: `ms`
1069
- **Description**: basic status for fast execution
1070
+ **Description**: EXPERIMENTAL. basic status for fast execution
1070
1071
  shows only modified/new components. for the full status, use "bit status".
1071
1072
  the modified are components that their source code have changed, it doesn't check for config/aspect changes
1072
1073
 
@@ -1137,7 +1138,7 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
1137
1138
 
1138
1139
  ## refactor
1139
1140
 
1140
- **Description**: EXPERIMENTAL. source code refactoring / codemod
1141
+ **Description**: source code refactoring / codemod
1141
1142
 
1142
1143
  `bit refactor <sub-command>`
1143
1144
 
@@ -1211,7 +1212,7 @@ to remove components from lanes, use "bit lane remove-comp".
1211
1212
 
1212
1213
  ## rename
1213
1214
 
1214
- **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
1215
+ **Description**: rename component. if tagged/exported, create a new component and deprecate the original component
1215
1216
 
1216
1217
  `bit rename <current-name> <new-name>`
1217
1218
 
@@ -1275,7 +1276,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1275
1276
 
1276
1277
  ## scope
1277
1278
 
1278
- **Description**: EXPERIMENTAL. manage the scope-name for components
1279
+ **Description**: manage the scope-name for components
1279
1280
 
1280
1281
  `bit scope <sub-command>`
1281
1282
 
@@ -1380,7 +1381,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1380
1381
 
1381
1382
  ## snap
1382
1383
 
1383
- **Description**: EXPERIMENTAL. create an immutable and exportable component snapshot (no release version)
1384
+ **Description**: create an immutable and exportable component snapshot (no release version)
1384
1385
 
1385
1386
  `bit snap [component-pattern]`
1386
1387
 
@@ -1388,9 +1389,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1388
1389
  | -------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1389
1390
  | `--message <message>` | `-m` | log message describing the latest changes |
1390
1391
  | `--unmodified` | | include unmodified components (by default, only new and modified components are snapped) |
1391
- | `--unmerged` | | EXPERIMENTAL. complete a merge process by snapping the unmerged components |
1392
- | `--build` | `-b` | EXPERIMENTAL. not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled |
1393
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
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). |
1394
1395
  | `--skip-tests` | | skip running component tests during snap process |
1395
1396
  | `--skip-auto-snap` | | skip auto snapping dependents |
1396
1397
  | `--disable-snap-pipeline` | | skip the snap pipeline |
@@ -1465,7 +1466,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1465
1466
  | ---------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1466
1467
  | `--message <message>` | `-m` | a log message describing latest changes |
1467
1468
  | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
1468
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1469
+ | `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1469
1470
  | `--ver <version>` | `-v` | tag with the given version |
1470
1471
  | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1471
1472
  | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
@@ -1473,8 +1474,8 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1473
1474
  | `--minor` | | syntactic sugar for "--increment minor" |
1474
1475
  | `--major` | | syntactic sugar for "--increment major" |
1475
1476
  | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1476
- | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1477
- | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1477
+ | `--snapped` | | tag components that their head is a snap (not a tag) |
1478
+ | `--unmerged` | | complete a merge process by tagging the unmerged components |
1478
1479
  | `--skip-tests` | | skip running component tests during tag process |
1479
1480
  | `--skip-auto-tag` | | skip auto tagging dependents |
1480
1481
  | `--soft` | | do not persist. only keep note of the changes to be made |
@@ -1485,7 +1486,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1485
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 "\*". |
1486
1487
  | `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
1487
1488
  | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
1488
- | `--build` | `-b` | EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag |
1489
+ | `--build` | `-b` | not needed for now. run the pipeline build and complete the tag |
1489
1490
  | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1490
1491
  | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |
1491
1492
  | `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |