@teambit/harmony.content.cli-reference 1.95.24 → 1.95.25

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.
Files changed (11) hide show
  1. package/cli-reference.json +3007 -0
  2. package/cli-reference.mdx +41 -50
  3. package/dist/cli-reference.json +3007 -0
  4. package/dist/cli-reference.mdx.js +58 -48
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/dist/tsconfig.json +29 -0
  7. package/package-tar/teambit-harmony.content.cli-reference-1.95.25.tgz +0 -0
  8. package/package.json +2 -2
  9. package/{preview-1653535588073.js → preview-1654572446572.js} +2 -2
  10. package/tsconfig.json +7 -1
  11. package/package-tar/teambit-harmony.content.cli-reference-1.95.24.tgz +0 -0
package/dist/cli-reference.mdx.js CHANGED
@@ -32,7 +32,7 @@ function MDXContent(_ref) {
32
32
  return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
33
33
  components: components,
34
34
  mdxType: "MDXLayout"
35
- }), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("p", null, "id: cli-all"), (0, _react2.mdx)("h2", null, "title: CLI Commands"), (0, _react2.mdx)("h1", null, "CLI Reference"), (0, _react2.mdx)("p", null, "Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server."), (0, _react2.mdx)("h2", null, "add"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
35
+ }), (0, _react2.mdx)("h1", null, "CLI Reference"), (0, _react2.mdx)("p", null, "Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server."), (0, _react2.mdx)("h2", null, "add"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
36
36
  parentName: "p"
37
37
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
38
38
  parentName: "p"
@@ -44,7 +44,7 @@ function MDXContent(_ref) {
44
44
  parentName: "p"
45
45
  }), "\n", (0, _react2.mdx)("strong", {
46
46
  parentName: "p"
47
- }, "Description"), ": add any subset of files to be tracked as a component(s)", (0, _react2.mdx)("br", {
47
+ }, "Description"), ": Add any subset of files to be tracked as a component(s).", (0, _react2.mdx)("br", {
48
48
  parentName: "p"
49
49
  }), "\n", "all flags support glob patterns and {PARENT} {FILE_NAME} annotations", (0, _react2.mdx)("br", {
50
50
  parentName: "p"
@@ -235,7 +235,7 @@ function MDXContent(_ref) {
235
235
  parentName: "p"
236
236
  }), "\n", (0, _react2.mdx)("strong", {
237
237
  parentName: "p"
238
- }, "Description"), ": EXPERIMENTAL. list and download components artifacts.", (0, _react2.mdx)("br", {
238
+ }, "Description"), ": EXPERIMENTAL. list and download components artifacts", (0, _react2.mdx)("br", {
239
239
  parentName: "p"
240
240
  }), "\n", "artifacts are created on isolated capsules during tag or snap commands.", (0, _react2.mdx)("br", {
241
241
  parentName: "p"
@@ -645,7 +645,7 @@ function MDXContent(_ref) {
645
645
  parentName: "p"
646
646
  }), "\n", (0, _react2.mdx)("strong", {
647
647
  parentName: "p"
648
- }, "Description"), ": manage capsules.", (0, _react2.mdx)("br", {
648
+ }, "Description"), ": manage capsules", (0, _react2.mdx)("br", {
649
649
  parentName: "p"
650
650
  }), "\n", "a capsule is a directory contains the component code, isolated from the workspace.", (0, _react2.mdx)("br", {
651
651
  parentName: "p"
@@ -850,7 +850,9 @@ function MDXContent(_ref) {
850
850
  parentName: "p"
851
851
  }, "capsule delete")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
852
852
  parentName: "p"
853
- }, "Description"), ": delete capsules. with no args, only workspace's capsules are deleted"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
853
+ }, "Description"), ": delete capsules", (0, _react2.mdx)("br", {
854
+ parentName: "p"
855
+ }), "\n", "with no args, only workspace's capsules are deleted"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
854
856
  parentName: "table"
855
857
  }, (0, _react2.mdx)("tr", {
856
858
  parentName: "thead"
@@ -968,15 +970,17 @@ function MDXContent(_ref) {
968
970
  parentName: "p"
969
971
  }), "\n", (0, _react2.mdx)("strong", {
970
972
  parentName: "p"
971
- }, "Description"), ": switch between component versions or remove local changes", (0, _react2.mdx)("br", {
973
+ }, "Description"), ": switch between component versions or remove local changes"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
974
+ parentName: "p"
975
+ }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
972
976
  parentName: "p"
973
977
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
974
978
  parentName: "p"
975
- }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
979
+ }, "bit checkout latest"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
976
980
  parentName: "p"
977
981
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
978
982
  parentName: "p"
