@teambit/harmony.content.cli-reference 1.95.201 → 1.95.203

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.
@@ -31,32 +31,32 @@
31
31
  [
32
32
  "",
33
33
  "reset-lane-new",
34
- "same as reset-new, but it only reset components belong to lanes. main components are left intact"
34
+ "same as reset-new, but it only resets components belong to lanes. main components are left intact"
35
35
  ],
36
36
  [
37
37
  "",
38
38
  "reset-hard",
39
- "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-start using Bit from scratch"
39
+ "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch"
40
40
  ],
41
41
  [
42
42
  "",
43
43
  "reset-scope",
44
- "removes local scope (.bit or .git/bit). snaps that were not exported will be lost. workspace left intact"
44
+ "removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact"
45
45
  ],
46
46
  [
47
47
  "d",
48
48
  "default-directory <default-directory>",
49
- "set up default directory to import components into"
49
+ "set the default directory pattern to import/create components into"
50
50
  ],
51
51
  [
52
52
  "",
53
53
  "default-scope <default-scope>",
54
- "set up default scope for all components in the workspace"
54
+ "set the default scope for components in the workspace"
55
55
  ],
56
56
  [
57
57
  "p",
58
58
  "package-manager <package-manager>",
59
- "set up package manager (npm or yarn)"
59
+ "set the package manager (npm or yarn) to be used in the workspace"
60
60
  ],
61
61
  [
62
62
  "f",
@@ -112,7 +112,7 @@
112
112
  "name": "get <key>",
113
113
  "alias": "",
114
114
  "options": [],
115
- "description": "get a global configuration",
115
+ "description": "get a value from global configuration",
116
116
  "extendedDescription": "",
117
117
  "group": "ungrouped",
118
118
  "private": false
@@ -139,7 +139,7 @@
139
139
  ]
140
140
  ],
141
141
  "description": "manage set of tracked bit scope(s)",
142
- "extendedDescription": "https://bit.dev/docs/scope/remote-scopes",
142
+ "extendedDescription": "",
143
143
  "group": "collaborate",
144
144
  "private": false,
145
145
  "commands": [
@@ -165,7 +165,7 @@
165
165
  [
166
166
  "g",
167
167
  "global",
168
- "remove a global configured remote scope"
168
+ "remove a globally configured remote scope"
169
169
  ]
170
170
  ],
171
171
  "description": "remove a tracked bit remote",
@@ -507,7 +507,7 @@
507
507
  [
508
508
  "",
509
509
  "machine-name <name>",
510
- "specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token)"
510
+ "specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token)"
511
511
  ]
512
512
  ],
513
513
  "description": "log in to Bit cloud",
@@ -697,7 +697,7 @@
697
697
  [
698
698
  "j",
699
699
  "json",
700
- "return the component data in a json format"
700
+ "return the component data in json format"
701
701
  ],
702
702
  [
703
703
  "l",
@@ -707,12 +707,12 @@
707
707
  [
708
708
  "r",
709
709
  "remote",
710
- "show a remote component"
710
+ "show data for a remote component"
711
711
  ],
712
712
  [
713
713
  "c",
714
714
  "compare",
715
- "compare current file system component to the latest tagged component [default=latest]. only works in legacy."
715
+ "legacy-only. compare current file system component to its latest tagged version [default=latest]"
716
716
  ]
717
717
  ],
718
718
  "description": "display the component's essential information",
@@ -733,7 +733,7 @@
733
733
  [
734
734
  "j",
735
735
  "json",
736
- "json format"
736
+ "output issues in json format"
737
737
  ]
738
738
  ],
739
739
  "description": "list available component-issues",
@@ -754,7 +754,7 @@
754
754
  "name": "list",
755
755
  "alias": "",
756
756
  "options": [],
757
- "description": "list all envs available in the workspace",
757
+ "description": "list all envs currently used in the workspace",
758
758
  "extendedDescription": "",
759
759
  "group": "development",
760
760
  "private": false
@@ -769,21 +769,21 @@
769
769
  "show information about the specific services only. for multiple services, separate by a comma and wrap with quotes"
770
770
  ]
771
771
  ],
772
- "description": "show information about a component's env",
772
+ "description": "show config information from a component's env",
773
773
  "extendedDescription": "",
774
774
  "group": "development",
775
775
  "private": false,
776
776
  "arguments": [
777
777
  {
778
778
  "name": "component-name",
779
- "description": "the 'component name' or 'component id' of the component its env you'd like to inspect"
779
+ "description": "the 'component name' or 'component id' of the component whose env you'd like to inspect"
780
780
  }
781
781
  ]
782
782
  },
783
783
  {
784
784
  "name": "set <component-pattern> <env>",
785
785
  "options": [],
786
- "description": "Sets one or more components with a development environment (env)",
786
+ "description": "Assigns one or more components a development environment (env)",
787
787
  "group": "development",
788
788
  "arguments": [
789
789
  {
@@ -792,21 +792,21 @@
792
792
  },
793
793
  {
794
794
  "name": "env",
795
- "description": "the env's component id (include version for non-core envs. e.g, `teambit.community/envs/community-react@1.95.13`)"
795
+ "description": "the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`)"
796
796
  }
797
797
  ],
798
798
  "examples": [
799
799
  {
800
- "cmd": "set ui/button teambit.react/react",
801
- "description": "configures 'ui/button' to use the 'teambit.react/react' env"
800
+ "cmd": "set ui/button teambit.react/react-env",
801
+ "description": "configures 'ui/button' to use the latest version of the 'teambit.react/react-env' env"
802
802
  },
803
803
  {
804
804
  "cmd": "set ui/button teambit.community/envs/community-mdx@1.95.16",
805
- "description": "configures 'ui/button' to use the (non-core) 'teambit.community/envs/community-mdx@1.95.16' env"
805
+ "description": "configures 'ui/button' to use the 'teambit.community/envs/community-mdx@1.95.16' env"
806
806
  },
807
807
  {
808
- "cmd": "set \"ui/**\" teambit.react/react",
809
- "description": "configures all components that have the 'ui' namespace to use the teambit.react/react env"
808
+ "cmd": "set \"ui/**\" teambit.react/react-env",
809
+ "description": "configures all components that have the 'ui' namespace to use the latest version of the teambit.react/react-env env"
810
810
  }
811
811
  ]
812
812
  },
@@ -814,12 +814,12 @@
814
814
  "name": "unset <component-pattern>",
815
815
  "options": [],
816
816
  "description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
817
- "extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the 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\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
817
+ "extendedDescription": "keep in mind that this doesn't remove envs that are set via variants.\nin 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 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\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
818
818
  "group": "development",
819
819
  "arguments": [
820
820
  {
821
821
  "name": "component-pattern",
822
- "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
822
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
823
823
  }
824
824
  ]
825
825
  },
