@teambit/harmony.content.cli-reference 1.95.42 → 1.95.45

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.
@@ -1458,7 +1458,7 @@
1458
1458
  "skipWorkspace": true
1459
1459
  },
1460
1460
  {
1461
- "name": "import [component-ids...]",
1461
+ "name": "import [component-patterns...]",
1462
1462
  "alias": "",
1463
1463
  "options": [
1464
1464
  [
@@ -1532,15 +1532,15 @@
1532
1532
  "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
1533
1533
  ]
1534
1534
  ],
1535
- "description": "import components from remote scopes to the local workspace",
1535
+ "description": "import components from their remote scopes to the local workspace",
1536
1536
  "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)",
1537
1537
  "group": "collaborate",
1538
1538
  "private": false,
1539
1539
  "remoteOp": true,
1540
1540
  "arguments": [
1541
1541
  {
1542
- "name": "component-ids...",
1543
- "description": "a list of component IDs (separated by space) to import"
1542
+ "name": "component-patterns...",
1543
+ "description": "component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., \"utils/*\" (wrap with double quotes)"
1544
1544
  }
1545
1545
  ]
1546
1546
  },
@@ -2005,7 +2005,7 @@
2005
2005
  ]
2006
2006
  ],
2007
2007
  "description": "create an immutable and exportable component snapshot, tagged with a release version.",
2008
- "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags",
2008
+ "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
2009
2009
  "group": "development",
2010
2010
  "private": false,
2011
2011
  "remoteOp": true,
@@ -2089,7 +2089,7 @@
2089
2089
  ]
2090
2090
  },
