@teambit/harmony.content.cli-reference 2.0.206 → 2.0.208

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.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.91'
2
+ description: 'Bit command synopses. Bit version: 1.6.93'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -379,12 +379,12 @@
379
379
  "archive the workspace including diagnosis info (by default exclude node-modules and include .bit)"
380
380
  ],
381
381
  [
382
- "",
382
+ "n",
383
383
  "include-node-modules",
384
384
  "relevant for --archive. include node_modules in the archive file"
385
385
  ],
386
386
  [
387
- "",
387
+ "e",
388
388
  "exclude-local-scope",
389
389
  "relevant for --archive. exclude .bit or .git/bit from the archive file"
390
390
  ]
@@ -3534,7 +3534,12 @@
3534
3534
  [
3535
3535
  "a",
3536
3536
  "get-all",
3537
- "checkout all components in a lane, including those not currently in the workspace"
3537
+ "DEPRECATED. this is currently the default behavior"
3538
+ ],
3539
+ [
3540
+ "a",
3541
+ "workspace-only",
3542
+ "checkout only the components in the workspace to the selected lane"
3538
3543
  ],
3539
3544
  [
3540
3545
  "x",
@@ -3800,6 +3805,21 @@
3800
3805
  }
3801
3806
  ]
3802
3807
  },