@@ -831,7 +831,7 @@
831
831
  "arguments": [
832
832
  {
833
833
  "name": "current-env",
834
- "description": "the component id of the current env"
834
+ "description": "the component id of the env to be replaced"
835
835
  },
836
836
  {
837
837
  "name": "new-env",
@@ -853,21 +853,21 @@
853
853
  "arguments": [
854
854
  {
855
855
  "name": "env-id",
856
- "description": "the environment id (defaults to all envs). optionally, add a version (id@version), otherwise, it finds the latest version on the remote."
856
+ "description": "the environment id (defaults to all envs). optionally, add a version (id@version), if no version is supplied will use the latest version on the remote."
857
857
  },
858
858
  {
859
859
  "name": "pattern",
860
- "description": "the components to update (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
860
+ "description": "the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
861
861
  }
862
862
  ],
863
863
  "examples": [
864
864
  {
865
865
  "cmd": "envs update",
866
- "description": "update all envs in the workspace to their latest version"
866
+ "description": "update all envs for all components in the workspace, to their latest version"
867
867
  },
868
868
  {
869
869
  "cmd": "envs update scope.org/env '**/ui/**'",
870
- "description": "update \"ui\" components that use scope.org/env to use its latest version"
870
+ "description": "update components in the \"ui\" namespace that use scope.org/env to use its latest version"
871
871
  },
872
872
  {
873
873
  "cmd": "envs update scope.org/env@2.0.0",
@@ -884,7 +884,7 @@
884
884
  [
885
885
  "i",
886
886
  "image <image>",
887
- "image path. use one of the following extensions: [gif, png, svg, pdf]"
887
+ "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
888
888
  ],
889
889
  [
890
890
  "r",
@@ -907,7 +907,7 @@
907
907
  "json format"
908
908
  ]
909
909
  ],
910
- "description": "generate an image file with the dependencies graph",
910
+ "description": "generate an image file with the workspace components' dependencies graph",
911
911
  "extendedDescription": "",
912
912
  "group": "discover",
913
913
  "private": false,
@@ -930,7 +930,7 @@
930
930
  [
931
931
  "r",
932
932
  "rebuild",
933
- "rebuild the UI"
933
+ "rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case)"
934
934
  ],
935
935
  [
936
936
  "",
@@ -990,17 +990,17 @@
990
990
  {
991
991
  "name": "set <scope-name> [component-pattern]",
992
992
  "options": [],
993
- "description": "Sets components with a default-scope. If no component is specified, sets the workspace with a default scope",
994
- "extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose 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\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
993
+ "description": "Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace",
994
+ "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 oppose 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\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
995
995
  "group": "development",
996
996
  "arguments": [
997
997
  {
998
998
  "name": "scope-name",
999
- "description": "the scope name to use as the default scope"
999
+ "description": "name of the scope to set"
1000
1000
  },
1001
1001
  {
1002
1002
  "name": "component-pattern",
1003
- "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1003
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1004
1004
  }
1005
1005
  ]
1006
1006
  },
@@ -1010,10 +1010,11 @@
1010
1010
  [
1011
1011
  "r",
1012
1012
  "refactor",
1013
- "update the import statements in all dependent components to the new package name (that contains the new scope name)"
1013
+ "update the import statements in all dependent components to the new package name (i.e. with the new scope name)"
1014
1014
  ]
1015
1015
  ],
1016
- "description": "Renames the scope name for all components with the specified 'current scope name'",
1016
+ "description": "Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged",
1017
+ "extendedDescription": "Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`\nas the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file\nas a result of this change",
1017
1018
  "group": "development",
1018
1019
  "arguments": [
1019
1020
  {
@@ -1051,7 +1052,7 @@
1051
1052
  {
1052
1053
  "name": "fork <original-scope> <new-scope>",
1053
1054
  "options": [],
1054
- "description": "fork all components of the original-scope and refactor the source-code to use the new package names",
1055
+ "description": "fork all components of the original-scope and refactor the source-code to use the new scope name",
1055
1056
  "group": "development"
1056
1057
  }
1057
1058
  ]
@@ -1063,7 +1064,7 @@
1063
1064
  [
1064
1065
  "p",
1065
1066
  "propagate",
1066
- "mark propagate true in the config file"
1067
+ "mark propagate true in the config file, so that component.json configs will be merge with workspace configs"
1067
1068
  ],
1068
1069
  [
1069
1070
  "o",
@@ -1072,7 +1073,7 @@
1072
1073
  ]
1073
1074
  ],
1074
1075
  "description": "eject components configuration (create a `component.json` file)",
1075
- "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
1076
+ "extendedDescription": "note this can be reversed at any time by snapping/tagging changes and deleting the component.json file \nyou can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
1076
1077
  "group": "development",
1077
1078
  "private": false
1078
1079
  },
@@ -1210,7 +1211,7 @@
1210
1211
  ]
1211
1212
  ],
1212
1213
  "description": "list the component ids matching the given pattern",
1213
- "extendedDescription": "this command helps validating a pattern before using it in other commands.\na pattern can be a simple component-id or component-name. e.g. \"ui/button\".\na pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/**\".\nto enter multiple patterns, separate them by a comma, e.g. \"ui/*, lib/*\"\nto exclude, use \"!\". e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nthe matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)\n",
1214
+ "extendedDescription": "this command helps validating a pattern before using it in other commands.\na pattern can be a simple component-id or component-name. e.g. \"ui/button\".\na pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/**\" or \"**/utils/**\" to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. \"ui/*, lib/*\"\nto exclude, use \"!\". e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch)\n",
1214
1215
  "group": "development",
1215
1216
  "private": false,
1216
1217
  "examples": [
@@ -1224,7 +1225,7 @@
1224
1225
  },
1225
1226
  {
1226
1227
  "cmd": "bit pattern \"*/ui/**\"",
1227
- "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
1228
+ "description": "matches components whose namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
1228
1229
  },
1229
1230
  {
1230
1231
  "cmd": "bit pattern \"bar, foo\"",
@@ -1278,12 +1279,12 @@
1278
1279
  [
1279
1280
  "v",
1280
1281
  "verbose",
1281
- "show npm verbose output for inspection and print the stack trace"
1282
+ "show all watch events and compiler verbose output"
1282
1283
  ],
1283
1284
  [
1284
1285
  "",
1285
1286
  "skip-pre-compilation",
1286
- "skip the compilation step before starting to watch"
1287
+ "skip compilation step before starting to watch"
1287
1288
  ],
1288
1289
  [
1289
1290
  "t",
@@ -1292,7 +1293,7 @@
1292
1293
  ]
1293
1294
  ],
1294
1295
  "description": "automatically recompile modified components (on save)",
1295
- "extendedDescription": "",
1296
+ "extendedDescription": "by default, the watcher doesn't use polling, to keep the CPU idle.\nin some rare cases, this could result in missing file events. to fix it, try to prefix this command with CHOKIDAR_USEPOLLING=true\nalternatively, restarting the computer could also help.",
1296
1297
  "group": "development",
1297
1298
  "private": false
1298
1299
  },
@@ -1308,7 +1309,7 @@
1308
1309
  [
1309
1310
  "m",
1310
1311
  "main <file>",
1311
- "define entry point for the components"
1312
+ "define component entry point"
1312
1313
  ],
1313
1314
  [
1314
1315
  "n",
@@ -1323,7 +1324,7 @@
1323
1324
  [
1324
1325
  "s",
1325
1326
  "scope <string>",
1326
- "sets the component's scope-name. if not entered, the default-scope will be used"
1327
+ "sets the component's scope. if not entered, the default-scope from workspace.jsonc will be used"
1327
1328
  ],
1328
1329
  [
1329
1330
  "e",
@@ -1424,7 +1425,7 @@
1424
1425
  "show templates provided by the aspect-id"
1425
1426
  ]
1426
1427
  ],
1427
- "description": "list templates for \"bit create\" and \"bit new\"",
1428
+ "description": "list available templates for \"bit create\" and \"bit new\"",
1428
1429
  "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
1429
1430
  "group": "development",
1430
1431
  "private": false
@@ -1436,22 +1437,22 @@
1436
1437
  [
1437
1438
  "a",
1438
1439
  "aspect <aspect-id>",
1439
- "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
1440
+ "id of the aspect that registered the template, mandatory for non-core aspects. helpful for core aspects in case of a name collision"
1440
1441
  ],
1441
1442
  [
1442
1443
  "t",
1443
1444
  "template <env-id>",
1444
- "env-id of the template. alias for --env."
1445
+ "env-id of the template's owner. Alias for --env."
1445
1446
  ],
1446
1447
  [
1447
1448
  "",
1448
1449
  "env <env-id>",
1449
- "env-id of the template"
1450
+ "env-id of the template. Alias -t"
1450
1451
  ],
1451
1452
  [
1452
1453
  "d",
1453
1454
  "default-scope <scope-name>",
1454
- "set defaultScope in the new workspace.jsonc"
1455
+ "set defaultScope in the new workspace's workspace.jsonc"
1455
1456
  ],
1456
1457
  [
1457
1458
  "",
@@ -1461,17 +1462,17 @@
1461
1462
  [
1462
1463
  "s",
1463
1464
  "skip-git",
1464
- "skip generation of Git repository"
1465
+ "skip generation of Git repository in the new workspace"
1465
1466
  ],
1466
1467
  [
1467
1468
  "e",
1468
1469
  "empty",
1469
- "empty workspace with no components (relevant for templates that add components by default)"
1470
+ "skip template's default component creation (relevant for templates that add components by default)"
1470
1471
  ],
1471
1472
  [
1472
1473
  "",
1473
1474
  "load-from <path-to-template>",
1474
- "path to the workspace containing the template. helpful during a development of a workspace-template"
1475
+ "local path to the workspace containing the template. Helpful during a development of a workspace-template"
1475
1476
  ]
1476
1477
  ],
1477
1478
  "description": "create a new workspace from a template",
@@ -1481,11 +1482,11 @@
1481
1482
  "arguments": [
1482
1483
  {
1483
1484
  "name": "template-name",
1484
- "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
1485
+ "description": "the name of the workspace template (run 'bit templates' outside of a workspace to get a list of available workspace templates)"
1485
1486
  },
1486
1487
  {
1487
1488
  "name": "workspace-name",
1488
- "description": "the name for the new workspace and workspace directory"
1489
+ "description": "the name for the new workspace and workspace directory that will be created"
1489
1490
  }
1490
1491
  ]
1491
1492
  },
