@teambit/harmony.content.cli-reference 1.95.27 → 1.95.30

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.
@@ -997,23 +997,29 @@
997
997
  "private": false
998
998
  },
999
999
  {
1000
- "name": "use [ids...]",
1000
+ "name": "use [component-ids...]",
1001
1001
  "alias": "",
1002
1002
  "options": [],
1003
- "description": "set up aspects in the workspace/scope config",
1003
+ "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
1004
1004
  "extendedDescription": "",
1005
1005
  "group": "collaborate",
1006
1006
  "private": false,
1007
- "remoteOp": true
1007
+ "remoteOp": true,
1008
+ "arguments": [
1009
+ {
1010
+ "name": "component-ids...",
1011
+ "description": "the component IDs of the aspects"
1012
+ }
1013
+ ]
1008
1014
  },
1009
1015
  {
1010
- "name": "show <id>",
1016
+ "name": "show <component-name>",
1011
1017
  "alias": "",
1012
1018
  "options": [
1013
1019
  [
1014
1020
  "j",
1015
1021
  "json",
1016
- "return the component data in json format"
1022
+ "return the component data in a json format"
1017
1023
  ],
1018
1024
  [
1019
1025
  "l",
@@ -1028,13 +1034,19 @@
1028
1034
  [
1029
1035
  "c",
1030
1036
  "compare",
1031
- "compare current file system component to latest tagged component [default=latest]. only works in legacy."
1037
+ "compare current file system component to the latest tagged component [default=latest]. only works in legacy."
1032
1038
  ]
1033
1039
  ],
1034
- "description": "show a component",
1040
+ "description": "display the component's essential information",
1035
1041
  "extendedDescription": "",
1036
1042
  "group": "info",
1037
- "private": false
1043
+ "private": false,
1044
+ "arguments": [
1045
+ {
1046
+ "name": "component-name",
1047
+ "description": "component name or component id"
1048
+ }
1049
+ ]
1038
1050
  },
1039
1051
  {
1040
1052
  "name": "globals",
@@ -1055,7 +1067,7 @@
1055
1067
  "name": "envs",
1056
1068
  "alias": "env",
1057
1069
  "options": [],
1058
- "description": "list all components envs",
1070
+ "description": "list all components maintained by the workspace and their corresponding envs",
1059
1071
  "extendedDescription": "",
1060
1072
  "group": "development",
1061
1073
  "private": false,
@@ -1070,33 +1082,84 @@
1070
1082
  "private": false
1071
1083
  },
1072
1084
  {
1073
- "name": "get <name>",
1085
+ "name": "get <component-name>",
1074
1086
  "alias": "",
1075
1087
  "options": [],
1076
- "description": "show component's env details",
1088
+ "description": "show information about a component's env",
1077
1089
  "extendedDescription": "",
1078
1090
  "group": "development",
1079
- "private": false
1091
+ "private": false,
1092
+ "arguments": [
1093
+ {
1094
+ "name": "component-name",
1095
+ "description": "the 'component name' or 'component id' of the component its env you'd like to inspect"
1096
+ }
1097
+ ]
1080
1098
  },
1081
1099
  {
1082
- "name": "set <pattern> <env>",
1100
+ "name": "set <component-pattern> <env>",
1083
1101
  "options": [],
1084
- "description": "set an environment for component(s)",
1085
- "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit env set \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
1086
- "group": "development"
1102
+ "description": "Sets one or more components with a development environment (env)",
1103
+ "group": "development",
1104
+ "arguments": [
1105
+ {
1106
+ "name": "component-pattern",
1107
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse commas to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1108
+ },
1109
+ {
1110
+ "name": "env",
1111
+ "description": "the env's component id (include version for non-core envs. e.g, `teambit.community/envs/community-react@1.95.13`)"
1112
+ }
1113
+ ],
1114
+ "examples": [
1115
+ {
1116
+ "cmd": "set ui/button teambit.react/react",
1117
+ "description": "configures 'ui/button' to use the 'teambit.react/react' env"
1118
+ },
1119
+ {
1120
+ "cmd": "set ui/button teambit.community/envs/community-mdx@1.95.16",
1121
+ "description": "configures 'ui/button' to use the (non-core) 'teambit.community/envs/community-mdx@1.95.16' env"
1122
+ },
1123
+ {
1124
+ "cmd": "set \"ui/**\" teambit.react/react",
1125
+ "description": "configures all components that have the 'ui' namespace to use the teambit.react/react env"
1126
+ }
1127
+ ]
1087
1128
  },
1088
1129
  {
1089
- "name": "unset <pattern>",
1130
+ "name": "unset <component-pattern>",
1090
1131
  "options": [],
1091
- "description": "unset an environment from component(s) that was set by \"bit env set\"",
1132
+ "description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
1092
1133
  "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/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
1093
- "group": "development"
1134
+ "group": "development",
1135
+ "arguments": [
1136
+ {
1137
+ "name": "component-pattern",
1138
+ "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"
1139
+ }
1140
+ ]
1094
1141
  },
1095
1142
  {
1096
- "name": "replace <old-env> <new-env>",
1143
+ "name": "replace <current-env> <new-env>",
1097
1144
  "options": [],
1098
1145
  "description": "replace an existing env with another env for all components using the old env",
1099
- "group": "development"
1146
+ "group": "development",
1147
+ "arguments": [
1148
+ {
1149
+ "name": "current-env",
1150
+ "description": "the component id of the current env"
1151
+ },
1152
+ {
1153
+ "name": "new-env",
1154
+ "description": "the component id of the new env"
1155
+ }
1156
+ ],
1157
+ "examples": [
1158
+ {
1159
+ "cmd": "replace teambit.harmony/aspect teambit.harmony/node",
1160
+ "description": "components configured to use the 'aspect' env will be configured to use the 'node' env, instead"
1161
+ }
1162
+ ]
1100
1163
  }
1101
1164
  ]
