@teambit/harmony.content.cli-reference 1.95.34 → 1.95.37

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.
@@ -543,7 +543,7 @@
543
543
  "description": "revert tagged or snapped versions for component(s)",
544
544
  "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
545
545
  "group": "development",
546
- "private": false
546
+ "private": true
547
547
  },
548
548
  {
549
549
  "name": "move <current-component-dir> <new-component-dir>",
@@ -955,22 +955,6 @@
955
955
  "group": "general",
956
956
  "private": false
957
957
  },
958
- {
959
- "name": "use [component-ids...]",
960
- "alias": "",
961
- "options": [],
962
- "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
963
- "extendedDescription": "",
964
- "group": "collaborate",
965
- "private": false,
966
- "remoteOp": true,
967
- "arguments": [
968
- {
969
- "name": "component-ids...",
970
- "description": "the component IDs of the aspects"
971
- }
972
- ]
973
- },
974
958
  {
975
959
  "name": "show <component-name>",
976
960
  "alias": "",
@@ -1048,7 +1032,7 @@
1048
1032
  "arguments": [
1049
1033
  {
1050
1034
  "name": "component-pattern",
1051
- "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"
1035
+ "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"
1052
1036
  },
1053
1037
  {
1054
1038
  "name": "env",
@@ -1484,6 +1468,22 @@
1484
1468
  }
1485
1469
  ]
1486
1470
  },
1471
+ {
1472
+ "name": "use <component-id>",
1473
+ "alias": "",
1474
+ "options": [],
1475
+ "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
1476
+ "extendedDescription": "",
1477
+ "group": "collaborate",
1478
+ "private": false,
1479
+ "remoteOp": true,
1480
+ "arguments": [
1481
+ {
1482
+ "name": "component-id",
1483
+ "description": "the component ID of the aspect"
1484
+ }
1485
+ ]
1486
+ },
1487
1487
  {
1488
1488
  "name": "pattern <pattern>",
1489
1489
  "alias": "",
@@ -1497,7 +1497,29 @@
1497
1497
  "description": "list the component ids matching the given pattern",
1498
1498
  "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",
1499
1499
  "group": "development",
1500
- "private": false
1500
+ "private": false,
1501
+ "examples": [
1502
+ {
1503
+ "cmd": "bit pattern \"**\"",
1504
+ "description": "matches all components"
1505
+ },
1506
+ {
1507
+ "cmd": "bit pattern \"*/ui/*\"",
1508
+ "description": "matches components with any scope-name and the \"ui\" namespace. e.g. \"ui/button\" but not \"ui/elements/button\""
1509
+ },
1510
+ {
1511
+ "cmd": "bit pattern \"*/ui/**\"",
1512
+ "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
1513
+ },
1514
+ {
1515
+ "cmd": "bit pattern \"bar, foo\"",
1516
+ "description": "matches two components: bar and foo"
1517
+ },
1518
+ {
1519
+ "cmd": "bit pattern \"my-scope.org/**\"",
1520
+ "description": "matches all components of the scope \"my-scope.org\""
1521
+ }
1522
+ ]
1501
1523
  },
1502
1524
  {
1503
1525
  "name": "list [remote-scope]",
@@ -1803,7 +1825,7 @@
1803
1825
  ]
1804
1826
  },
1805
1827
  {
1806
- "name": "artifacts <pattern...>",
1828
+ "name": "artifacts <component-pattern>",
1807
1829
  "alias": "",
1808
1830
  "options": [
1809
1831
  [
@@ -1830,7 +1852,13 @@
1830
1852
  "description": "EXPERIMENTAL. list and download components artifacts",
1831
1853
  "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",
1832
1854
  "group": "development",
1833
- "private": false
1855
+ "private": false,
1856
+ "arguments": [
1857
+ {
1858
+ "name": "component-pattern",
1859
+ "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"
1860
+ }
1861
+ ]
1834
1862
  },
1835
1863
  {
1836
1864
  "name": "pack <componentId> [scopePath]",
@@ -1998,13 +2026,13 @@
1998
2026
  ],
1999
2027
  [
2000
2028
  "",
2001
- "snapped",
2002
- "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2029
+ "pre-release [identifier]",
2030
+ "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
2003
2031
  ],
2004
2032
  [
2005
2033
  "",
2006
- "pre-release [identifier]",
2007
- "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
2034
+ "snapped",
2035
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2008
2036
  ],
2009
2037
  [
2010
2038
  "",
@@ -2161,6 +2189,41 @@
2161
2189
  }
2162
2190
  ]
2163
2191
  },