@@ -1536,16 +1537,16 @@
1536
1537
  [
1537
1538
  "",
1538
1539
  "skip-tests",
1539
- "skip running component tests during tag process"
1540
+ "skip running component tests during build process"
1540
1541
  ],
1541
1542
  [
1542
1543
  "",
1543
1544
  "fail-fast",
1544
- "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
1545
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
1545
1546
  ]
1546
1547
  ],
1547
- "description": "run set of tasks for build",
1548
- "extendedDescription": "",
1548
+ "description": "run set of tasks for build. ",
1549
+ "extendedDescription": "by default, only new and modified components are built",
1549
1550
  "group": "development",
1550
1551
  "private": false,
1551
1552
  "arguments": [
@@ -1580,7 +1581,7 @@
1580
1581
  "download the files to the specified dir"
1581
1582
  ]
1582
1583
  ],
1583
- "description": "list and download components artifacts",
1584
+ "description": "list and download component artifacts",
1584
1585
  "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
1585
1586
  "group": "development",
1586
1587
  "private": false,
@@ -1603,12 +1604,12 @@
1603
1604
  [
1604
1605
  "p",
1605
1606
  "port [port-number]",
1606
- "port of the app"
1607
+ "port to run the app on"
1607
1608
  ],
1608
1609
  [
1609
1610
  "v",
1610
1611
  "verbose",
1611
- "showing verbose output for inspection and prints stack trace"
1612
+ "show verbose output for inspection and print stack trace"
1612
1613
  ],
1613
1614
  [
1614
1615
  "",
@@ -1621,7 +1622,7 @@
1621
1622
  "run app in server side rendering mode."
1622
1623
  ]
1623
1624
  ],
1624
- "description": "run an app (independent of bit's dev server)",
1625
+ "description": "locally run an app component (independent of bit's dev server)",
1625
1626
  "extendedDescription": "",
1626
1627
  "group": "apps",
1627
1628
  "private": false,
@@ -1683,12 +1684,12 @@
1683
1684
  [
1684
1685
  "p",
1685
1686
  "port [port-number]",
1686
- "port of the app"
1687
+ "port to run the app on"
1687
1688
  ],
1688
1689
  [
1689
1690
  "v",
1690
1691
  "verbose",
1691
- "showing verbose output for inspection and prints stack trace"
1692
+ "show verbose output for inspection and print stack trace"
1692
1693
  ],
1693
1694
  [
1694
1695
  "",
@@ -1701,7 +1702,7 @@
1701
1702
  "run app in server side rendering mode."
1702
1703
  ]
1703
1704
  ],
1704
- "description": "run an app (independent of bit's dev server)",
1705
+ "description": "locally run an app component (independent of bit's dev server)",
1705
1706
  "extendedDescription": "",
1706
1707
  "group": "apps",
1707
1708
  "private": false,
@@ -1762,7 +1763,7 @@
1762
1763
  [
1763
1764
  "u",
1764
1765
  "update",
1765
- "update all dependencies"
1766
+ "update all dependencies to latest version according to their semver range"
1766
1767
  ],
1767
1768
  [
1768
1769
  "",
@@ -1837,7 +1838,7 @@
1837
1838
  [
1838
1839
  "y",
1839
1840
  "yes",
1840
- "automatically update all outdated packages"
1841
+ "automatically update all outdated versions for packages specified in pattern (all if no pattern supplied) - use carefully as could result in breaking updates for dependencies"
1841
1842
  ],
1842
1843
  [
1843
1844
  "",
@@ -1862,7 +1863,7 @@
1862
1863
  "arguments": [
1863
1864
  {
1864
1865
  "name": "package-patterns...",
1865
- "description": "a list of package names, or patterns (separated by space). The patterns should be in glob format. By default, all packages are selected."
1866
+ "description": "a string list of package names, or patterns (separated by space), e.g. \"@teambit/** @my-org/ui/**\". The patterns should be in glob format. By default, all packages are selected."
1866
1867
  }
1867
1868
  ]
1868
1869
  },
@@ -1911,18 +1912,18 @@
1911
1912
  "name": "move <current-component-dir> <new-component-dir>",
1912
1913
  "alias": "mv",
1913
1914
  "options": [],
1914
- "description": "move a component to a different filesystem path",
1915
- "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
1915
+ "description": "move a component to a different filesystem path (note: this does NOT affect the component's name or scope, just its location in the workspace)",
1916
+ "extendedDescription": "move files or directories of component(s)\n",
1916
1917
  "group": "development",
1917
1918
  "private": false,
1918
1919
  "arguments": [
1919
1920
  {
1920
1921
  "name": "current-component-dir",
1921
- "description": "the current relative path (in the workspace) to the component directory"
1922
+ "description": "the component's current directory (relative to the workspace root)"
1922
1923
  },
1923
1924
  {
1924
1925
  "name": "new-component-dir",
1925
- "description": "the new relative path (in the workspace) to the component directory"
1926
+ "description": "the new directory (relative to the workspace root) to create and move the component's files to"
1926
1927
  }
1927
1928
  ]
1928
1929
  },
@@ -1938,12 +1939,7 @@
1938
1939
  [
1939
1940
  "o",
1940
1941
  "objects",
1941
- "import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument"
1942
- ],
1943
- [
1944
- "d",
1945
- "display-dependencies",
1946
- "display the imported dependencies"
1942
+ "import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument"
1947
1943
  ],
1948
1944
  [
1949
1945
  "O",
@@ -1963,7 +1959,7 @@
1963
1959
  [
1964
1960
  "x",
1965
1961
  "skip-dependency-installation",
1966
- "do not install packages of the imported components"
1962
+ "do not auto-install dependencies of the imported components"
1967
1963
  ],
1968
1964
  [
1969
1965
  "m",
@@ -1973,17 +1969,17 @@
1973
1969
  [
1974
1970
  "",
1975
1971
  "dependencies",
1976
- "import all dependencies and write them to the workspace"
1972
+ "import all dependencies (bit components only) of imported components and write them to the workspace"
1977
1973
  ],
1978
1974
  [
1979
1975
  "",
1980
1976
  "dependents",
1981
- "import components found while traversing from the given ids upwards to the workspace components"
1977
+ "import components found while traversing from the imported components upwards to the workspace components"
1982
1978
  ],
1983
1979
  [
1984
1980
  "",
1985
1981
  "save-in-lane",
1986
- "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)"
1982
+ "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)"
1987
1983
  ],
1988
1984
  [
1989
1985
  "",
@@ -1993,12 +1989,12 @@
1993
1989
  [
1994
1990
  "",
1995
1991
  "fetch-deps",
1996
- "fetch dependencies objects"
1992
+ "fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data"
1997
1993
  ],
1998
1994
  [
1999
1995
  "",
2000
1996
  "track-only",
2001
- "do not write any file, just create .bitmap entries of the imported components"
1997
+ "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"
2002
1998
  ],
2003
1999
  [
2004
2000
  "",
@@ -2035,7 +2031,7 @@
2035
2031
  [
2036
2032
  "",
2037
2033
  "all-history",
2038
- "for each one of the component, fetch all its versions. by default, only the latest version is fetched"
2034
+ "for each component, fetch all its versions. by default, only the latest version is fetched"
2039
2035
  ],
2040
2036
  [
2041
2037
  "j",
@@ -2088,8 +2084,8 @@
2088
2084
  "skip confirmation"
2089
2085
  ]
2090
2086
  ],
2091
- "description": "remove component(s) from the workspace, or a remote scope",
2092
- "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\n\nto remove components from lanes, use \"bit lane remove-comp\".\n",
2087
+ "description": "remove component(s) from the workspace, or a remote scope (with a flag)",
2088
+ "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\n\nto remove components from a lane, use \"bit lane remove-comp\".\n",
2093
2089
  "group": "collaborate",
2094
2090
  "private": false,
2095
2091
  "remoteOp": true,
@@ -2111,7 +2107,7 @@
2111
2107
  "do not install packages in case of importing components"
2112
2108
  ]
2113
2109
  ],
2114
- "description": "EXPERIMENTAL. recover soft-removed component(s) from the workspace, or a remote scope",
2110
+ "description": "EXPERIMENTAL. recover component(s) soft-deleted from the workspace, or a remote scope",
2115
2111
  "extendedDescription": "",
2116
2112
  "group": "collaborate",
2117
2113
  "private": false
@@ -2121,7 +2117,7 @@
2121
2117
  "alias": "",
2122
2118
  "options": [],
2123
2119
  "description": "EXPERIMENTAL. resume failed export",
2124
- "extendedDescription": "resume failed export to persist the pending objects on the given remotes.\nthe export-id is the id the client got in the error message during the failure.\nalternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id",
2120
+ "extendedDescription": "resume failed export to persist the pending objects on the given remotes.\nthe export-id is the id the client received in the error message during the failure.\nalternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id",
2125
2121
  "group": "collaborate",
2126
2122
  "private": true,
2127
2123
  "remoteOp": true
@@ -2133,7 +2129,7 @@
2133
2129
  [
2134
2130
  "e",
2135
2131
  "eject",
2136
- "replace the exported components with their corresponding packages (to use these components without further maintaining them)"
2132
+ "remove component from the workspace and install it instead as a regular npm package"
2137
2133
  ],
2138
2134
  [
2139
2135
  "a",
@@ -2172,14 +2168,14 @@
2172
2168
  ]
2173
2169
  ],