1102
1165
  },
@@ -1111,7 +1174,7 @@
1111
1174
  ],
1112
1175
  [
1113
1176
  "p",
1114
- "port [number]",
1177
+ "port [port-number]",
1115
1178
  "port of the UI server."
1116
1179
  ],
1117
1180
  [
@@ -1122,7 +1185,7 @@
1122
1185
  [
1123
1186
  "v",
1124
1187
  "verbose",
1125
- "showing verbose output for inspection and prints stack trace"
1188
+ "show verbose output for inspection and prints stack trace"
1126
1189
  ],
1127
1190
  [
1128
1191
  "",
@@ -1135,7 +1198,7 @@
1135
1198
  "skip the auto-compilation before starting the web-server"
1136
1199
  ]
1137
1200
  ],
1138
- "description": "Start a dev environment for a workspace or a specific component",
1201
+ "description": "run the ui/development server",
1139
1202
  "extendedDescription": "",
1140
1203
  "group": "development",
1141
1204
  "private": false
@@ -1153,20 +1216,30 @@
1153
1216
  "name": "scope <sub-command>",
1154
1217
  "alias": "",
1155
1218
  "options": [],
1156
- "description": "EXPERIMENTAL. manage scope-name",
1219
+ "description": "EXPERIMENTAL. manage the scope-name for components",
1157
1220
  "extendedDescription": "",
1158
1221
  "group": "development",
1159
1222
  "private": false,