979
- }, "bit checkout latest [ids...]"), " => checkout the specified ids (or all components when --all is used) to their latest versions", (0, _react2.mdx)("br", {
983
+ }, "bit checkout latest [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
980
984
  parentName: "p"
981
985
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
982
986
  parentName: "p"
@@ -1286,7 +1290,22 @@ function MDXContent(_ref) {
1286
1290
  }), (0, _react2.mdx)("td", {
1287
1291
  parentName: "tr",
1288
1292
  "align": null
1289
- }, "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1293
+ }, "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands")), (0, _react2.mdx)("tr", {
1294
+ parentName: "tbody"
1295
+ }, (0, _react2.mdx)("td", {
1296
+ parentName: "tr",
1297
+ "align": null
1298
+ }, (0, _react2.mdx)("inlineCode", {
1299
+ parentName: "td"
1300
+ }, "--json")), (0, _react2.mdx)("td", {
1301
+ parentName: "tr",
1302
+ "align": "center"
1303
+ }, (0, _react2.mdx)("inlineCode", {
1304
+ parentName: "td"
1305
+ }, "-j")), (0, _react2.mdx)("td", {
1306
+ parentName: "tr",
1307
+ "align": null
1308
+ }, "output the commands info as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1290
1309
  parentName: "p"
1291
1310
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
1292
1311
  parentName: "p"
@@ -1433,9 +1452,9 @@ function MDXContent(_ref) {
1433
1452
  parentName: "p"
1434
1453
  }), "\n", (0, _react2.mdx)("strong", {
1435
1454
  parentName: "p"
1436
- }, "Description"), ": global config management.", (0, _react2.mdx)("br", {
1455
+ }, "Description"), ": global config management", (0, _react2.mdx)("br", {
1437
1456
  parentName: "p"
1438
- }), "\n", "", (0, _react2.mdx)("a", {
1457
+ }), "\n", (0, _react2.mdx)("a", {
1439
1458
  parentName: "p",
1440
1459
  "href": "https://bit.dev/docs/config/bit-config"
1441
1460
  }, "https://bit.dev/docs/config/bit-config")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -2054,7 +2073,7 @@ function MDXContent(_ref) {
2054
2073
  parentName: "p"
2055
2074
  }), "\n", (0, _react2.mdx)("strong", {
2056
2075
  parentName: "p"
2057
- }, "Description"), ": export components to a remote scope.", (0, _react2.mdx)("br", {
2076
+ }, "Description"), ": Export components to a remote scope", (0, _react2.mdx)("br", {
2058
2077
  parentName: "p"
2059
2078
  }), "\n", "bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well", (0, _react2.mdx)("br", {
2060
2079
  parentName: "p"
@@ -2546,7 +2565,7 @@ function MDXContent(_ref) {
2546
2565
  parentName: "p"
2547
2566
  }), "\n", (0, _react2.mdx)("strong", {
2548
2567
  parentName: "p"
2549
- }, "Description"), ": import components into your current workspace.", (0, _react2.mdx)("br", {
2568
+ }, "Description"), ": import components into your workspace", (0, _react2.mdx)("br", {
2550
2569
  parentName: "p"
2551
2570
  }), "\n", (0, _react2.mdx)("a", {
2552
2571
  parentName: "p",
@@ -2778,7 +2797,7 @@ function MDXContent(_ref) {
2778
2797
  parentName: "p"
2779
2798
  }), "\n", (0, _react2.mdx)("strong", {
2780
2799
  parentName: "p"
2781
- }, "Description"), ": initialize an empty bit scope", (0, _react2.mdx)("br", {
2800
+ }, "Description"), ": create or reinitialize an empty workspace", (0, _react2.mdx)("br", {
2782
2801
  parentName: "p"
2783
2802
  }), "\n", (0, _react2.mdx)("a", {
2784
2803
  parentName: "p",
@@ -3103,7 +3122,7 @@ function MDXContent(_ref) {
3103
3122
  parentName: "p"
3104
3123
  }), "\n", (0, _react2.mdx)("strong", {
3105
3124
  parentName: "p"
3106
- }, "Description"), ": generate symlinks to resolve module paths for imported components.", (0, _react2.mdx)("br", {
3125
+ }, "Description"), ": link components and core aspects", (0, _react2.mdx)("br", {
3107
3126
  parentName: "p"
3108
3127
  }), "\n", (0, _react2.mdx)("a", {
3109
3128
  parentName: "p",
@@ -3299,9 +3318,9 @@ function MDXContent(_ref) {
3299
3318
  parentName: "p"
3300
3319
  }), "\n", (0, _react2.mdx)("strong", {
3301
3320
  parentName: "p"
3302
- }, "Description"), ": list components on a local or a remote scope.", (0, _react2.mdx)("br", {
3321
+ }, "Description"), ": list components on a workspace, local scope or a remote scope.", (0, _react2.mdx)("br", {
3303
3322
  parentName: "p"
3304
- }), "\n", "", (0, _react2.mdx)("a", {
3323
+ }), "\n", (0, _react2.mdx)("a", {
3305
3324
  parentName: "p",
3306
3325
  "href": "https://bit.dev/docs/reference/cli-reference#list"
3307
3326
  }, "https://bit.dev/docs/reference/cli-reference#list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -3438,9 +3457,9 @@ function MDXContent(_ref) {
3438
3457
  parentName: "p"
3439
3458
  }), "\n", (0, _react2.mdx)("strong", {
3440
3459
  parentName: "p"
3441
- }, "Description"), ": show components(s) tag history.", (0, _react2.mdx)("br", {
3460
+ }, "Description"), ": show components(s) version history", (0, _react2.mdx)("br", {
3442
3461
  parentName: "p"
3443
- }), "\n", "", (0, _react2.mdx)("a", {
3462
+ }), "\n", (0, _react2.mdx)("a", {
3444
3463
  parentName: "p",
3445
3464
  "href": "https://bit.dev/docs/reference/cli-reference#log"
3446
3465
  }, "https://bit.dev/docs/reference/cli-reference#log")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -3606,6 +3625,8 @@ function MDXContent(_ref) {
3606
3625
  parentName: "p"
3607
3626
  }, "Description"), ": merge changes of different component versions", (0, _react2.mdx)("br", {
3608
3627
  parentName: "p"
3628
+ }), "\n", "merge changes of different component versions", (0, _react2.mdx)("br", {
3629
+ parentName: "p"
3609
3630
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
3610
3631
  parentName: "p"
3611
3632
  }, "bit merge <version> [ids...]"), " => merge changes of the given version into the checked out version", (0, _react2.mdx)("br", {
@@ -3755,7 +3776,9 @@ function MDXContent(_ref) {
3755
3776
  parentName: "p"
3756
3777
  }), "\n", (0, _react2.mdx)("strong", {
3757
3778
  parentName: "p"
3758
- }, "Description"), ": move files or directories of component(s)", (0, _react2.mdx)("br", {
3779
+ }, "Description"), ": move a component to a different filesystem path", (0, _react2.mdx)("br", {
3780
+ parentName: "p"
3781
+ }), "\n", "move files or directories of component(s)", (0, _react2.mdx)("br", {
3759
3782
  parentName: "p"
3760
3783
  }), "\n", "", (0, _react2.mdx)("a", {
3761
3784
  parentName: "p",
@@ -4091,7 +4114,7 @@ function MDXContent(_ref) {
4091
4114
  parentName: "p"
4092
4115
  }, "Description"), ": manage set of tracked bit scope(s)", (0, _react2.mdx)("br", {
4093
4116
  parentName: "p"
4094
- }), "\n", "", (0, _react2.mdx)("a", {
4117
+ }), "\n", (0, _react2.mdx)("a", {
4095
4118
  parentName: "p",
4096
4119
  "href": "https://bit.dev/docs/scope/remote-scopes"
4097
4120
  }, "https://bit.dev/docs/scope/remote-scopes")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -4102,14 +4125,11 @@ function MDXContent(_ref) {
4102
4125
  parentName: "p"
4103
4126
  }, "remote add <url>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4104
4127
  parentName: "p"
4105
- }, "Description"), ": add a bare-scope as a remote. supported protocols are ", "[file, http, ssh]", ".", (0, _react2.mdx)("br", {
4128
+ }, "Description"), ": add a bare-scope as a remote", (0, _react2.mdx)("br", {
4106
4129
  parentName: "p"
4107
- }), "\n", "for example: \"http://localhost:3000\", \"file:///tmp/local-scope\", \"ssh://", (0, _react2.mdx)("a", {
4108
- parentName: "p",
4109
- "href": "mailto:user@127.0.0.1"
4110
- }, "user@127.0.0.1"), ":/tmp/local-scope\".", (0, _react2.mdx)("br", {
4130
+ }), "\n", "supported protocols are ", "[file, http]", ".", (0, _react2.mdx)("br", {
4111
4131
  parentName: "p"
4112
- }), "\n", "Legacy support ", "[file, ssh]", ". Harmony supports ", "[file, http]", "."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4132
+ }), "\n", "for example: \"http://localhost:3000\", \"file:///tmp/local-scope\""), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4113
4133
  parentName: "table"