2174
2170
  "description": "export components from the workspace to remote scopes",
2175
- "extendedDescription": "bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well\n `bit export [id...]` => export the given ids to their current scope\n you can use a pattern for multiple ids, such as bit export remote-scope \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2171
+ "extendedDescription": "bit export => export all staged snaps/tags of components to their remote scope. if checked out to a lane, export the lane as well\n `bit export [pattern...]` => export components included by the pattern to their remote scope (we recommend not using a pattern in\n most scenarios so that all changes are exported simultaneously)\n you can use a pattern for multiple ids, such as bit export \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2176
2172
  "group": "collaborate",
2177
2173
  "private": false,
2178
2174
  "remoteOp": true,
2179
2175
  "arguments": [
2180
2176
  {
2181
2177
  "name": "component-patterns...",
2182
- "description": "component IDs, component names, or component patterns (separated by space). Use patterns to export groups of components using a common scope or namespace. E.g., \"utils/*\" (wrap with double quotes)"
2178
+ "description": "(not recommended) component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
2183
2179
  }
2184
2180
  ]
2185
2181
  },
@@ -2265,7 +2261,7 @@
2265
2261
  [
2266
2262
  "",
2267
2263
  "snapped",
2268
- "tag components that their head is a snap (not a tag)"
2264
+ "tag only components whose head is a snap (not a tag)"
2269
2265
  ],