1160
1223
  "commands": [
1161
1224
  {
1162
- "name": "set <scope-name> [pattern]",
1225
+ "name": "set <scope-name> [component-pattern]",
1163
1226
  "options": [],
1164
- "description": "set the default-scope",
1165
- "extendedDescription": "set a new scope in the workspace.jsonc.\nif \"pattern\" is provided, the default-scope will be set to the new components matching the criteria.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
1166
- "group": "development"
1227
+ "description": "Sets components with a default-scope. If no component is specified, sets the workspace with a default scope",
1228
+ "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/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
1229
+ "group": "development",
1230
+ "arguments": [
1231
+ {
1232
+ "name": "scope-name",
1233
+ "description": "the scope name to use as the default scope"
1234
+ },
1235
+ {
1236
+ "name": "component-pattern",
1237
+ "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"
1238
+ }
1239
+ ]
1167
1240
  },
1168
1241
  {
1169
- "name": "rename <old-name> <new-name>",
1242
+ "name": "rename <current-scope-name> <new-scope-name>",
1170
1243
  "options": [
1171
1244
  [
1172
1245
  "r",
@@ -1174,8 +1247,18 @@
1174
1247
  "change the source code of all components using the original scope-name with the new scope-name"
1175
1248
  ]
1176
1249
  ],
1177
- "description": "rename a scope for components using the old-name, optionally change the dependencies source-code",
1178
- "group": "development"
1250
+ "description": "Renames the scope name for all components with the specified 'current scope name'",
1251
+ "group": "development",
1252
+ "arguments": [
1253
+ {
1254
+ "name": "current-scope-name",
1255
+ "description": "the scope name to be replaced by another scope name"
1256
+ },
1257
+ {
1258
+ "name": "new-scope-name",
1259
+ "description": "a new scope name to replace the current scope name"
1260
+ }
1261
+ ]
1179
1262
  },
1180
1263
  {
1181
1264
  "name": "fork <original-scope> <new-scope>",
@@ -1225,8 +1308,8 @@
1225
1308
  "install all missing peer dependencies"
1226
1309
  ]
1227
1310
  ],
1228
- "description": "install development workspace dependencies",
1229
- "extendedDescription": "",
1311
+ "description": "installs workspace dependencies",
1312
+ "extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
1230
1313
  "group": "development",
1231
1314
  "private": false
1232
1315
  },
@@ -1446,18 +1529,18 @@
1446
1529
  "private": false
1447
1530
  },