4114
4134
  }, (0, _react2.mdx)("tr", {
4115
4135
  parentName: "thead"
@@ -4235,9 +4255,9 @@ function MDXContent(_ref) {
4235
4255
  parentName: "p"
4236
4256
  }), "\n", (0, _react2.mdx)("strong", {
4237
4257
  parentName: "p"
4238
- }, "Description"), ": remove a component (local/remote)", (0, _react2.mdx)("br", {
4258
+ }, "Description"), ": remove component(s) from your workspace, or a remote scope", (0, _react2.mdx)("br", {
4239
4259
  parentName: "p"
4240
- }), "\n", "", (0, _react2.mdx)("a", {
4260
+ }), "\n", (0, _react2.mdx)("a", {
4241
4261
  parentName: "p",
4242
4262
  "href": "https://bit.dev/docs/components/removing-components"
4243
4263
  }, "https://bit.dev/docs/components/removing-components"), (0, _react2.mdx)("br", {
@@ -4435,19 +4455,7 @@ function MDXContent(_ref) {
4435
4455
  }, "-r")), (0, _react2.mdx)("td", {
4436
4456
  parentName: "tr",
4437
4457
  "align": null
4438
- }, "change the source code of all components using this component with the new package-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "resume-export"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4439
- parentName: "p"
4440
- }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4441
- parentName: "p"
4442
- }), "\n", (0, _react2.mdx)("strong", {
4443
- parentName: "p"
4444
- }, "Description"), ": resume failed export to persist the pending objects on the given remotes.", (0, _react2.mdx)("br", {
4445
- parentName: "p"
4446
- }), "\n", "the export-id is the id the client got in the error message during the failure.", (0, _react2.mdx)("br", {
4447
- parentName: "p"
4448
- }), "\n", "alternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4449
- parentName: "p"
4450
- }, "bit resume-export <export-id> <remotes...>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4458
+ }, "change the source code of all components using this component with the new package-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4451
4459
  parentName: "p"