2270
2266
  [
2271
2267
  "",
@@ -2305,7 +2301,7 @@
2305
2301
  [
2306
2302
  "",
2307
2303
  "ignore-build-errors",
2308
- "run the tag pipeline although the build pipeline failed"
2304
+ "proceed to tag pipeline even when build pipeline fails"
2309
2305
  ],
2310
2306
  [
2311
2307
  "",
@@ -2320,12 +2316,12 @@
2320
2316
  [
2321
2317
  "I",
2322
2318
  "ignore-newest-version",
2323
- "ignore existing of newer versions (default = false)"
2319
+ "allow tagging even when the component has newer versions e.g. for hotfixes (default = false)"
2324
2320
  ],
2325
2321
  [
2326
2322
  "",
2327
2323
  "fail-fast",
2328
- "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2324
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
2329
2325
  ],
2330
2326
  [
2331
2327
  "b",
@@ -2340,12 +2336,12 @@
2340
2336
  [
2341
2337
  "s",
2342
2338
  "scope [version]",
2343
- "DEPRECATED (use \"--unmodified\" instead). tag all components of the current scope"
2339
+ "DEPRECATED (use \"--unmodified\" instead). tag all components of the local scope"
2344
2340
  ],
2345
2341
  [
2346
2342
  "f",
2347
2343
  "force",
2348
- "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-tag even if tests are failing and even when component has not changed"
2344
+ "DEPRECATED (use \"--skip-tests\", \"--ignore-build-errors\" or \"--unmodified\" instead). force-tag even if tests are failing and even when component has not changed"
2349
2345
  ],
2350
2346
  [
2351
2347
  "",
@@ -2361,7 +2357,7 @@
2361
2357
  "arguments": [
2362
2358
  {
2363
2359
  "name": "component-patterns...",
2364
- "description": "a list of component names, IDs or patterns (separated by space). run \"bit pattern --help\" to get more data about patterns. By default, all modified are tagged."
2360
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes. By default, all new and modified are tagged."
2365
2361
  }
2366
2362
  ],
2367
2363
  "examples": [
@@ -2378,7 +2374,7 @@
2378
2374
  [
2379
2375
  "m",
2380
2376
  "message <message>",
2381
- "log message describing the latest changes"
2377
+ "snap message describing the latest changes - will appear in component history log"
2382
2378
  ],
2383
2379
  [
2384
2380
  "",
@@ -2393,12 +2389,12 @@
2393
2389
  [
2394
2390
  "b",
2395
2391
  "build",
2396
- "not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled"
2392
+ "not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled"
2397
2393
  ],
2398
2394
  [
2399
2395
  "",
2400
2396
  "editor [editor]",
2401
- "open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
2397
+ "open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim)."
2402
2398
  ],
2403
2399
  [
2404
2400
  "",
@@ -2413,7 +2409,7 @@
2413
2409
  [
2414
2410
  "",
2415
2411
  "disable-snap-pipeline",
2416
- "skip the snap pipeline"
2412
+ "skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment"
2417
2413
  ],
2418
2414
  [
2419
2415
  "",
@@ -2423,7 +2419,7 @@
2423
2419
  [
2424
2420
  "",
2425
2421
  "ignore-build-errors",
2426
- "run the snap pipeline although the build pipeline failed"
2422
+ "proceed to snap pipeline even when build pipeline fails"
2427
2423
  ],
2428
2424
  [
2429
2425
  "i",
@@ -2433,12 +2429,12 @@
2433
2429
  [
2434
2430
  "a",
2435
2431
  "all",
2436
- "DEPRECATED (not needed anymore, it is the default now). snap all new and modified components"
2432
+ "DEPRECATED (not needed anymore, now the default). snap all new and modified components"
2437
2433
  ],
2438
2434
  [
2439
2435
  "",
2440
2436
  "fail-fast",
2441
- "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2437
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
2442
2438
  ],
2443
2439
  [
2444
2440
  "f",
@@ -2446,14 +2442,14 @@
2446
2442
  "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
2447
2443
  ]
2448
2444
  ],
2449
- "description": "create an immutable and exportable component snapshot (no release version)",
2445
+ "description": "create an immutable and exportable component snapshot (non-release version)",
2450
2446
  "extendedDescription": "",
2451
2447
  "group": "development",
2452
2448
  "private": false,
2453
2449
  "arguments": [
2454
2450
  {
2455
2451
  "name": "component-pattern",
2456
- "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes. By default, all new and modified components are snapped."
2452
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes. By default, only new and modified components are snapped (add --unmodified to snap all components in the workspace)."
2457
2453
  }
2458
2454
  ]
2459
2455
  },
@@ -2464,7 +2460,7 @@
2464
2460
  [
2465
2461
  "a",
2466
2462
  "all",
2467
- "revert tag/snap for all tagged/snapped components"
2463
+ "revert all unexported tags/snaps for all components"
2468
2464
  ],
2469
2465
  [
2470
2466
  "",
@@ -2479,7 +2475,7 @@
2479
2475
  [
2480
2476
  "f",
2481
2477
  "force",
2482
- "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
2478
+ "revert the tag even if it's used as a dependency. WARNING: components that depend on this tag will be corrupted"
2483
2479
  ]
2484
2480
  ],
2485
2481
  "description": "revert tagged or snapped versions for component(s)",
@@ -2675,7 +2671,7 @@
2675
2671
  [
2676
2672
  "",
2677
2673
  "auto-merge-resolve <merge-strategy>",
2678
- "in case of a conflict, resolve according to the strategy: [ours, theirs, manual]"
2674
+ "in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual]"
2679
2675
  ],
2680
2676
  [
2681
2677
  "r",
@@ -2690,7 +2686,7 @@
2690
2686
  [
2691
2687
  "e",
2692
2688
  "workspace-only",
2693
- "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2689
+ "only relevant for 'bit checkout head' when on a lane. don't import components from the remote lane that are not already in the workspace"
2694
2690
  ],
2695
2691
  [
2696
2692
  "v",
@@ -2700,11 +2696,11 @@
2700
2696
  [
2701
2697
  "x",
2702
2698
  "skip-dependency-installation",
2703
- "do not install packages of the imported components"
2699
+ "do not auto-install dependencies of the imported components"
2704
2700
  ]
2705
2701
  ],
2706
2702
  "description": "switch between component versions or remove local changes",
2707
- "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2703
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2708
2704
  "group": "development",
2709
2705
  "private": false,
2710
2706
  "arguments": [
@@ -2831,7 +2827,7 @@
2831
2827
  [
2832
2828
  "e",
2833
2829
  "env <id>",
2834
- "test only the given env"
2830
+ "test only components assigned the given env"
2835
2831
  ],
2836
2832
  [
2837
2833
  "s",
@@ -2839,7 +2835,7 @@
2839
2835
  "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
2840
2836
  ]
2841
2837
  ],
2842
- "description": "test components in the workspace",
2838
+ "description": "test components in the workspace. by default only runs tests for new and modified components",
2843
2839
  "extendedDescription": "",
2844
2840
  "group": "development",
2845
2841
  "private": false,
@@ -2857,7 +2853,7 @@
2857
2853
  [
2858
2854
  "v",
2859
2855
  "verbose",
2860
- "show a more verbose output when possible"
2856
+ "show a more verbose output where possible"
2861
2857
  ],
2862
2858
  [
2863
2859
  "t",
@@ -2865,8 +2861,8 @@
2865
2861
  "show tables instead of plain text for dependencies diff"
2866
2862
  ]
2867
2863
  ],
2868
- "description": "show the diff between the components' source files and config",
2869
- "extendedDescription": "bit diff => compare all modified components to their model version\nbit diff [ids...] => compare the specified components against their modified states\nbit diff [id] [version] => compare the specified version to used or modified files\nbit diff [id] [version] [to_version] => compare the specified version files to to_version files\nyou can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2864
+ "description": "show the diff between the components' current source files and config, and their latest snapshot or tag",
2865
+ "extendedDescription": "bit diff => compare all modified components to their model version\nbit diff [ids...] => compare the specified components against their modified states\nbit diff [id] [version] => compare component's current files and configs to the specified version of the component\nbit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided\nyou can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2870
2866
  "group": "development",
2871
2867
  "private": false
2872
2868
  },
@@ -2877,12 +2873,12 @@
2877
2873
  [
2878
2874
  "",
2879
2875
  "ours",
2880
- "DEPRECATED. use --auto-merge-resolve. In the future, this flag will leave the current code intact"
2876
+ "DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep the local modification"
2881
2877
  ],
2882
2878
  [
2883
2879
  "",
2884
2880
  "theirs",
2885
- "DEPRECATED. use --auto-merge-resolve. In the future, this flag will override the current code with the incoming code"
2881
+ "DEPRECATED. use --auto-merge-resolve. in case of a conflict, override the local modification with the specified version"
2886
2882
  ],
2887
2883
  [
2888
2884
  "",
@@ -2897,7 +2893,7 @@
2897
2893
  [
2898
2894
  "",
2899
2895
  "abort",
2900
- "in case of an unresolved merge, revert to the state before the merge began"
2896
+ "in case of an unresolved merge, revert to pre-merge state"
2901
2897
  ],
2902
2898
  [
2903
2899
  "",
@@ -2907,7 +2903,7 @@
2907
2903
  [
2908
2904
  "",
2909
2905
  "no-snap",
2910
- "do not auto snap in case the merge completed without conflicts"
2906
+ "do not auto snap even if the merge completed without conflicts"
2911
2907
  ],
2912
2908
  [
2913
2909
  "",
@@ -2917,12 +2913,12 @@
2917
2913
  [
2918
2914
  "",
2919
2915
  "verbose",
2920
- "show details of components that were not merged legitimately"
2916
+ "show details of components that were not merged successfully"
2921
2917
  ],
2922
2918
  [
2923
2919
  "x",
2924
2920
  "skip-dependency-installation",
2925
- "do not install packages of the imported components"
2921
+ "do not install new dependencies resulting from the merge"
2926
2922
  ],
2927
2923
  [
2928
2924
  "m",
@@ -2930,13 +2926,13 @@
2930
2926
  "override the default message for the auto snap"
2931
2927
  ]
2932
2928
  ],
2933
- "description": "merge changes of the remote head into local",
2934
- "extendedDescription": "merge changes of the remote head into local. when on a lane, merge the remote head of the lane into the local.\nif no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).\noptionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.\nyou can use a pattern for multiple ids, such as bit merge \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2929
+ "description": "merge changes of the remote head into local - auto-snaps all merged components",
2930
+ "extendedDescription": "merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local\nand creates snaps for merged components that have diverged, on the lane.\nif no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).\noptionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.\nyou can use a pattern for multiple ids, such as bit merge \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2935
2931
  "group": "development",
2936
2932
  "private": false
2937
2933
  },
2938
2934
  {
2939
- "name": "lane [lane-name]",
2935
+ "name": "lane [sub-command]",
2940
2936
  "alias": "l",
2941
2937
  "options": [
2942
2938
  [
@@ -2951,21 +2947,21 @@
2951
2947
  ],
2952
2948
  [
2953
2949
  "r",
2954
- "remote <string>",
2955
- "show remote lanes"
2950
+ "remote <remote-scope-name>",
2951
+ "show all remote lanes from the specified scope"
2956
2952
  ],
2957
2953
  [
2958
2954
  "",
2959
2955
  "merged",
2960
- "show merged lanes"
2956
+ "list only merged lanes"
2961
2957
  ],
2962
2958
  [
2963
2959
  "",
2964
2960
  "not-merged",
2965
- "show not merged lanes"
2961
+ "list only lanes that haven't been merged"
2966
2962
  ]
2967
2963
  ],
2968
- "description": "manage lanes",
2964
+ "description": "manage lanes - if no sub-command is used, runs \"bit lane list\"",
2969
2965
  "extendedDescription": "",
2970
2966
  "group": "collaborate",
2971
2967
  "private": false,
@@ -2984,25 +2980,25 @@
2984
2980
  [
2985
2981
  "j",
2986
2982
  "json",
2987
- "show lanes details in a json format"
2983
+ "show lanes' details in a json format"
2988
2984
  ],
2989
2985
  [
2990
2986
  "r",
2991
2987
  "remote <remote-scope-name>",
2992
- "show remote lanes"
2988
+ "show all remote lanes from the specified scope"
2993
2989
  ],
2994
2990
  [
2995
2991
  "",
2996
2992
  "merged",
2997
- "show merged lanes"
2993
+ "list only merged lanes"
2998
2994
  ],
2999
2995
  [
3000
2996
  "",
3001
2997
  "not-merged",
3002
- "show lanes that are not merged"
2998
+ "list only lanes that haven't been merged"
3003
2999
  ]
3004
3000
  ],
3005
- "description": "list lanes",
3001
+ "description": "list local lanes",
3006
3002
  "extendedDescription": "",
3007
3003
  "group": "ungrouped",
3008
3004
  "private": false,
@@ -3010,13 +3006,13 @@
3010
3006
  "skipWorkspace": true
3011
3007
  },
3012
3008
  {
3013
- "name": "switch <lane> [pattern]",
3009
+ "name": "switch <lane>",
3014
3010
  "alias": "",
3015
3011
  "options": [
3016
3012
  [
3017
3013
  "n",
3018
3014
  "alias <string>",
3019
- "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
3015
+ "relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote"
3020
3016
  ],
3021
3017
  [
3022
3018
  "m",
@@ -3026,17 +3022,17 @@
3026
3022
  [
3027
3023
  "a",
3028
3024
  "get-all",
3029
- "checkout all components in a lane include ones that do not exist in the workspace"
3025
+ "checkout all components in a lane, including those not currently in the workspace"
3030
3026
  ],
3031
3027
  [
3032
3028
  "x",
3033
3029
  "skip-dependency-installation",
3034
- "do not install packages of the imported components"
3030
+ "do not install dependencies of the imported components"
3035
3031
  ],
3036
3032
  [
3037
3033
  "p",
3038
3034
  "pattern <component-pattern>",
3039
- "switch only the specified component-pattern. works only when the workspace is empty"
3035
+ "switch only the lane components matching the specified component-pattern. only works when the workspace is empty\n\ncomponent name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
3040
3036
  ],
3041
3037
  [
3042
3038
  "j",
@@ -3051,7 +3047,7 @@
3051
3047
  "arguments": [
3052
3048
  {
3053
3049
  "name": "lane",
3054
- "description": "lane-name or lane-id (if not exists locally) to switch to"
3050
+ "description": "lane-name or lane-id (if lane is not local) to switch to"
3055
3051
  }
3056
3052
  ]
3057
3053
  },
@@ -3067,7 +3063,7 @@
3067
3063
  [
3068
3064
  "r",
3069
3065
  "remote",
3070
- "show the lane from remote"
3066
+ "show details of the remote head of the provided lane"
3071
3067
  ]
3072
3068
  ],
3073
3069
  "description": "show lane details. if no lane specified, show the current lane",
@@ -3084,7 +3080,7 @@
3084
3080
  [
3085
3081
  "s",
3086
3082
  "scope <scope-name>",
3087
- "remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
3083
+ "remote scope to which this lane will be exported, default to the workspace.json's defaultScope (can be changed up to first export of the lane with \"bit lane change-scope\")"
3088
3084
  ],
3089
3085
  [
3090
3086
  "",
@@ -3099,11 +3095,11 @@
3099
3095
  [
3100
3096
  "",
3101
3097
  "fork-lane-new-scope",
3102
- "allow forking a lane into a different scope than the original lane"
3098
+ "create the new lane in a different scope than its parent lane (if created from another lane)"
3103
3099
  ]
3104
3100
  ],
3105
3101
  "description": "creates a new lane and switches to it",
3106
- "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
3102
+ "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane contains all the components of the original lane.",
3107
3103
  "group": "ungrouped",
3108
3104
  "private": false,
3109
3105
  "arguments": [
@@ -3120,12 +3116,12 @@
3120
3116
  [
3121
3117
  "r",
3122
3118
  "remote",
3123
- "remove a remote lane (in the lane arg, use remote/lane-id syntax)"
3119
+ "delete a remote lane. use remote/lane-id syntax e.g. bit lane remove owner.org/my-lane --remote. Delete is immediate, no export required"
3124
3120
  ],
3125
3121
  [
3126
3122
  "f",
3127
3123
  "force",
3128
- "removes the lane even when the lane was not merged yet"
3124
+ "removes/deletes the lane even when the lane is not yet merged to main"
3129
3125
  ],
3130
3126
  [
3131
3127
  "s",
@@ -3133,7 +3129,7 @@
3133
3129
  "skip confirmation"
3134
3130
  ]
3135
3131
  ],
3136
- "description": "remove lanes",
3132
+ "description": "remove or delete lanes",
3137
3133
  "extendedDescription": "",
3138
3134
  "group": "collaborate",
3139
3135
  "private": false,
@@ -3149,7 +3145,7 @@
3149
3145
  "alias": "",
3150
3146
  "options": [],
3151
3147
  "description": "changes the remote scope of a lane",
3152
- "extendedDescription": "",
3148
+ "extendedDescription": "NOTE: available only before the lane is exported to the remote",
3153
3149
  "group": "ungrouped",
3154
3150
  "private": false
3155
3151
  },
@@ -3158,7 +3154,7 @@
3158
3154
  "alias": "",
3159
3155
  "options": [],
3160
3156
  "description": "adds an alias to a lane",
3161
- "extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
3157
+ "extendedDescription": "an alias is a name that can be used locally to refer to a lane. it is saved locally and never reaches the remote.\nit is useful e.g. when having multiple lanes with the same name, but with different remote scopes.",
3162
3158
  "group": "ungrouped",
3163
3159
  "private": false
3164
3160
  },
@@ -3178,7 +3174,7 @@
3178
3174
  [
3179
3175
  "",
3180
3176
  "pattern <component-pattern>",
3181
- "show lane-diff for the specified component-pattern only"
3177
+ "show lane-diff for components conforming to the specified component-pattern only\ncomponent-pattern format: component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
3182
3178
  ]
3183
3179
  ],
3184
3180
  "description": "show diff between lanes",
@@ -3186,13 +3182,23 @@
3186
3182
  "group": "ungrouped",
3187
3183
  "private": true,
3188
3184
  "remoteOp": true,
3189
- "skipWorkspace": true
3185
+ "skipWorkspace": true,
3186
+ "arguments": [
3187
+ {
3188
+ "name": "from",
3189
+ "description": "base lane for comparison"
3190
+ },
3191
+ {
3192
+ "name": "to",
3193
+ "description": "lane being compared to base lane"
3194
+ }
3195
+ ]
3190
3196
  },
3191
3197
  {
3192
3198
  "name": "add-readme <component-name> [lane-name]",
3193
3199
  "alias": "",
3194
3200
  "options": [],
3195
- "description": "EXPERIMENTAL. adds a readme component to a lane",
3201
+ "description": "EXPERIMENTAL. sets an existing component as the readme of a lane",
3196
3202
  "extendedDescription": "",
3197
3203
  "group": "ungrouped",
3198
3204
  "private": false,
@@ -3225,15 +3231,15 @@
3225
3231
  [
3226
3232
  "x",
3227
3233
  "skip-dependency-installation",
3228
- "do not install packages of the imported components"
3234
+ "do not install dependencies of the imported components"
3229
3235
  ],
3230
3236
  [
3231
3237
  "p",
3232
3238
  "pattern <component-pattern>",
3233
- "switch only the specified component-pattern. works only when the workspace is empty"
3239
+ "import only components from the lane that fit the specified component-pattern to the workspace. works only when the workspace is empty"
3234
3240
  ]
3235
3241
  ],
3236
- "description": "import a remote lane to your workspace",
3242
+ "description": "import a remote lane to your workspace and switch to that lane",
3237
3243
  "extendedDescription": "",
3238
3244
  "group": "ungrouped",
3239
3245
  "private": false,
@@ -3251,16 +3257,16 @@
3251
3257
  [
3252
3258
  "",
3253
3259
  "workspace-only",
3254
- "do not mark the components as removed. instead, remove them from the workspace only"
3260
+ "do not mark the components as removed from the lane. instead, remove them from the workspace only"
3255
3261
  ],
3256
3262
  [
3257
3263
  "",
3258
3264
  "update-main",
3259
- "EXPERIMENTAL. mark as removed on main after merging this lane into main"
3265
+ "EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main"
3260
3266
  ]
3261
3267
  ],
3262
3268
  "description": "remove components when on a lane",
3263
- "extendedDescription": "in case the components are part of the lane and the lane is exported, it marks the components as removed,\nand then after snap+export, the remote-lane gets updated as well. upon lane-merge, these components are skipped.\n\nin case the components are not part of the lane or the lane is new, it simply removes the components from the workspace",
3269
+ "extendedDescription": "in case the components are part of the lane and the lane is exported, it marks the components as\nremoved from the lane, and then after snap+export, the remote-lane gets updated as well.\nupon lane-merge, these removed components are skipped and any changes for removed components won't be merged to main.\n\nin case the components are not yet part of the lane or the lane is new, it simply removes the components from the workspace",
3264
3270
  "group": "collaborate",
3265
3271
  "private": false,
3266
3272
  "arguments": [
@@ -3277,12 +3283,12 @@
3277
3283
  [
3278
3284
  "",
3279
3285
  "ours",
3280
- "DEPRECATED. use --auto-merge-resolve. In the future, this flag will leave the current code intact"
3286
+ "DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications"
3281
3287
  ],
3282
3288
  [
3283
3289
  "",
3284
3290
  "theirs",
3285
- "DEPRECATED. use --auto-merge-resolve. In the future, this flag will override the current code with the incoming code"
3291
+ "DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes"
3286
3292
  ],
3287
3293
  [
3288
3294
  "",
@@ -3292,22 +3298,22 @@
3292
3298
  [
3293
3299
  "",
3294
3300
  "auto-merge-resolve <merge-strategy>",
3295
- "in case of a conflict, resolve according to the strategy: [ours, theirs, manual]"
3301
+ "in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual]"
3296
3302
  ],
3297
3303
  [
3298
3304
  "",
3299
3305
  "workspace",
3300
- "merge only components in a lane that exist in the workspace"
3306
+ "merge only lane components that are in the current workspace"
3301
3307
  ],
3302
3308
  [
3303
3309
  "",
3304
3310
  "no-snap",
3305
- "do not auto snap in case the merge completed without conflicts"
3311
+ "do not auto snap after merge completed without conflicts"
3306
3312
  ],
3307
3313
  [
3308
3314
  "",
3309
3315
  "tag",
3310
- "tag all lane components after merging into main (also tag-merge in case of snap-merge)"
3316
+ "auto-tag all lane components after merging into main (or tag-merge in case of snap-merge)"
3311
3317
  ],
3312
3318
  [
3313
3319
  "",
@@ -3327,42 +3333,42 @@
3327
3333
  [
3328
3334
  "",
3329
3335
  "no-squash",
3330
- "relevant for merging lanes into main, which by default squash"
3336
+ "relevant for merging lanes into main, which by default squashes all lane snaps"
3331
3337
  ],
3332
3338
  [
3333
3339
  "",
3334
3340
  "squash",
3335
- "EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash"
3341
+ "EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash"
3336
3342
  ],
3337
3343
  [
3338
3344
  "",
3339
3345
  "ignore-config-changes",
3340
- "allow merging when component are modified due to config changes (such as dependencies) only and not files"
3346
+ "allow merging when components are modified due to config changes (such as dependencies) only and not files"
3341
3347
  ],
3342
3348
  [
3343
3349
  "",
3344
3350
  "verbose",
3345
- "show details of components that were not merged legitimately"
3351
+ "show details of components that were not merged successfully"
3346
3352
  ],
3347
3353
  [
3348
3354
  "x",
3349
3355
  "skip-dependency-installation",
3350
- "do not install packages of the imported components"
3356
+ "do not install dependencies of the imported components"
3351
3357
  ],
3352
3358
  [
3353
3359
  "",
3354
3360
  "skip-fetch",
3355
- "use the current target-lane if exits locally without updating it from the remote"
3361
+ "use the local state of target-lane if exits locally, without updating it from the remote"
3356
3362
  ],
3357
3363
  [
3358
3364
  "",
3359
3365
  "include-deps",
3360
- "relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
3366
+ "relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the specified components"
3361
3367
  ],
3362
3368
  [
3363
3369
  "",
3364
3370
  "resolve-unrelated [merge-strategy]",
3365
- "relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be \"ours\" (default) or \"theirs\""
3371
+ "relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be \"ours\" (default) or \"theirs\""
3366
3372
  ],
3367
3373
  [
3368
3374
  "",
@@ -3370,18 +3376,18 @@
3370
3376
  "when merging main, include workspace components that are not on the lane (by default only lane components are merged)"
3371
3377
  ]
3372
3378
  ],
3373
- "description": "merge a local or a remote lane",
3374
- "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 the other lanes are diverged in history and the files could be merged with no conflicts,\nit will snap-merge these components to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
3379
+ "description": "merge a local or a remote lane to the current lane",
3380
+ "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-snap\" to opt-out, or \"tag\" to tag instead",
3375
3381
  "private": true,
3376
3382
  "remoteOp": true,
3377
3383
  "arguments": [
3378
3384
  {
3379
3385
  "name": "lane",
3380
- "description": "lane-name or lane-id (if not exists locally) to merge to the current lane"
3386
+ "description": "lane-name or full lane-id (if remote) to merge to the current lane"
3381
3387
  },
3382
3388
  {
3383
3389
  "name": "pattern",
3384
- "description": "partially merge the lane with the specified component-pattern"
3390
+ "description": "partially merge the lane - only components that match the specified component-pattern\nComponent pattern format: component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
3385
3391
  }
3386
3392
  ]
3387
3393
  },
@@ -3392,7 +3398,7 @@
3392
3398
  [
3393
3399
  "",
3394
3400
  "verbose",
3395
- "show details of components that were not merged legitimately"
3401
+ "show details of components that didn't need to be merged"
3396
3402
  ],
3397
3403
  [
3398
3404
  "s",
@@ -3406,20 +3412,20 @@
3406
3412
  ]
3407
3413
  ],
3408
3414
  "description": "abort the recent lane-merge. revert the lane object and checkout accordingly",
3409
- "extendedDescription": "restore the lane-object same as it was before the last \"bit lane merge\" command.\nalso, checkout the workspace components according to the restored lane",
3415
+ "extendedDescription": "restore the lane-object to its state before the last \"bit lane merge\" command.\nalso, checkout the workspace components according to the restored lane state",
3410
3416
  "private": true,
3411
3417
  "remoteOp": true
3412
3418
  }
3413
3419
  ]
3414
3420
  },