1448
1531
  {
1449
- "name": "import [ids...]",
1532
+ "name": "import [component-ids...]",
1450
1533
  "alias": "",
1451
1534
  "options": [
1452
1535
  [
1453
1536
  "p",
1454
1537
  "path <path>",
1455
- "import components into a specific directory"
1538
+ "import components into a specific directory (a relative path in the workspace)"
1456
1539
  ],
1457
1540
  [
1458
1541
  "o",
1459
1542
  "objects",
1460
- "import components objects only, don't write the components to the file system. This is a default behavior for import with no id"
1543
+ "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"
1461
1544
  ],
1462
1545
  [
1463
1546
  "d",
@@ -1472,7 +1555,7 @@
1472
1555
  [
1473
1556
  "v",
1474
1557
  "verbose",
1475
- "showing verbose output for inspection"
1558
+ "show verbose output for inspection"
1476
1559
  ],
1477
1560
  [
1478
1561
  "j",
@@ -1482,7 +1565,7 @@
1482
1565
  [
1483
1566
  "",
1484
1567
  "conf",
1485
- "write the configuration file (component.json) of the component (harmony components only)"
1568
+ "write the configuration file (component.json) of the component"
1486
1569
  ],
1487
1570
  [
1488
1571
  "",
@@ -1520,14 +1603,20 @@
1520
1603
  "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
1521
1604
  ]
1522
1605
  ],
1523
- "description": "import components into your workspace",
1606
+ "description": "import components from remote scopes to the local workspace",
1524
1607
  "extendedDescription": "https://bit.dev/docs/components/importing-components\nyou can use a pattern for multiple ids, such as bit import \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
1525
1608
  "group": "collaborate",
1526
1609
  "private": false,
1527
- "remoteOp": true
1610
+ "remoteOp": true,
1611
+ "arguments": [
1612
+ {
1613
+ "name": "component-ids...",
1614
+ "description": "a list of component IDs (separated by space) to import"
1615
+ }
1616
+ ]
1528
1617
  },
1529
1618
  {
1530
- "name": "create <templateName> <componentNames...>",
1619
+ "name": "create <template-name> <component-names...>",
1531
1620
  "alias": "",
1532
1621
  "options": [
1533
1622
  [
@@ -1556,10 +1645,28 @@
1556
1645
  "set the component's environment. (overrides the env from variants and the template)"
1557
1646
  ]
1558
1647
  ],
1559
- "description": "create a new component from a template",
1648
+ "description": "create a new component (source files and config) using a template.",
1560
1649
  "extendedDescription": "",
1561
1650
  "group": "development",
1562
- "private": false
1651
+ "private": false,
1652
+ "examples": [
1653
+ {
1654
+ "cmd": "bit create react ui/button",
1655
+ "description": "creates a component named 'ui/button' using the 'react' template"
1656
+ },
1657
+ {
1658
+ "cmd": "bit create react ui/button pages/register",
1659
+ "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
1660
+ },
1661
+ {
1662
+ "cmd": "bit create react ui/button --scope my-org.my-scope",
1663
+ "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
1664
+ },
1665
+ {
1666
+ "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
1667
+ "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
1668
+ }
1669
+ ]
1563
1670
  },
1564
1671
  {
1565
1672
  "name": "templates",
@@ -1577,17 +1684,17 @@
1577
1684
  "private": false
1578
1685
  },
1579
1686
  {
1580
- "name": "new <templateName> <workspaceName>",
1687
+ "name": "new <template-name> <workspace-name>",
1581
1688
  "alias": "",
1582
1689
  "options": [
1583
1690
  [
1584
1691
  "a",
1585
- "aspect <string>",
1692
+ "aspect <aspect-id>",
1586
1693
  "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
1587
1694
  ],
1588
1695
  [
1589
1696
  "d",
1590
- "default-scope <string>",
1697
+ "default-scope <scope-name>",
1591
1698
  "set defaultScope in the new workspace.jsonc"
1592
1699
  ],
1593
1700
  [
@@ -1607,14 +1714,24 @@
1607
1714
  ],
1608
1715
  [
1609
1716
  "",
1610
- "load-from <string>",
1717
+ "load-from <path-to-template>",
1611
1718
  "path to the workspace containing the template. helpful during a development of a workspace-template"
1612
1719
  ]
1613
1720
  ],
1614
- "description": "Create a new workspace from a template",
1721
+ "description": "create a new workspace from a template",
1615
1722
  "extendedDescription": "",
1616
1723
  "group": "start",
1617
- "private": false
1724
+ "private": false,
1725
+ "arguments": [
1726
+ {
1727
+ "name": "template-name",
1728
+ "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
1729
+ },
1730
+ {
1731
+ "name": "workspace-name",
1732
+ "description": "the name for the new workspace and workspace directory"
1733
+ }
1734
+ ]
1618
1735
  },
1619
1736
  {
1620
1737
  "name": "build [pattern]",
@@ -1807,13 +1924,13 @@
1807
1924
  "private": true
1808
1925
  },
1809
1926
  {
1810
- "name": "tag [id...]",
1927
+ "name": "tag [component-names...]",
1811
1928
  "alias": "t",
1812
1929
  "options": [
1813
1930
  [
1814
1931
  "m",
1815
1932
  "message <message>",
1816
- "log message describing the user changes"
1933
+ "a log message describing latest changes"
1817
1934
  ],
1818
1935
  [
1819
1936
  "",
@@ -1823,37 +1940,47 @@
1823
1940
  [
1824
1941
  "",
1825
1942
  "editor [editor]",
1826
- "EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim"
1943
+ "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
1827
1944
  ],
1828
1945
  [
1829
1946
  "v",
1830
1947
  "ver <version>",
1831
1948
  "tag with the given version"
1832
1949
  ],
1950
+ [
1951
+ "l",
1952
+ "increment <level>",
1953
+ "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
1954
+ ],
1955
+ [
1956
+ "",
1957
+ "prerelease-id <id>",
1958
+ "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
1959
+ ],
1833
1960
  [
1834
1961
  "p",
1835
1962
  "patch",
1836
- "increment the patch version number"
1963
+ "syntactic sugar for \"--increment patch\""
1837
1964
  ],
1838
1965
  [
1839
1966
  "",
1840
1967
  "minor",
1841
- "increment the minor version number"
1968
+ "syntactic sugar for \"--increment minor\""
1842
1969
  ],
1843
1970
  [
1844
1971
  "",
1845
1972
  "major",
1846
- "increment the major version number"
1973
+ "syntactic sugar for \"--increment major\""
1847
1974
  ],
1848
1975
  [
1849
1976
  "",
1850
1977
  "snapped",
1851
- "tag components that their head is a snap (not a tag)"
1978
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1852
1979
  ],
1853
1980
  [
1854
1981
  "",
1855
1982
  "pre-release [identifier]",
1856
- "EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)"
1983
+ "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
1857
1984
  ],
1858
1985
  [
1859
1986
  "",
@@ -1926,20 +2053,32 @@
1926
2053
  "DEPRECATED. use --disable-tag-pipeline instead"
1927
2054
  ]
1928
2055
  ],
1929
- "description": "record component changes and lock versions",
2056
+ "description": "create an immutable and exportable component snapshot, tagged with a release version.",
1930
2057
  "extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
1931
2058
  "group": "development",
1932
2059
  "private": false,
1933
- "remoteOp": true
2060
+ "remoteOp": true,
2061
+ "arguments": [
2062
+ {
2063
+ "name": "component-names...",
2064
+ "description": "a list of component names or component IDs (separated by space). By default, all modified are tagged."
2065
+ }
2066
+ ],
2067
+ "examples": [
2068
+ {
2069
+ "cmd": "tag --ver 1.0.0",
2070
+ "description": "tag all components to version 1.0.0"
2071
+ }
2072
+ ]
1934
2073
  },
1935
2074
  {
1936
- "name": "snap [id]",
2075
+ "name": "snap [component-name]",
1937
2076
  "alias": "",
1938
2077
  "options": [
1939
2078
  [
1940
2079
  "m",
1941
2080
  "message <message>",
1942
- "log message describing the user changes"
2081
+ "log message describing the latest changes"
1943
2082
  ],
1944
2083
  [
1945
2084
  "",
@@ -1987,10 +2126,16 @@
1987
2126
  "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
1988
2127
  ]
1989
2128
  ],
1990
- "description": "EXPERIMENTAL. record component changes",
2129
+ "description": "EXPERIMENTAL. create an immutable and exportable component snapshot (no release version)",
1991
2130
  "extendedDescription": "https://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
1992
2131
  "group": "ungrouped",
1993
- "private": true
2132
+ "private": true,
2133
+ "arguments": [
2134
+ {
2135
+ "name": "component_name",
2136
+ "description": "component names or component ID (defaults to all components)"
2137
+ }
2138
+ ]
1994
2139
  },
1995
2140
  {
1996
2141
  "name": "merge [values...]",
@@ -2057,13 +2202,13 @@
2057
2202
  "in case issues found, exit with code 1"
2058
2203
  ]
2059
2204
  ],
2060
- "description": "show the working area component(s) status",
2061
- "extendedDescription": "https://bit.dev/docs/workspace/workspace-status",
2205
+ "description": "present the current status of components in the workspace, and notifies when issues are detected",
2206
+ "extendedDescription": "",
2062
2207
  "group": "development",
2063
2208
  "private": false
2064
2209
  },
2065
2210
  {
2066
- "name": "compile [component...]",
2211
+ "name": "compile [component-names...]",
2067
2212
  "alias": "",
2068
2213
  "options": [
2069
2214
  [
@@ -2087,13 +2232,19 @@
2087
2232
  "delete existing dist folder before writing new compiled files"
2088
2233
  ]
2089
2234
  ],
2090
- "description": "compile components in the development workspace",
2235
+ "description": "compile components in the workspace",
2091
2236
  "extendedDescription": "",
2092
2237
  "group": "development",
2093
- "private": false
2238
+ "private": false,
2239
+ "arguments": [
2240
+ {
2241
+ "name": "component-names...",
2242
+ "description": "a list of component names or component IDs (defaults to all components)"
2243
+ }
2244
+ ]
2094
2245
  },
2095
2246
  {
2096
- "name": "run <app>",
2247
+ "name": "run <app-name>",
2097
2248
  "alias": "c",
2098
2249
  "options": [
2099
2250
  [
@@ -2112,10 +2263,16 @@
2112
2263
  "avoid running the watch process that compiles components in the background"
2113
2264
  ]
2114
2265
  ],
2115
- "description": "run an application",
2266
+ "description": "run an app (independent of bit's dev server)",
2116
2267
  "extendedDescription": "",
2117
2268
  "group": "apps",
2118
- "private": false
2269
+ "private": false,
2270
+ "arguments": [
2271
+ {
2272
+ "name": "app-name",
2273
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2274
+ }
2275
+ ]
2119
2276
  },
2120
2277
  {
2121
2278
  "name": "app-list",
@@ -2136,7 +2293,7 @@
2136
2293
  "name": "app <sub-command>",
2137
2294
  "alias": "",
2138
2295
  "options": [],
2139
- "description": "manage applications",
2296
+ "description": "Manages apps",
2140
2297
  "extendedDescription": "",
2141
2298
  "group": "apps",
2142
2299
  "private": false,
@@ -2151,7 +2308,7 @@
2151
2308
  "return the component data in json format"
2152
2309
  ]
2153
2310
  ],