2091
2091
  {
2092
- "name": "reset [component-pattern] [component-version]",
2092
+ "name": "reset [component-pattern]",
2093
2093
  "alias": "",
2094
2094
  "options": [
2095
2095
  [
@@ -2097,6 +2097,11 @@
2097
2097
  "all",
2098
2098
  "revert tag/snap for all tagged/snapped components"
2099
2099
  ],
2100
+ [
2101
+ "",
2102
+ "head",
2103
+ "revert the head tag/snap only (by default, all local tags/snaps are reverted)"
2104
+ ],
2100
2105
  [
2101
2106
  "",
2102
2107
  "soft",
@@ -3116,7 +3121,7 @@
3116
3121
  "remoteOp": true
3117
3122
  },
3118
3123
  {
3119
- "name": "export [component-names...]",
3124
+ "name": "export [component-patterns...]",
3120
3125
  "alias": "e",
3121
3126
  "options": [
3122
3127
  [
@@ -3127,12 +3132,12 @@
3127
3132
  [
3128
3133
  "a",
3129
3134
  "all",
3130
- "export all components, including non-staged"
3135
+ "export all components, including non-staged (useful when components in the remote scope are corrupted or missing)"
3131
3136
  ],
3132
3137
  [
3133
3138
  "",
3134
3139
  "all-versions",
3135
- "export not only staged versions but all of them"
3140
+ "export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing)"
3136
3141
  ],
3137
3142
  [
3138
3143
  "",
@@ -3162,8 +3167,8 @@
3162
3167
  "remoteOp": true,
3163
3168
  "arguments": [
3164
3169
  {
3165
- "name": "component-names...",
3166
- "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
3170
+ "name": "component-patterns...",
3171
+ "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)"
3167
3172
  }
3168
3173
  ]
3169
3174
  },
package/cli-reference.mdx CHANGED
@@ -517,13 +517,13 @@ bit export => export all staged components to their current scope, if checked ou
517
517
  https://bit.dev/docs/components/exporting-components
518
518
  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)
519
519
 
520
- `bit export [component-names...]`
520
+ `bit export [component-patterns...]`
521
521
 
522
522
  | **Option** | **Option alias** | **Description** |
523
523
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
524
524
  | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
525
- | `--all` | `-a` | export all components, including non-staged |
526
- | `--all-versions` | | export not only staged versions but all of them |
525
+ | `--all` | `-a` | export all components, including non-staged (useful when components in the remote scope are corrupted or missing) |
526
+ | `--all-versions` | | export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing) |
527
527
  | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
528
528
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
529
529
  | `--ignore-missing-artifacts` | | EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote |
@@ -604,11 +604,11 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
604
604
  ## import
605
605
 
606
606
  **Workspace only**: yes
607
- **Description**: import components from remote scopes to the local workspace
607
+ **Description**: import components from their remote scopes to the local workspace
608
608
  https://bit.dev/docs/components/importing-components
609
609
  you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
610
610
 
611
- `bit import [component-ids...]`
611
+ `bit import [component-patterns...]`
612
612
 
613
613
  | **Option** | **Option alias** | **Description** |
614
614
  | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -954,11 +954,12 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
954
954
  **Description**: revert tagged or snapped versions for component(s)
955
955
  https://bit.dev/docs/components/tags#undoing-a-tag
956
956
 
957
- `bit reset [component-pattern] [component-version]`
957
+ `bit reset [component-pattern]`
958
958
 
959
959
  | **Option** | **Option alias** | **Description** |
960
960
  | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
961
961
  | `--all` | `-a` | revert tag/snap for all tagged/snapped components |
962
+ | `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
962
963
  | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
963
964
  | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
964
965
 
@@ -1124,8 +1125,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1124
1125
  **Workspace only**: yes
1125
1126
  **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1126
1127
  if no patterns are provided, it will tag all new and modified components.
1127
- if patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
1128
- https://bit.dev/components/tags
1128
+ if patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
1129
1129
 
1130
1130
  `bit tag [component-patterns...]`
1131
1131
 
@@ -1458,7 +1458,7 @@
1458
1458
  "skipWorkspace": true
1459
1459
  },
1460
1460
  {
1461
- "name": "import [component-ids...]",
1461
+ "name": "import [component-patterns...]",
1462
1462
  "alias": "",
1463
1463
  "options": [
1464
1464
  [
@@ -1532,15 +1532,15 @@
1532
1532
  "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
1533
1533
  ]
1534
1534
  ],
1535
- "description": "import components from remote scopes to the local workspace",
1535
+ "description": "import components from their remote scopes to the local workspace",
1536
1536
  "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)",
1537
1537
  "group": "collaborate",
1538
1538
  "private": false,
1539
1539
  "remoteOp": true,
1540
1540
  "arguments": [
1541
1541
  {
1542
- "name": "component-ids...",
1543
- "description": "a list of component IDs (separated by space) to import"
1542
+ "name": "component-patterns...",
1543
+ "description": "component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., \"utils/*\" (wrap with double quotes)"
1544
1544
  }
1545
1545
  ]
1546
1546
  },
@@ -2005,7 +2005,7 @@
2005
2005
  ]
2006
2006
  ],
2007
2007
  "description": "create an immutable and exportable component snapshot, tagged with a release version.",
2008
- "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags",
2008
+ "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
2009
2009
  "group": "development",
2010
2010
  "private": false,
2011
2011
  "remoteOp": true,
@@ -2089,7 +2089,7 @@
2089
2089
  ]
2090
2090
  },
2091
2091
  {
2092
- "name": "reset [component-pattern] [component-version]",
2092
+ "name": "reset [component-pattern]",
2093
2093
  "alias": "",
2094
2094
  "options": [
2095
2095
  [
@@ -2097,6 +2097,11 @@
2097
2097
  "all",
2098
2098
  "revert tag/snap for all tagged/snapped components"
2099
2099
  ],
2100
+ [
2101
+ "",
2102
+ "head",
2103
+ "revert the head tag/snap only (by default, all local tags/snaps are reverted)"
2104
+ ],
2100
2105
  [
2101
2106
  "",
2102
2107
  "soft",
@@ -3116,7 +3121,7 @@
3116
3121
  "remoteOp": true
3117
3122
  },
3118
3123
  {
3119
- "name": "export [component-names...]",
3124
+ "name": "export [component-patterns...]",
3120
3125
  "alias": "e",
3121
3126
  "options": [
3122
3127
  [
@@ -3127,12 +3132,12 @@
3127
3132
  [
3128
3133
  "a",
3129
3134
  "all",
3130
- "export all components, including non-staged"
3135
+ "export all components, including non-staged (useful when components in the remote scope are corrupted or missing)"
3131
3136
  ],
3132
3137
  [
3133
3138
  "",
3134
3139
  "all-versions",
3135
- "export not only staged versions but all of them"
3140
+ "export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing)"
3136
3141
  ],
3137
3142
  [
3138
3143
  "",
@@ -3162,8 +3167,8 @@
3162
3167
  "remoteOp": true,
3163
3168
  "arguments": [
3164
3169
  {
3165
- "name": "component-names...",
3166
- "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
3170
+ "name": "component-patterns...",
3171
+ "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)"
3167
3172
  }
3168
3173
  ]
3169
3174
  },
@@ -1998,7 +1998,7 @@ function MDXContent(_ref) {
1998
1998
  parentName: "p"
1999
1999
  }), "\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)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2000
2000
  parentName: "p"
2001
- }, "bit export [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2001
+ }, "bit export [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2002
2002
  parentName: "table"
2003
2003
  }, (0, _react2.mdx)("tr", {
2004
2004
  parentName: "thead"
@@ -2049,7 +2049,7 @@ function MDXContent(_ref) {
2049
2049
  }, "-a")), (0, _react2.mdx)("td", {
2050
2050
  parentName: "tr",
2051
2051
  "align": null
2052
- }, "export all components, including non-staged")), (0, _react2.mdx)("tr", {
2052
+ }, "export all components, including non-staged (useful when components in the remote scope are corrupted or missing)")), (0, _react2.mdx)("tr", {
2053
2053
  parentName: "tbody"
2054
2054
  }, (0, _react2.mdx)("td", {
2055
2055
  parentName: "tr",
@@ -2062,7 +2062,7 @@ function MDXContent(_ref) {
2062
2062
  }), (0, _react2.mdx)("td", {
2063
2063
  parentName: "tr",
2064
2064
  "align": null
2065
- }, "export not only staged versions but all of them")), (0, _react2.mdx)("tr", {
2065
+ }, "export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing)")), (0, _react2.mdx)("tr", {
2066
2066
  parentName: "tbody"
2067
2067
  }, (0, _react2.mdx)("td", {
2068
2068
  parentName: "tr",
@@ -2426,7 +2426,7 @@ function MDXContent(_ref) {
2426
2426
  parentName: "p"
2427
2427
  }), "\n", (0, _react2.mdx)("strong", {
2428
2428
  parentName: "p"
2429
- }, "Description"), ": import components from remote scopes to the local workspace", (0, _react2.mdx)("br", {
2429
+ }, "Description"), ": import components from their remote scopes to the local workspace", (0, _react2.mdx)("br", {
2430
2430
  parentName: "p"
2431
2431
  }), "\n", (0, _react2.mdx)("a", {
2432
2432
  parentName: "p",
@@ -2435,7 +2435,7 @@ function MDXContent(_ref) {
2435
2435
  parentName: "p"
2436
2436
  }), "\n", "you can use a pattern for multiple ids, such as bit import \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2437
2437
  parentName: "p"
2438
- }, "bit import [component-ids...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2438
+ }, "bit import [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2439
2439
  parentName: "table"
2440
2440
  }, (0, _react2.mdx)("tr", {
2441
2441
  parentName: "thead"
@@ -4293,7 +4293,7 @@ function MDXContent(_ref) {
4293
4293
  "href": "https://bit.dev/docs/components/tags#undoing-a-tag"
4294
4294
  }, "https://bit.dev/docs/components/tags#undoing-a-tag")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4295
4295
  parentName: "p"
4296
- }, "bit reset [component-pattern] [component-version]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4296
+ }, "bit reset [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4297
4297
  parentName: "table"
4298
4298
  }, (0, _react2.mdx)("tr", {
4299
4299
  parentName: "thead"
@@ -4336,6 +4336,19 @@ function MDXContent(_ref) {
4336
4336
  "align": null
4337
4337
  }, (0, _react2.mdx)("inlineCode", {
4338
4338
  parentName: "td"
4339
+ }, "--head")), (0, _react2.mdx)("td", {
4340
+ parentName: "tr",
4341
+ "align": "center"
4342
+ }), (0, _react2.mdx)("td", {
4343
+ parentName: "tr",
4344
+ "align": null
4345
+ }, "revert the head tag/snap only (by default, all local tags/snaps are reverted)")), (0, _react2.mdx)("tr", {
4346
+ parentName: "tbody"
4347
+ }, (0, _react2.mdx)("td", {
4348
+ parentName: "tr",
4349
+ "align": null
4350
+ }, (0, _react2.mdx)("inlineCode", {
4351
+ parentName: "td"
4339
4352
  }, "--soft")), (0, _react2.mdx)("td", {
4340
4353
  parentName: "tr",
4341
4354
  "align": "center"
@@ -4910,12 +4923,7 @@ function MDXContent(_ref) {
4910
4923
  }), "\n", "if patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag ", (0, _react2.mdx)("a", {
4911
4924
  parentName: "p",
4912
4925
  "href": "mailto:foo@1.0.0"
4913
- }, "foo@1.0.0"), " bar@minor baz@major", (0, _react2.mdx)("br", {
4914
- parentName: "p"
4915
- }), "\n", (0, _react2.mdx)("a", {
4916
- parentName: "p",
4917
- "href": "https://bit.dev/components/tags"
4918
- }, "https://bit.dev/components/tags")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4926
+ }, "foo@1.0.0"), " bar@minor baz@major"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4919
4927
  parentName: "p"
4920
4928
  }, "bit tag [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4921
4929
  parentName: "table"