3415
3421
  {
3416
- "name": "switch <lane> [pattern]",
3422
+ "name": "switch <lane>",
3417
3423
  "alias": "",
3418
3424
  "options": [
3419
3425
  [
3420
3426
  "n",
3421
3427
  "alias <string>",
3422
- "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
3428
+ "relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote"
3423
3429
  ],
3424
3430
  [
3425
3431
  "m",
@@ -3429,17 +3435,17 @@
3429
3435
  [
3430
3436
  "a",
3431
3437
  "get-all",
3432
- "checkout all components in a lane include ones that do not exist in the workspace"
3438
+ "checkout all components in a lane, including those not currently in the workspace"
3433
3439
  ],
3434
3440
  [
3435
3441
  "x",
3436
3442
  "skip-dependency-installation",
3437
- "do not install packages of the imported components"
3443
+ "do not install dependencies of the imported components"
3438
3444
  ],
3439
3445
  [
3440
3446
  "p",
3441
3447
  "pattern <component-pattern>",
3442
- "switch only the specified component-pattern. works only when the workspace is empty"
3448
+ "switch only the lane components matching the specified component-pattern. only works when the workspace is empty\n\ncomponent name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
3443
3449
  ],
3444
3450
  [
3445
3451
  "j",
@@ -3454,7 +3460,7 @@
3454
3460
  "arguments": [
3455
3461
  {
3456
3462
  "name": "lane",
3457
- "description": "lane-name or lane-id (if not exists locally) to switch to"
3463
+ "description": "lane-name or lane-id (if lane is not local) to switch to"
3458
3464
  }
3459
3465
  ]
3460
3466
  },
@@ -3733,7 +3739,7 @@
3733
3739
  [
3734
3740
  "i",
3735
3741
  "ids",
3736
- "show only component ids unformatted"
3742
+ "show only component ids, unformatted"
3737
3743
  ],
3738
3744
  [
3739
3745
  "s",
@@ -3743,7 +3749,7 @@
3743
3749
  [
3744
3750
  "o",
3745
3751
  "outdated",
3746
- "show latest versions from remotes"
3752
+ "highlight outdated components, in comparison with their latest remote version (if one exists)"
3747
3753
  ],
3748
3754
  [
3749
3755
  "j",
@@ -3753,11 +3759,11 @@
3753
3759
  [
3754
3760
  "n",
3755
3761
  "namespace <string>",
3756
- "show only specified namespace by using wildcards"
3762
+ "show only components in the specified namespace/s e.g. '-n ui' or '*/ui'"
3757
3763
  ]
3758
3764
  ],
3759
- "description": "list components on a workspace, local scope or a remote scope.",
3760
- "extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
3765
+ "description": "list components on a workspace or a remote scope (with flag).",
3766
+ "extendedDescription": "",
3761
3767
  "group": "discover",
3762
3768
  "private": false,
3763
3769
  "remoteOp": true,
@@ -3810,7 +3816,7 @@
3810
3816
  [
3811
3817
  "",
3812
3818
  "allow-staged",
3813
- "allow publish components that were not exported yet (not recommended)"
3819
+ "allow publishing components that were not exported yet (not recommended)"
3814
3820
  ],
3815
3821
  [
3816
3822
  "j",
@@ -3861,7 +3867,7 @@
3861
3867
  [
3862
3868
  "",
3863
3869
  "verbose",
3864
- "show extra data: full snap hashes for staged and divergence point for lanes"
3870
+ "show extra data: full snap hashes for staged components, and divergence point for lanes"
3865
3871
  ],
3866
3872
  [
3867
3873
  "l",
@@ -3874,7 +3880,7 @@
3874
3880
  "in case issues found, exit with code 1"
3875
3881
  ]
3876
3882
  ],
3877
- "description": "present the current status of components in the workspace, and notifies when issues are detected",
3883
+ "description": "present the current status of components in the workspace, including indication of detected issues",
3878
3884
  "extendedDescription": "",
3879
3885
  "group": "development",
3880
3886
  "private": false
@@ -3895,7 +3901,7 @@
3895
3901
  ]
3896
3902
  ],
3897
3903
  "description": "EXPERIMENTAL. basic status for fast execution",
3898
- "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",
3904
+ "extendedDescription": "shows only modified/new components with code changes. for the full status, use \"bit status\".\nthis command only checks source code changes, it doesn't check for config/aspect/dependency changes",
3899
3905
  "group": "development",
3900
3906
  "private": false,
3901
3907
  "arguments": [
@@ -3912,10 +3918,10 @@
3912
3918
  [
3913
3919
  "j",
3914
3920
  "json",
3915
- "return the component data in json format"
3921
+ "return the component schema in json format"
3916
3922
  ]
3917
3923
  ],
3918
- "description": "shows the API schema of a certain component.",
3924
+ "description": "shows the API schema of the specified component/s.",
3919
3925
  "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
3920
3926
  "group": "development",
3921
3927
  "private": false
@@ -4002,7 +4008,7 @@
4002
4008
  [
4003
4009
  "d",
4004
4010
  "debug",
4005
- "show the origins were the aspects were taken from"
4011
+ "show the origins where the aspects were taken from"
4006
4012
  ]
4007
4013
  ],
4008
4014
  "description": "list all aspects configured on component(s)",
@@ -4012,7 +4018,7 @@
4012
4018
  "arguments": [
4013
4019
  {
4014
4020
  "name": "pattern",
4015
- "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4021
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4016
4022
  }
4017
4023
  ]
4018
4024
  },