2154
- "description": "list all registered applications",
2311
+ "description": "list all registered apps",
2155
2312
  "extendedDescription": "",
2156
2313
  "group": "apps",
2157
2314
  "private": false
@@ -2159,7 +2316,7 @@
2159
2316
  ]
2160
2317
  },
2161
2318
  {
2162
- "name": "test [pattern]",
2319
+ "name": "test [component-pattern]",
2163
2320
  "alias": "at",
2164
2321
  "options": [
2165
2322
  [
@@ -2194,14 +2351,20 @@
2194
2351
  ],
2195
2352
  [
2196
2353
  "s",
2197
- "scope <scope>",
2354
+ "scope <scope-name>",
2198
2355
  "name of the scope to test"
2199
2356
  ]
2200
2357
  ],
2201
- "description": "test set of components in your workspace",
2358
+ "description": "test components in the workspace",
2202
2359
  "extendedDescription": "",
2203
2360
  "group": "development",
2204
- "private": false
2361
+ "private": false,
2362
+ "arguments": [
2363
+ {
2364
+ "name": "component-pattern",
2365
+ "description": "the components to test (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. \nuse comma to separate patterns. e.g. \"ui/**, pages/**\"\nwrap the pattern with quotes (note that the \"!\" exclusion sign cannot be used here)"
2366
+ }
2367
+ ]
2205
2368
  },