4452
4460
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
4453
4461
  parentName: "p"
@@ -4911,9 +4919,9 @@ function MDXContent(_ref) {
4911
4919
  parentName: "p"
4912
4920
  }), "\n", (0, _react2.mdx)("strong", {
4913
4921
  parentName: "p"
4914
- }, "Description"), ": show the working area component(s) status.", (0, _react2.mdx)("br", {
4922
+ }, "Description"), ": show the working area component(s) status", (0, _react2.mdx)("br", {
4915
4923
  parentName: "p"
4916
- }), "\n", "", (0, _react2.mdx)("a", {
4924
+ }), "\n", (0, _react2.mdx)("a", {
4917
4925
  parentName: "p",
4918
4926
  "href": "https://bit.dev/docs/workspace/workspace-status"
4919
4927
  }, "https://bit.dev/docs/workspace/workspace-status")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
@@ -4979,7 +4987,7 @@ function MDXContent(_ref) {
4979
4987
  parentName: "p"
4980
4988
  }), "\n", (0, _react2.mdx)("strong", {
4981
4989
  parentName: "p"
4982
- }, "Description"), ": record component changes and lock versions.", (0, _react2.mdx)("br", {
4990
+ }, "Description"), ": record component changes and lock versions", (0, _react2.mdx)("br", {
4983
4991
  parentName: "p"
4984
4992
  }), "\n", "if no ids are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
4985
4993
  parentName: "p"
@@ -5273,7 +5281,9 @@ function MDXContent(_ref) {
5273
5281
  parentName: "p"
5274
5282
  }), "\n", (0, _react2.mdx)("strong", {
5275
5283
  parentName: "p"
5276
- }, "Description"), ": list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5284
+ }, "Description"), ": list templates for \"bit create\" and \"bit new\"", (0, _react2.mdx)("br", {
5285
+ parentName: "p"
5286
+ }), "\n", "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5277
5287
  parentName: "p"
5278
5288
  }, "bit templates")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5279
5289
  parentName: "table"
@@ -5489,9 +5499,9 @@ function MDXContent(_ref) {
5489
5499
  parentName: "p"
5490
5500
  }), "\n", (0, _react2.mdx)("strong", {
5491
5501
  parentName: "p"
5492
- }, "Description"), ": revert version(s) tagged for component(s)", (0, _react2.mdx)("br", {
5502
+ }, "Description"), ": revert versions tagged for component(s)", (0, _react2.mdx)("br", {
5493
5503
  parentName: "p"
5494
- }), "\n", "", (0, _react2.mdx)("a", {
5504
+ }), "\n", (0, _react2.mdx)("a", {
5495
5505
  parentName: "p",
5496
5506
  "href": "https://bit.dev/docs/components/tags#undoing-a-tag"
5497
5507
  }, "https://bit.dev/docs/components/tags#undoing-a-tag"), (0, _react2.mdx)("br", {