@@ -4023,7 +4029,7 @@
4023
4029
  [
4024
4030
  "d",
4025
4031
  "debug",
4026
- "show the origins were the aspects were taken from"
4032
+ "show the origins where the aspects were taken from"
4027
4033
  ],
4028
4034
  [
4029
4035
  "j",
@@ -4031,14 +4037,14 @@
4031
4037
  "format as json"
4032
4038
  ]
4033
4039
  ],
4034
- "description": "list the aspects set on a component, as well as their config and data",
4040
+ "description": "list the aspects set on a component, as well as their configs and data",
4035
4041
  "extendedDescription": "",
4036
4042
  "group": "development",
4037
4043
  "private": false,
4038
4044
  "arguments": [
4039
4045
  {
4040
4046
  "name": "component-name",
4041
- "description": "the component name or component id"
4047
+ "description": "the component name or component id to fetch aspects for"
4042
4048
  }
4043
4049
  ]
4044
4050
  },
@@ -4049,7 +4055,7 @@
4049
4055
  [
4050
4056
  "m",
4051
4057
  "merge",
4052
- "merge with an existing config if exits. (by default, it replaces the config)"
4058
+ "merge with an existing config if exits. (by default, it replaces overlapping existing configs)"
4053
4059
  ]
4054
4060
  ],