2206
2369
  {
2207
2370
  "name": "schema <pattern>",
@@ -2340,6 +2503,11 @@
2340
2503
  "",
2341
2504
  "parents",
2342
2505
  "EXPERIMENTAL. show parents and lanes data"
2506
+ ],
2507
+ [
2508
+ "j",
2509
+ "json",
2510
+ "json format"
2343
2511
  ]
2344
2512
  ],
2345
2513
  "description": "show components(s) version history",
@@ -2347,7 +2515,13 @@
2347
2515
  "group": "info",
2348
2516
  "private": false,
2349
2517
  "remoteOp": true,
2350
- "skipWorkspace": true
2518
+ "skipWorkspace": true,
2519
+ "arguments": [
2520
+ {
2521
+ "name": "id",
2522
+ "description": "component-id or component-name"
2523
+ }
2524
+ ]
2351
2525
  },
2352
2526
  {
2353
2527
  "name": "deprecate <id>",
@@ -2405,34 +2579,44 @@
2405
2579
  "skipWorkspace": true
2406
2580
  },
2407
2581
  {
2408
- "name": "fork <source-id> [target-name]",
2582
+ "name": "fork <source-component-id> [target-component-name]",
2409
2583
  "alias": "",
2410
2584
  "options": [
2411
2585
  [
2412
2586
  "s",
2413
2587
  "scope <string>",
2414
- "default scope for the newly created component"
2588
+ "default scope for the new component"
2415
2589
  ],
2416
2590
  [
2417
2591
  "p",
2418
2592
  "path <string>",
2419
- "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
2593
+ "relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>`"
2420
2594
  ],
2421
2595
  [
2422
2596
  "r",
2423
2597
  "refactor",
2424
- "change the source code of all components using the original component with the new package-name"
2598
+ "update the import/require statements in all dependent components (in the same workspace)"
2425
2599
  ]
2426
2600
  ],
2427
- "description": "EXPERIMENTAL. create a new component out of an existing one",
2428
- "extendedDescription": "note that [target-name] is the name only without the scope.\nto set the default-scope, please use --scope flag",
2601
+ "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
2602
+ "extendedDescription": "",
2429
2603
  "group": "collaborate",
2430
2604
  "private": false,
2431
2605
  "remoteOp": true,
2432
- "skipWorkspace": true
2606
+ "skipWorkspace": true,
2607
+ "arguments": [
2608
+ {
2609
+ "name": "source-component-id",
2610
+ "description": "the component id of the source component"
2611
+ },
2612
+ {
2613
+ "name": "target-component-name",
2614
+ "description": "the name for the new component (component name without scope). to set a different scope, use the '--scope' flag"
2615
+ }
2616
+ ]
2433
2617
  },