3808
+ {
3809
+ "name": "fetch [lane-id]",
3810
+ "alias": "",
3811
+ "options": [
3812
+ [
3813
+ "a",
3814
+ "all",
3815
+ "fetch all remote lanes"
3816
+ ]
3817
+ ],
3818
+ "description": "fetch component objects from lanes. if no lane-id is provided, it fetches from the current lane",
3819
+ "extendedDescription": "note, it does not save the remote lanes objects locally, only the refs",
3820
+ "group": "ungrouped",
3821
+ "private": false
3822
+ },
3803
3823
  {
3804
3824
  "name": "merge <lane> [pattern]",
3805
3825
  "alias": "",
@@ -3964,7 +3984,12 @@
3964
3984
  [
3965
3985
  "a",
3966
3986
  "get-all",
3967
- "checkout all components in a lane, including those not currently in the workspace"
3987
+ "DEPRECATED. this is currently the default behavior"
3988
+ ],
3989
+ [
3990
+ "a",
3991
+ "workspace-only",
3992
+ "checkout only the components in the workspace to the selected lane"
3968
3993
  ],
3969
3994
  [
3970
3995
  "x",
package/cli-reference.mdx CHANGED
@@ -632,8 +632,8 @@ this command marks the components as deleted, and after snap/tag and export they
632
632
  | `--list` | | list all available diagnoses |
633
633
  | `--save [filePath]` | `-s` | save diagnoses to a file |
634
634
  | `--archive [filePath]` | `-a` | archive the workspace including diagnosis info (by default exclude node-modules and include .bit) |
635
- | `--include-node-modules` | | relevant for --archive. include node_modules in the archive file |
636
- | `--exclude-local-scope` | | relevant for --archive. exclude .bit or .git/bit from the archive file |
635
+ | `--include-node-modules` | `-n` | relevant for --archive. include node_modules in the archive file |
636
+ | `--exclude-local-scope` | `-e` | relevant for --archive. exclude .bit or .git/bit from the archive file |
637
637
 
638
638
  ---
639
639
 
@@ -1021,7 +1021,8 @@ when no package is specified, all workspace dependencies are installed and all w
1021
1021
  | -------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1022
1022
  | `--alias <string>` | `-n` | 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 |
1023
1023
  | `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
1024
- | `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
1024
+ | `--get-all` | `-a` | DEPRECATED. this is currently the default behavior |
1025
+ | `--workspace-only` | `-a` | checkout only the components in the workspace to the selected lane |
1025
1026
  | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1026
1027
  | `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1027
1028
  | `--json` | `-j` | return the output as JSON |
@@ -1167,6 +1168,17 @@ bit lane diff from to => diff between "from" lane and "to" lane.
1167
1168
  | `--workspace-only` | | do not mark the components as removed from the lane. instead, remove them from the workspace only |
1168
1169
  | `--update-main` | | EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main |
1169
1170
 
1171
+ ### lane fetch
1172
+
1173
+ **Usage**: `lane fetch [lane-id]`
1174
+
1175
+ **Description**: fetch component objects from lanes. if no lane-id is provided, it fetches from the current lane
1176
+ note, it does not save the remote lanes objects locally, only the refs
1177
+
1178
+ | **Option** | **Option alias** | **Description** |
1179
+ | ---------- | :--------------: | ---------------------- |
1180
+ | `--all` | `-a` | fetch all remote lanes |
1181
+
1170
1182
  ### lane merge
1171
1183
 
1172
1184
  **Usage**: `lane merge <lane> [pattern]`
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.91'
2
+ description: 'Bit command synopses. Bit version: 1.6.93'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -379,12 +379,12 @@
379
379
  "archive the workspace including diagnosis info (by default exclude node-modules and include .bit)"
380
380
  ],
381
381
  [
382
- "",
382
+ "n",
383
383
  "include-node-modules",
384
384
  "relevant for --archive. include node_modules in the archive file"
385
385
  ],
386
386
  [
387
- "",
387
+ "e",
388
388
  "exclude-local-scope",
389
389
  "relevant for --archive. exclude .bit or .git/bit from the archive file"
390
390
  ]
@@ -3534,7 +3534,12 @@
3534
3534
  [
3535
3535
  "a",
3536
3536
  "get-all",
3537
- "checkout all components in a lane, including those not currently in the workspace"
3537
+ "DEPRECATED. this is currently the default behavior"
3538
+ ],
3539
+ [
3540
+ "a",
3541
+ "workspace-only",
3542
+ "checkout only the components in the workspace to the selected lane"
3538
3543
  ],
3539
3544
  [
3540
3545
  "x",
@@ -3800,6 +3805,21 @@
3800
3805
  }
3801
3806
  ]
3802
3807
  },
3808
+ {
3809
+ "name": "fetch [lane-id]",
3810
+ "alias": "",
3811
+ "options": [
3812
+ [
3813
+ "a",
3814
+ "all",
3815
+ "fetch all remote lanes"
3816
+ ]
3817
+ ],
3818
+ "description": "fetch component objects from lanes. if no lane-id is provided, it fetches from the current lane",
3819
+ "extendedDescription": "note, it does not save the remote lanes objects locally, only the refs",
3820
+ "group": "ungrouped",
3821
+ "private": false
3822
+ },
3803
3823
  {
3804
3824
  "name": "merge <lane> [pattern]",
3805
3825
  "alias": "",
@@ -3964,7 +3984,12 @@
3964
3984
  [
3965
3985
  "a",
3966
3986
  "get-all",
3967
- "checkout all components in a lane, including those not currently in the workspace"
3987
+ "DEPRECATED. this is currently the default behavior"
3988
+ ],
3989
+ [
3990
+ "a",
3991
+ "workspace-only",
3992
+ "checkout only the components in the workspace to the selected lane"
3968
3993
  ],
3969
3994
  [
3970
3995
  "x",
@@ -3074,7 +3074,9 @@ function MDXContent(_ref) {
3074
3074
  }, "--include-node-modules")), (0, _react2.mdx)("td", {
3075
3075
  parentName: "tr",
3076
3076
  "align": "center"
3077
- }), (0, _react2.mdx)("td", {
3077
+ }, (0, _react2.mdx)("inlineCode", {
3078
+ parentName: "td"
3079
+ }, "-n")), (0, _react2.mdx)("td", {
3078
3080
  parentName: "tr",
3079
3081
  "align": null
3080
3082
  }, "relevant for --archive. include node_modules in the archive file")), (0, _react2.mdx)("tr", {
@@ -3087,7 +3089,9 @@ function MDXContent(_ref) {
3087
3089
  }, "--exclude-local-scope")), (0, _react2.mdx)("td", {
3088
3090
  parentName: "tr",
3089
3091
  "align": "center"
3090
- }), (0, _react2.mdx)("td", {
3092
+ }, (0, _react2.mdx)("inlineCode", {
3093
+ parentName: "td"
3094
+ }, "-e")), (0, _react2.mdx)("td", {
3091
3095
  parentName: "tr",
3092
3096
  "align": null
3093
3097
  }, "relevant for --archive. exclude .bit or .git/bit from the archive file")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "eject"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
@@ -5283,7 +5287,22 @@ function MDXContent(_ref) {
5283
5287
  }, "-a")), (0, _react2.mdx)("td", {
5284
5288
  parentName: "tr",
5285
5289
  "align": null
5286
- }, "checkout all components in a lane, including those not currently in the workspace")), (0, _react2.mdx)("tr", {
5290
+ }, "DEPRECATED. this is currently the default behavior")), (0, _react2.mdx)("tr", {
5291
+ parentName: "tbody"
5292
+ }, (0, _react2.mdx)("td", {
5293
+ parentName: "tr",
5294
+ "align": null
5295
+ }, (0, _react2.mdx)("inlineCode", {
5296
+ parentName: "td"
5297
+ }, "--workspace-only")), (0, _react2.mdx)("td", {
5298
+ parentName: "tr",
5299
+ "align": "center"
5300
+ }, (0, _react2.mdx)("inlineCode", {
5301
+ parentName: "td"
5302
+ }, "-a")), (0, _react2.mdx)("td", {
5303
+ parentName: "tr",
5304
+ "align": null
5305
+ }, "checkout only the components in the workspace to the selected lane")), (0, _react2.mdx)("tr", {
5287
5306
  parentName: "tbody"
5288
5307
  }, (0, _react2.mdx)("td", {
5289
5308
  parentName: "tr",
@@ -5998,7 +6017,51 @@ function MDXContent(_ref) {
5998
6017
  }), (0, _react2.mdx)("td", {
5999
6018
  parentName: "tr",
6000
6019
  "align": null
6001
- }, "EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main")))), (0, _react2.mdx)("h3", null, "lane merge"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6020
+ }, "EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main")))), (0, _react2.mdx)("h3", null, "lane fetch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6021
+ parentName: "p"
6022
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
6023
+ parentName: "p"
6024
+ }, "lane fetch [lane-id]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6025
+ parentName: "p"
6026
+ }, "Description"), ": fetch component objects from lanes. if no lane-id is provided, it fetches from the current lane", (0, _react2.mdx)("br", {
6027
+ parentName: "p"
6028
+ }), "\n", "note, it does not save the remote lanes objects locally, only the refs"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
6029
+ parentName: "table"
6030
+ }, (0, _react2.mdx)("tr", {
6031
+ parentName: "thead"
6032
+ }, (0, _react2.mdx)("th", {
6033
+ parentName: "tr",
6034
+ "align": null
6035
+ }, (0, _react2.mdx)("strong", {
6036
+ parentName: "th"
6037
+ }, "Option")), (0, _react2.mdx)("th", {
6038
+ parentName: "tr",
6039
+ "align": "center"
6040
+ }, (0, _react2.mdx)("strong", {
6041
+ parentName: "th"
6042
+ }, "Option alias")), (0, _react2.mdx)("th", {
6043
+ parentName: "tr",
6044
+ "align": null
6045
+ }, (0, _react2.mdx)("strong", {
6046
+ parentName: "th"
6047
+ }, "Description")))), (0, _react2.mdx)("tbody", {
6048
+ parentName: "table"
6049
+ }, (0, _react2.mdx)("tr", {
6050
+ parentName: "tbody"
6051
+ }, (0, _react2.mdx)("td", {
6052
+ parentName: "tr",
6053
+ "align": null
6054
+ }, (0, _react2.mdx)("inlineCode", {
6055
+ parentName: "td"
6056
+ }, "--all")), (0, _react2.mdx)("td", {
6057
+ parentName: "tr",
6058
+ "align": "center"
6059
+ }, (0, _react2.mdx)("inlineCode", {
6060
+ parentName: "td"
6061
+ }, "-a")), (0, _react2.mdx)("td", {
6062
+ parentName: "tr",
6063
+ "align": null
6064
+ }, "fetch all remote lanes")))), (0, _react2.mdx)("h3", null, "lane merge"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6002
6065
  parentName: "p"
6003
6066
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
6004
6067
  parentName: "p"