4055
4061
  "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
@@ -4059,7 +4065,7 @@
4059
4065
  "arguments": [
4060
4066
  {
4061
4067
  "name": "pattern",
4062
- "description": "the components to extend. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
4068
+ "description": "the components to extend. component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4063
4069
  },
4064
4070
  {
4065
4071
  "name": "aspect-id",
@@ -4082,7 +4088,7 @@
4082
4088
  "arguments": [
4083
4089
  {
4084
4090
  "name": "pattern",
4085
- "description": "the components to target. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
4091
+ "description": "the components to target. component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4086
4092
  },
4087
4093
  {
4088
4094
  "name": "aspect-id",
@@ -4094,28 +4100,28 @@
4094
4100
  "name": "update <aspect-id> [pattern]",
4095
4101
  "alias": "",
4096
4102
  "options": [],
4097
- "description": "update a version of an aspect",
4103
+ "description": "update a version of an aspect for all or specified components",
4098
4104
  "extendedDescription": "",
4099
4105
  "group": "development",
4100
4106
  "private": false,
4101
4107
  "arguments": [
4102
4108
  {
4103
4109
  "name": "aspect-id",
4104
- "description": "the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote"
4110
+ "description": "the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote"
4105
4111
  },
4106
4112
  {
4107
4113
  "name": "pattern",
4108
- "description": "the components to update (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
4114
+ "description": "the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4109
4115
  }
4110
4116
  ],
4111
4117
  "examples": [
4112
4118
  {
4113
- "cmd": "update scope.org/aspect '**/ui/**'",
4114
- "description": "update \"ui\" components that use scope.org/aspect to use its latest version"
4119
+ "cmd": "bit aspect update scope.org/aspect '**/ui/**'",
4120
+ "description": "update all components with the \"ui\" namespace that use scope.org/aspect, to use its latest version"
4115
4121
  },
4116
4122
  {
4117
4123
  "cmd": "bit aspect update scope.org/aspect@2.0.0",
4118
- "description": "update all components that use scope.org/aspect to version 2.0.0 (of this aspect)."
4124
+ "description": "update version of scope.org/aspect to version 2.0.0 for all components configured with that aspect."
4119
4125
  }
4120
4126
  ]
4121
4127
  }
@@ -4203,7 +4209,7 @@
4203
4209
  [
4204
4210
  "",
4205
4211
  "new-id <string>",
4206
- "if replaced by another component, enter the new component id"
4212
+ "if replaced by another component, enter the new component id. alternatively use \"bit rename\" to do this automatically"
4207
4213
  ]
4208
4214
  ],
4209
4215
  "description": "deprecate a component",
@@ -4237,12 +4243,12 @@
4237
4243
  [
4238
4244
  "s",
4239
4245
  "scope <scope-name>",
4240
- "default scope for the newly created component"
4246
+ "define the scope for the newly created component"
4241
4247
  ],
4242
4248
  [
4243
4249
  "p",
4244
4250
  "path <relative-path>",
4245
- "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
4251
+ "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"
4246
4252
  ],
4247
4253
  [
4248
4254
  "r",
@@ -4255,7 +4261,7 @@
4255
4261
  "avoid renaming files and variables/classes according to the new component name"
4256
4262
  ]
4257
4263
  ],
4258
- "description": "rename component. if tagged/exported, create a new component and deprecate the original component",
4264
+ "description": "rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component",
4259
4265
  "extendedDescription": "",
4260
4266
  "group": "collaborate",
4261
4267
  "private": false,
@@ -4268,7 +4274,7 @@
4268
4274
  },
4269
4275
  {
4270
4276
  "name": "new-name",
4271
- "description": "the new component name (without its scope name)"
4277
+ "description": "the new component name (without its scope name. use --scope to define the new component's scope)"
4272
4278
  }
4273
4279
  ]
4274
4280
  },
@@ -4304,12 +4310,12 @@
4304
4310
  [
4305
4311
  "",
4306
4312
  "skip-config",
4307
- "do not copy the config (aspects-config) to the new component. helpful when it fails during aspect loading"
4313
+ "do not copy the config (aspects-config, env, etc) to the new component. helpful when it fails during aspect loading"
4308
4314
  ],
4309
4315
  [
4310
4316
  "",
4311
4317
  "preserve",
4312
- "avoid renaming files and variables/classes according to the new component name"
4318
+ "avoid refactoring file and variable/class names according to the new component name"
4313
4319
  ],
4314
4320
  [
4315
4321
  "",
@@ -4317,7 +4323,7 @@
4317
4323
  "avoid saving a reference to the original component"
4318
4324
  ]
4319
4325
  ],
4320
- "description": "create a new component out of an existing one (copies source files and config)",
4326
+ "description": "create a new component forked from an existing one (copies source files and configs)",
4321
4327
  "extendedDescription": "",
4322
4328
  "group": "collaborate",
4323
4329
  "private": false,
@@ -4330,7 +4336,7 @@
4330
4336
  },
4331
4337
  {
4332
4338
  "name": "target-component-name",
4333
- "description": "the name for the new component (component name without scope). to set a different scope, use the '--scope' flag"
4339
+ "description": "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag"
4334
4340
  }
4335
4341
  ]
4336
4342
  },
@@ -4341,7 +4347,7 @@
4341
4347
  [
4342
4348
  "f",
4343
4349
  "force",
4344
- "ignore local version. remove the components even when they are staged or modified"
4350
+ "ignore local changes/versions. eject component/s even when they are staged or modified. Note: unexported tags/snaps will be lost"
4345
4351
  ],
4346
4352
  [
4347
4353
  "j",
@@ -4354,14 +4360,14 @@
4354
4360
  "keep the component files in the workspace intact"
4355
4361
  ]
4356
4362
  ],
4357
- "description": "replace components maintained in the workspace with their corresponding packages",
4358
- "extendedDescription": "",
4363
+ "description": "remove component from the workspace and install it instead as a regular npm package.",
4364
+ "extendedDescription": "By default the component files will be removed from the workspace",
4359
4365
  "group": "development",
4360
4366
  "private": false,
4361
4367
  "arguments": [
4362
4368
  {
4363
4369
  "name": "component-pattern",
4364
- "description": "component name, component id, or component pattern.\nuse component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4370
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
4365
4371
  }
4366
4372
  ]
4367
4373
  },
@@ -4442,7 +4448,7 @@
4442
4448
  [
4443
4449
  "",
4444
4450
  "rebuild",
4445
- "allow signing components that their buildStatus is success for testing purposes"
4451
+ "allow signing components whose buildStatus is successful for testing purposes"
4446
4452
  ]
4447
4453
  ],
4448
4454
  "description": "complete the build process for components",
@@ -4546,7 +4552,7 @@
4546
4552
  [
4547
4553
  "",
4548
4554
  "dry-run-with-content",
4549
- "use with --json flag. show the config content and the paths it will be written per env"
4555
+ "use with --json flag. show the config content and the paths that will be written per env"
4550
4556
  ],
4551
4557
  [
4552
4558
  "v",
@@ -4576,12 +4582,12 @@
4576
4582
  [
4577
4583
  "w",
4578
4584
  "writers <writers>",
4579
- "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4585
+ "only clean config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4580
4586
  ],
4581
4587
  [
4582
4588
  "",
4583
4589
  "dry-run",
4584
- "show the paths that configs will be written per env"
4590
+ "show the paths of configs that will be cleaned"
4585
4591
  ],
4586
4592
  [
4587
4593
  "j",