2434
2618
  {
2435
- "name": "lane [name]",
2619
+ "name": "lane [lane-name]",
2436
2620
  "alias": "",
2437
2621
  "options": [
2438
2622
  [
@@ -2480,11 +2664,11 @@
2480
2664
  [
2481
2665
  "j",
2482
2666
  "json",
2483
- "show lanes details in json format"
2667
+ "show lanes details in a json format"
2484
2668
  ],
2485
2669
  [
2486
2670
  "r",
2487
- "remote <string>",
2671
+ "remote <remote-scope-name>",
2488
2672
  "show remote lanes"
2489
2673
  ],
2490
2674
  [
@@ -2495,7 +2679,7 @@
2495
2679
  [
2496
2680
  "",
2497
2681
  "not-merged",
2498
- "show not merged lanes"
2682
+ "show lanes that are not merged"
2499
2683
  ]
2500
2684
  ],
2501
2685
  "description": "list lanes",
@@ -2541,7 +2725,7 @@
2541
2725
  "private": true
2542
2726
  },
2543
2727
  {
2544
- "name": "show <name>",
2728
+ "name": "show <lane-name>",
2545
2729
  "alias": "",
2546
2730
  "options": [
2547
2731
  [
@@ -2563,21 +2747,21 @@
2563
2747
  "skipWorkspace": true
2564
2748
  },
2565
2749
  {
2566
- "name": "create <name>",
2750
+ "name": "create <lane-name>",
2567
2751
  "alias": "",
2568
2752
  "options": [
2569
2753
  [
2570
2754
  "",
2571
- "remote-scope <string>",
2755
+ "remote-scope <scope-name>",
2572
2756
  "remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
2573
2757
  ],
2574
2758
  [
2575
2759
  "",
2576
- "alias <string>",
2577
- "a local alias to refer to this lane, default to the <name> (can be added later with \"bit lane alias\")"
2760
+ "alias <name>",
2761
+ "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
2578
2762
  ]
2579
2763
  ],
2580
- "description": "create and switch to a new lane",
2764
+ "description": "creates a new lane and switches to it",
2581
2765
  "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.",
2582
2766
  "group": "ungrouped",
2583
2767
  "private": true
@@ -2588,7 +2772,7 @@
2588
2772
  "options": [
2589
2773
  [
2590
2774
  "",
2591
- "remote <name>",
2775
+ "remote <scope-name>",
2592
2776
  "remote scope name"
2593
2777
  ],
2594
2778
  [
@@ -2630,6 +2814,11 @@
2630
2814
  "",
2631
2815
  "keep-readme",
2632
2816
  "skip deleting the lane readme component after merging"
2817
+ ],
2818
+ [
2819
+ "",
2820
+ "squash",
2821
+ "squash multiple snaps. keep the last one only"
2633
2822
  ]
2634
2823
  ],
2635
2824
  "description": "merge a local or a remote lane",
@@ -2639,7 +2828,7 @@
2639
2828
  "remoteOp": true
2640
2829
  },
2641
2830
  {
2642
- "name": "remove <lane...>",
2831
+ "name": "remove <lanes...>",
2643
2832
  "alias": "",
2644
2833
  "options": [
2645
2834
  [
@@ -2664,10 +2853,10 @@
2664
2853
  "private": true
2665
2854
  },
2666
2855
  {
2667
- "name": "change-scope <lane-name> <remote-scope>",
2856
+ "name": "change-scope <lane-name> <remote-scope-name>",
2668
2857
  "alias": "",
2669
2858
  "options": [],
2670
- "description": "change the remote scope of a lane",
2859
+ "description": "changes the remote scope of a lane",
2671
2860
  "extendedDescription": "",
2672
2861
  "group": "ungrouped",
2673
2862
  "private": true
@@ -2676,7 +2865,7 @@
2676
2865
  "name": "alias <lane-name> <alias>",
2677
2866
  "alias": "",
2678
2867
  "options": [],
2679
- "description": "add an alias to a lane",
2868
+ "description": "adds an alias to a lane",
2680
2869
  "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.",
2681
2870
  "group": "ungrouped",
2682
2871
  "private": true
@@ -2702,10 +2891,10 @@
2702
2891
  "skipWorkspace": true
2703
2892
  },
2704
2893
  {
2705
- "name": "add-readme <componentId> [laneName]",
2894
+ "name": "add-readme <component-name> [lane-name]",
2706
2895
  "alias": "",
2707
2896
  "options": [],
2708
- "description": "EXPERIMENTAL. add lane readme component",
2897
+ "description": "EXPERIMENTAL. adds a readme component to a lane",
2709
2898
  "extendedDescription": "",
2710
2899
  "group": "ungrouped",
2711
2900
  "private": true,
@@ -2809,18 +2998,18 @@
2809
2998
  "remoteOp": true
2810
2999
  },
2811
3000
  {
2812
- "name": "export [remote] [id...]",
3001
+ "name": "export [remote] [component-names...]",
2813
3002
  "alias": "e",
2814
3003
  "options": [
2815
3004
  [
2816
3005
  "e",
2817
3006
  "eject",
2818
- "replaces the exported components from the local scope with the corresponding packages"
3007
+ "replace the exported components with their corresponding packages (to use these components without further maintaining them)"
2819
3008
  ],
2820
3009
  [
2821
3010
  "a",
2822
3011
  "all",
2823
- "export all components include non-staged"
3012
+ "export all components, including non-staged"
2824
3013
  ],
2825
3014
  [
2826
3015
  "d",
@@ -2868,11 +3057,21 @@
2868
3057
  "show output in json format"
2869
3058
  ]
2870
3059
  ],
2871
- "description": "Export components to a remote scope",
3060
+ "description": "export components from the workspace to remote scopes",
2872
3061
  "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\nhttps://bit.dev/docs/components/exporting-components\nyou 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)",
2873
3062
  "group": "collaborate",
2874
3063
  "private": false,
2875
- "remoteOp": true
3064
+ "remoteOp": true,
3065
+ "arguments": [
3066
+ {
3067
+ "name": "remote",
3068
+ "description": "LEGACY ONLY."
3069
+ },
3070
+ {
3071
+ "name": "component-names...",
3072
+ "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
3073
+ }
3074
+ ]
2876
3075
  },
2877
3076
  {
2878
3077
  "name": "update-dependencies <data>",