2192
+ {
2193
+ "name": "reset [component-pattern] [component-version]",
2194
+ "alias": "",
2195
+ "options": [
2196
+ [
2197
+ "a",
2198
+ "all",
2199
+ "revert tag/snap for all tagged/snapped components"
2200
+ ],
2201
+ [
2202
+ "",
2203
+ "soft",
2204
+ "revert only soft-tags (components tagged with --soft flag)"
2205
+ ],
2206
+ [
2207
+ "f",
2208
+ "force",
2209
+ "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
2210
+ ]
2211
+ ],
2212
+ "description": "revert tagged or snapped versions for component(s)",
2213
+ "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
2214
+ "group": "development",
2215
+ "private": false,
2216
+ "arguments": [
2217
+ {
2218
+ "name": "component-pattern",
2219
+ "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"
2220
+ },
2221
+ {
2222
+ "name": "component-version",
2223
+ "description": "the version to untag (semver for tags. hash for snaps)"
2224
+ }
2225
+ ]
2226
+ },
2164
2227
  {
2165
2228
  "name": "merge [values...]",
2166
2229
  "alias": "",
@@ -3122,7 +3185,7 @@
3122
3185
  "remoteOp": true
3123
3186
  },
3124
3187
  {
3125
- "name": "export [remote] [component-names...]",
3188
+ "name": "export [component-names...]",
3126
3189
  "alias": "e",
3127
3190
  "options": [
3128
3191
  [
@@ -3135,26 +3198,6 @@
3135
3198
  "all",
3136
3199
  "export all components, including non-staged"
3137
3200
  ],
3138
- [
3139
- "d",
3140
- "include-dependencies",
3141
- "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
3142
- ],
3143
- [
3144
- "s",
3145
- "set-current-scope",
3146
- "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
3147
- ],
3148
- [
3149
- "r",
3150
- "rewire",
3151
- "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
3152
- ],
3153
- [
3154
- "f",
3155
- "force",
3156
- "force changing a component remote without asking for a confirmation"
3157
- ],
3158
3201
  [
3159
3202
  "",
3160
3203
  "all-versions",
@@ -3187,10 +3230,6 @@
3187
3230
  "private": false,
3188
3231
  "remoteOp": true,
3189
3232
  "arguments": [
3190
- {
3191
- "name": "remote",
3192
- "description": "LEGACY ONLY."
3193
- },
3194
3233
  {
3195
3234
  "name": "component-names...",
3196
3235
  "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
package/cli-reference.mdx CHANGED
@@ -51,7 +51,7 @@ artifacts are created on isolated capsules during tag or snap commands.
51
51
  example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
52
52
  and a package.tgz file generated by pkg aspect.
53
53
 
54
- `bit artifacts <pattern...>`
54
+ `bit artifacts <component-pattern>`
55
55
 
56
56
  | **Option** | **Option alias** | **Description** |
57
57
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
@@ -519,16 +519,12 @@ bit export => export all staged components to their current scope, if checked ou
519
519
  https://bit.dev/docs/components/exporting-components
520
520
  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)
521
521
 
522
- `bit export [remote] [component-names...]`
522
+ `bit export [component-names...]`
523
523
 
524
524
  | **Option** | **Option alias** | **Description** |
525
525
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
526
526
  | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
527
527
  | `--all` | `-a` | export all components, including non-staged |
528
- | `--include-dependencies` | `-d` | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope |
529
- | `--set-current-scope` | `-s` | LEGACY ONLY. ensure the component's remote scope is set according to the target location |
530
- | `--rewire` | `-r` | LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope |
531
- | `--force` | `-f` | force changing a component remote without asking for a confirmation |
532
528
  | `--all-versions` | | export not only staged versions but all of them |
533
529
  | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
534
530
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
@@ -957,6 +953,22 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
957
953
 
958
954
  ---
959
955
 
956
+ ## reset
957
+
958
+ **Workspace only**: yes
959
+ **Description**: revert tagged or snapped versions for component(s)
960
+ https://bit.dev/docs/components/tags#undoing-a-tag
961
+
962
+ `bit reset [component-pattern] [component-version]`
963
+
964
+ | **Option** | **Option alias** | **Description** |
965
+ | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
966
+ | `--all` | `-a` | revert tag/snap for all tagged/snapped components |
967
+ | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
968
+ | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
969
+
970
+ ---
971
+
960
972
  ## run
961
973
 
962
974
  **Alias**: `c`
@@ -1132,8 +1144,8 @@ https://bit.dev/components/tags
1132
1144
  | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1133
1145
  | `--minor` | | syntactic sugar for "--increment minor" |
1134
1146
  | `--major` | | syntactic sugar for "--increment major" |
1147
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1135
1148
  | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1136
- | `--pre-release [identifier]` | | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead |
1137
1149
  | `--skip-tests` | | skip running component tests during tag process |
1138
1150
  | `--skip-auto-tag` | | skip auto tagging dependents |
1139
1151
  | `--soft` | | do not persist. only keep note of the changes to be made |
@@ -1217,23 +1229,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1217
1229
 
1218
1230
  ---
1219
1231
 
1220
- ## untag
1221
-
1222
- **Workspace only**: yes
1223
- **Description**: revert tagged or snapped versions for component(s)
1224
- https://bit.dev/docs/components/tags#undoing-a-tag
1225
- you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1226
-
1227
- `bit untag [component-name] [component-version]`
1228
-
1229
- | **Option** | **Option alias** | **Description** |
1230
- | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
1231
- | `--all` | `-a` | revert tag for all tagged components |
1232
- | `--soft` | | harmony - revert only soft-tags (components tagged with --soft flag) |
1233
- | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
1234
-
1235
- ---
1236
-
1237
1232
  ## update
1238
1233
 
1239
1234
  **Alias**: `up`
@@ -1253,7 +1248,7 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1253
1248
  **Workspace only**: yes
1254
1249
  **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1255
1250
 
1256
- `bit use [component-ids...]`
1251
+ `bit use <component-id>`
1257
1252
 
1258
1253
  ---
1259
1254
 
@@ -543,7 +543,7 @@
543
543
  "description": "revert tagged or snapped versions for component(s)",
544
544
  "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
545
545
  "group": "development",
546
- "private": false
546
+ "private": true
547
547
  },
548
548
  {
549
549
  "name": "move <current-component-dir> <new-component-dir>",
@@ -955,22 +955,6 @@
955
955
  "group": "general",
956
956
  "private": false
957
957
  },
958
- {
959
- "name": "use [component-ids...]",
960
- "alias": "",
961
- "options": [],
962
- "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
963
- "extendedDescription": "",
964
- "group": "collaborate",
965
- "private": false,
966
- "remoteOp": true,
967
- "arguments": [
968
- {
969
- "name": "component-ids...",
970
- "description": "the component IDs of the aspects"
971
- }
972
- ]
973
- },
974
958
  {
975
959
  "name": "show <component-name>",
976
960
  "alias": "",
@@ -1048,7 +1032,7 @@
1048
1032
  "arguments": [
1049
1033
  {
1050
1034
  "name": "component-pattern",
1051
- "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"
1035
+ "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"
1052
1036
  },
1053
1037
  {
1054
1038
  "name": "env",
@@ -1484,6 +1468,22 @@
1484
1468
  }
1485
1469
  ]
1486
1470
  },
1471
+ {
1472
+ "name": "use <component-id>",
1473
+ "alias": "",
1474
+ "options": [],
1475
+ "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
1476
+ "extendedDescription": "",
1477
+ "group": "collaborate",
1478
+ "private": false,
1479
+ "remoteOp": true,
1480
+ "arguments": [
1481
+ {
1482
+ "name": "component-id",
1483
+ "description": "the component ID of the aspect"
1484
+ }
1485
+ ]
1486
+ },
1487
1487
  {
1488
1488
  "name": "pattern <pattern>",
1489
1489
  "alias": "",
@@ -1497,7 +1497,29 @@
1497
1497
  "description": "list the component ids matching the given pattern",
1498
1498
  "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",
1499
1499
  "group": "development",
1500
- "private": false
1500
+ "private": false,
1501
+ "examples": [
1502
+ {
1503
+ "cmd": "bit pattern \"**\"",
1504
+ "description": "matches all components"
1505
+ },
1506
+ {
1507
+ "cmd": "bit pattern \"*/ui/*\"",
1508
+ "description": "matches components with any scope-name and the \"ui\" namespace. e.g. \"ui/button\" but not \"ui/elements/button\""
1509
+ },
1510
+ {
1511
+ "cmd": "bit pattern \"*/ui/**\"",
1512
+ "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
1513
+ },
1514
+ {
1515
+ "cmd": "bit pattern \"bar, foo\"",
1516
+ "description": "matches two components: bar and foo"
1517
+ },
1518
+ {
1519
+ "cmd": "bit pattern \"my-scope.org/**\"",
1520
+ "description": "matches all components of the scope \"my-scope.org\""
1521
+ }
1522
+ ]
1501
1523
  },
1502
1524
  {
1503
1525
  "name": "list [remote-scope]",
@@ -1803,7 +1825,7 @@
1803
1825
  ]
1804
1826
  },
1805
1827
  {
1806
- "name": "artifacts <pattern...>",
1828
+ "name": "artifacts <component-pattern>",
1807
1829
  "alias": "",
1808
1830
  "options": [
1809
1831
  [
@@ -1830,7 +1852,13 @@
1830
1852
  "description": "EXPERIMENTAL. list and download components artifacts",
1831
1853
  "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",
1832
1854
  "group": "development",
1833
- "private": false
1855
+ "private": false,
1856
+ "arguments": [
1857
+ {
1858
+ "name": "component-pattern",
1859
+ "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"
1860
+ }
1861
+ ]
1834
1862
  },
1835
1863
  {
1836
1864
  "name": "pack <componentId> [scopePath]",
@@ -1998,13 +2026,13 @@
1998
2026
  ],
1999
2027
  [
2000
2028
  "",
2001
- "snapped",
2002
- "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2029
+ "pre-release [identifier]",
2030
+ "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
2003
2031
  ],
2004
2032
  [
2005
2033
  "",
2006
- "pre-release [identifier]",
2007
- "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
2034
+ "snapped",
2035
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2008
2036
  ],
2009
2037
  [
2010
2038
  "",
@@ -2161,6 +2189,41 @@
2161
2189
  }
2162
2190
  ]
2163
2191
  },
2192
+ {
2193
+ "name": "reset [component-pattern] [component-version]",
2194
+ "alias": "",
2195
+ "options": [
2196
+ [
2197
+ "a",
2198
+ "all",
2199
+ "revert tag/snap for all tagged/snapped components"
2200
+ ],
2201
+ [
2202
+ "",
2203
+ "soft",
2204
+ "revert only soft-tags (components tagged with --soft flag)"
2205
+ ],
2206
+ [
2207
+ "f",
2208
+ "force",
2209
+ "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
2210
+ ]
2211
+ ],
2212
+ "description": "revert tagged or snapped versions for component(s)",
2213
+ "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
2214
+ "group": "development",
2215
+ "private": false,
2216
+ "arguments": [
2217
+ {
2218
+ "name": "component-pattern",
2219
+ "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"
2220
+ },
2221
+ {
2222
+ "name": "component-version",
2223
+ "description": "the version to untag (semver for tags. hash for snaps)"
2224
+ }
2225
+ ]
2226
+ },
2164
2227
  {
2165
2228
  "name": "merge [values...]",
2166
2229
  "alias": "",
@@ -3122,7 +3185,7 @@
3122
3185
  "remoteOp": true
3123
3186
  },
3124
3187
  {
3125
- "name": "export [remote] [component-names...]",
3188
+ "name": "export [component-names...]",
3126
3189
  "alias": "e",
3127
3190
  "options": [
3128
3191
  [
@@ -3135,26 +3198,6 @@
3135
3198
  "all",
3136
3199
  "export all components, including non-staged"
3137
3200
  ],
3138
- [
3139
- "d",
3140
- "include-dependencies",
3141
- "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
3142
- ],
3143
- [
3144
- "s",
3145
- "set-current-scope",
3146
- "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
3147
- ],
3148
- [
3149
- "r",
3150
- "rewire",
3151
- "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
3152
- ],
3153
- [
3154
- "f",
3155
- "force",
3156
- "force changing a component remote without asking for a confirmation"
3157
- ],
3158
3201
  [
3159
3202
  "",
3160
3203
  "all-versions",
@@ -3187,10 +3230,6 @@
3187
3230
  "private": false,
3188
3231
  "remoteOp": true,
3189
3232
  "arguments": [
3190
- {
3191
- "name": "remote",
3192
- "description": "LEGACY ONLY."
3193
- },
3194
3233
  {
3195
3234
  "name": "component-names...",
3196
3235
  "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."