@teambit/harmony.content.cli-reference 1.95.66 → 1.95.69
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.
- package/cli-reference.json +144 -134
- package/cli-reference.mdx +18 -22
- package/dist/cli-reference.json +144 -134
- package/dist/cli-reference.mdx.js +11 -43
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.69.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1662069881993.js → preview-1662608124038.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.66.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -989,81 +989,6 @@
|
|
|
989
989
|
}
|
|
990
990
|
]
|
|
991
991
|
},
|
|
992
|
-
{
|
|
993
|
-
"name": "install [packages...]",
|
|
994
|
-
"alias": "in",
|
|
995
|
-
"options": [
|
|
996
|
-
[
|
|
997
|
-
"v",
|
|
998
|
-
"variants <variants>",
|
|
999
|
-
"add packages to specific variants"
|
|
1000
|
-
],
|
|
1001
|
-
[
|
|
1002
|
-
"t",
|
|
1003
|
-
"type [lifecycleType]",
|
|
1004
|
-
"\"runtime\" (default) or \"peer\" (dev is not a valid option)"
|
|
1005
|
-
],
|
|
1006
|
-
[
|
|
1007
|
-
"u",
|
|
1008
|
-
"update-existing [updateExisting]",
|
|
1009
|
-
"update existing dependencies version and types"
|
|
1010
|
-
],
|
|
1011
|
-
[
|
|
1012
|
-
"",
|
|
1013
|
-
"save-prefix [savePrefix]",
|
|
1014
|
-
"set the prefix to use when adding dependency to workspace.jsonc"
|
|
1015
|
-
],
|
|
1016
|
-
[
|
|
1017
|
-
"",
|
|
1018
|
-
"skip-dedupe [skipDedupe]",
|
|
1019
|
-
"do not dedupe dependencies on installation"
|
|
1020
|
-
],
|
|
1021
|
-
[
|
|
1022
|
-
"",
|
|
1023
|
-
"skip-import [skipImport]",
|
|
1024
|
-
"do not import bit objects post installation"
|
|
1025
|
-
],
|
|
1026
|
-
[
|
|
1027
|
-
"",
|
|
1028
|
-
"add-missing-peers [addMissingPeers]",
|
|
1029
|
-
"install all missing peer dependencies"
|
|
1030
|
-
]
|
|
1031
|
-
],
|
|
1032
|
-
"description": "installs workspace dependencies",
|
|
1033
|
-
"extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
|
|
1034
|
-
"group": "development",
|
|
1035
|
-
"private": false,
|
|
1036
|
-
"arguments": [
|
|
1037
|
-
{
|
|
1038
|
-
"name": "packages...",
|
|
1039
|
-
"description": "a list of packages to install (separated by spaces)"
|
|
1040
|
-
}
|
|
1041
|
-
]
|
|
1042
|
-
},
|
|
1043
|
-
{
|
|
1044
|
-
"name": "update",
|
|
1045
|
-
"alias": "up",
|
|
1046
|
-
"options": [
|
|
1047
|
-
[
|
|
1048
|
-
"y",
|
|
1049
|
-
"yes",
|
|
1050
|
-
"automatically update all outdated packages"
|
|
1051
|
-
]
|
|
1052
|
-
],
|
|
1053
|
-
"description": "update dependencies",
|
|
1054
|
-
"extendedDescription": "",
|
|
1055
|
-
"group": "development",
|
|
1056
|
-
"private": false
|
|
1057
|
-
},
|
|
1058
|
-
{
|
|
1059
|
-
"name": "uninstall [packages...]",
|
|
1060
|
-
"alias": "un",
|
|
1061
|
-
"options": [],
|
|
1062
|
-
"description": "uninstall dependencies",
|
|
1063
|
-
"extendedDescription": "",
|
|
1064
|
-
"group": "development",
|
|
1065
|
-
"private": false
|
|
1066
|
-
},
|
|
1067
992
|
{
|
|
1068
993
|
"name": "eject-conf <pattern>",
|
|
1069
994
|
"alias": "",
|
|
@@ -1205,47 +1130,6 @@
|
|
|
1205
1130
|
"group": "development",
|
|
1206
1131
|
"private": false
|
|
1207
1132
|
},
|
|
1208
|
-
{
|
|
1209
|
-
"name": "link [component-names...]",
|
|
1210
|
-
"alias": "",
|
|
1211
|
-
"options": [
|
|
1212
|
-
[
|
|
1213
|
-
"j",
|
|
1214
|
-
"json",
|
|
1215
|
-
"return the output as JSON"
|
|
1216
|
-
],
|
|
1217
|
-
[
|
|
1218
|
-
"",
|
|
1219
|
-
"verbose",
|
|
1220
|
-
"verbose output"
|
|
1221
|
-
],
|
|
1222
|
-
[
|
|
1223
|
-
"r",
|
|
1224
|
-
"rewire",
|
|
1225
|
-
"Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
|
|
1226
|
-
],
|
|
1227
|
-
[
|
|
1228
|
-
"",
|
|
1229
|
-
"target <dir>",
|
|
1230
|
-
"EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1231
|
-
],
|
|
1232
|
-
[
|
|
1233
|
-
"",
|
|
1234
|
-
"skip-fetching-objects",
|
|
1235
|
-
"skip fetch missing objects from remotes before linking"
|
|
1236
|
-
]
|
|
1237
|
-
],
|
|
1238
|
-
"description": "create links in the node_modules directory, to core aspects and to components in the workspace",
|
|
1239
|
-
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1240
|
-
"group": "development",
|
|
1241
|
-
"private": false,
|
|
1242
|
-
"arguments": [
|
|
1243
|
-
{
|
|
1244
|
-
"name": "component-names...",
|
|
1245
|
-
"description": "names or IDs of the components to link"
|
|
1246
|
-
}
|
|
1247
|
-
]
|
|
1248
|
-
},
|
|
1249
1133
|
{
|
|
1250
1134
|
"name": "use <component-id>",
|
|
1251
1135
|
"alias": "",
|
|
@@ -1300,7 +1184,7 @@
|
|
|
1300
1184
|
]
|
|
1301
1185
|
},
|
|
1302
1186
|
{
|
|
1303
|
-
"name": "checkout [
|
|
1187
|
+
"name": "checkout <to> [component-pattern]",
|
|
1304
1188
|
"alias": "U",
|
|
1305
1189
|
"options": [
|
|
1306
1190
|
[
|
|
@@ -1338,6 +1222,11 @@
|
|
|
1338
1222
|
"verbose",
|
|
1339
1223
|
"showing verbose output for inspection"
|
|
1340
1224
|
],
|
|
1225
|
+
[
|
|
1226
|
+
"",
|
|
1227
|
+
"reset",
|
|
1228
|
+
"DEPRECATED. run \"bit checkout reset\" instead"
|
|
1229
|
+
],
|
|
1341
1230
|
[
|
|
1342
1231
|
"",
|
|
1343
1232
|
"skip-npm-install",
|
|
@@ -1347,27 +1236,22 @@
|
|
|
1347
1236
|
"",
|
|
1348
1237
|
"skip-dependency-installation",
|
|
1349
1238
|
"do not install packages of the imported components"
|
|
1350
|
-
],
|
|
1351
|
-
[
|
|
1352
|
-
"",
|
|
1353
|
-
"ignore-package-json",
|
|
1354
|
-
"do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)"
|
|
1355
|
-
],
|
|
1356
|
-
[
|
|
1357
|
-
"",
|
|
1358
|
-
"conf [path]",
|
|
1359
|
-
"write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)"
|
|
1360
|
-
],
|
|
1361
|
-
[
|
|
1362
|
-
"",
|
|
1363
|
-
"ignore-dist",
|
|
1364
|
-
"do not write dist files (when exist)"
|
|
1365
1239
|
]
|
|
1366
1240
|
],
|
|
1367
1241
|
"description": "switch between component versions or remove local changes",
|
|
1368
|
-
"extendedDescription": "\n `bit checkout <version> [
|
|
1242
|
+
"extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
|
|
1369
1243
|
"group": "development",
|
|
1370
|
-
"private": false
|
|
1244
|
+
"private": false,
|
|
1245
|
+
"arguments": [
|
|
1246
|
+
{
|
|
1247
|
+
"name": "to",
|
|
1248
|
+
"description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "component-pattern",
|
|
1252
|
+
"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"
|
|
1253
|
+
}
|
|
1254
|
+
]
|
|
1371
1255
|
},
|
|
1372
1256
|
{
|
|
1373
1257
|
"name": "remove <component-pattern>",
|
|
@@ -1422,6 +1306,122 @@
|
|
|
1422
1306
|
}
|
|
1423
1307
|
]
|
|
1424
1308
|
},
|
|
1309
|
+
{
|
|
1310
|
+
"name": "install [packages...]",
|
|
1311
|
+
"alias": "in",
|
|
1312
|
+
"options": [
|
|
1313
|
+
[
|
|
1314
|
+
"v",
|
|
1315
|
+
"variants <variants>",
|
|
1316
|
+
"add packages to specific variants"
|
|
1317
|
+
],
|
|
1318
|
+
[
|
|
1319
|
+
"t",
|
|
1320
|
+
"type [lifecycleType]",
|
|
1321
|
+
"\"runtime\" (default) or \"peer\" (dev is not a valid option)"
|
|
1322
|
+
],
|
|
1323
|
+
[
|
|
1324
|
+
"u",
|
|
1325
|
+
"update-existing [updateExisting]",
|
|
1326
|
+
"update existing dependencies version and types"
|
|
1327
|
+
],
|
|
1328
|
+
[
|
|
1329
|
+
"",
|
|
1330
|
+
"save-prefix [savePrefix]",
|
|
1331
|
+
"set the prefix to use when adding dependency to workspace.jsonc"
|
|
1332
|
+
],
|
|
1333
|
+
[
|
|
1334
|
+
"",
|
|
1335
|
+
"skip-dedupe [skipDedupe]",
|
|
1336
|
+
"do not dedupe dependencies on installation"
|
|
1337
|
+
],
|
|
1338
|
+
[
|
|
1339
|
+
"",
|
|
1340
|
+
"skip-import [skipImport]",
|
|
1341
|
+
"do not import bit objects post installation"
|
|
1342
|
+
],
|
|
1343
|
+
[
|
|
1344
|
+
"",
|
|
1345
|
+
"add-missing-peers [addMissingPeers]",
|
|
1346
|
+
"install all missing peer dependencies"
|
|
1347
|
+
]
|
|
1348
|
+
],
|
|
1349
|
+
"description": "installs workspace dependencies",
|
|
1350
|
+
"extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
|
|
1351
|
+
"group": "development",
|
|
1352
|
+
"private": false,
|
|
1353
|
+
"arguments": [
|
|
1354
|
+
{
|
|
1355
|
+
"name": "packages...",
|
|
1356
|
+
"description": "a list of packages to install (separated by spaces)"
|
|
1357
|
+
}
|
|
1358
|
+
]
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"name": "uninstall [packages...]",
|
|
1362
|
+
"alias": "un",
|
|
1363
|
+
"options": [],
|
|
1364
|
+
"description": "uninstall dependencies",
|
|
1365
|
+
"extendedDescription": "",
|
|
1366
|
+
"group": "development",
|
|
1367
|
+
"private": false
|
|
1368
|
+
},
|
|
1369
|
+
{
|
|
1370
|
+
"name": "update",
|
|
1371
|
+
"alias": "up",
|
|
1372
|
+
"options": [
|
|
1373
|
+
[
|
|
1374
|
+
"y",
|
|
1375
|
+
"yes",
|
|
1376
|
+
"automatically update all outdated packages"
|
|
1377
|
+
]
|
|
1378
|
+
],
|
|
1379
|
+
"description": "update dependencies",
|
|
1380
|
+
"extendedDescription": "",
|
|
1381
|
+
"group": "development",
|
|
1382
|
+
"private": false
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"name": "link [component-names...]",
|
|
1386
|
+
"alias": "",
|
|
1387
|
+
"options": [
|
|
1388
|
+
[
|
|
1389
|
+
"j",
|
|
1390
|
+
"json",
|
|
1391
|
+
"return the output as JSON"
|
|
1392
|
+
],
|
|
1393
|
+
[
|
|
1394
|
+
"",
|
|
1395
|
+
"verbose",
|
|
1396
|
+
"verbose output"
|
|
1397
|
+
],
|
|
1398
|
+
[
|
|
1399
|
+
"r",
|
|
1400
|
+
"rewire",
|
|
1401
|
+
"Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
|
|
1402
|
+
],
|
|
1403
|
+
[
|
|
1404
|
+
"",
|
|
1405
|
+
"target <dir>",
|
|
1406
|
+
"EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1407
|
+
],
|
|
1408
|
+
[
|
|
1409
|
+
"",
|
|
1410
|
+
"skip-fetching-objects",
|
|
1411
|
+
"skip fetch missing objects from remotes before linking"
|
|
1412
|
+
]
|
|
1413
|
+
],
|
|
1414
|
+
"description": "create links in the node_modules directory, to core aspects and to components in the workspace",
|
|
1415
|
+
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1416
|
+
"group": "development",
|
|
1417
|
+
"private": false,
|
|
1418
|
+
"arguments": [
|
|
1419
|
+
{
|
|
1420
|
+
"name": "component-names...",
|
|
1421
|
+
"description": "names or IDs of the components to link"
|
|
1422
|
+
}
|
|
1423
|
+
]
|
|
1424
|
+
},
|
|
1425
1425
|
{
|
|
1426
1426
|
"name": "insights [names...]",
|
|
1427
1427
|
"alias": "",
|
|
@@ -2113,6 +2113,11 @@
|
|
|
2113
2113
|
"no-squash",
|
|
2114
2114
|
"EXPERIMENTAL. relevant for merging lanes into main, which by default squash."
|
|
2115
2115
|
],
|
|
2116
|
+
[
|
|
2117
|
+
"",
|
|
2118
|
+
"ignore-config-changes",
|
|
2119
|
+
"allow merging when component are modified due to config changes (such as dependencies) only and not files"
|
|
2120
|
+
],
|
|
2116
2121
|
[
|
|
2117
2122
|
"",
|
|
2118
2123
|
"verbose",
|
|
@@ -3402,6 +3407,11 @@
|
|
|
3402
3407
|
"email <string>",
|
|
3403
3408
|
"email to be saved as part of the version log"
|
|
3404
3409
|
],
|
|
3410
|
+
[
|
|
3411
|
+
"",
|
|
3412
|
+
"lane <lane-id>",
|
|
3413
|
+
"helps to fetch the components from the lane scope (relevant for --multiple)"
|
|
3414
|
+
],
|
|
3405
3415
|
[
|
|
3406
3416
|
"",
|
|
3407
3417
|
"skip-new-scope-validation",
|
package/cli-reference.mdx
CHANGED
|
@@ -217,28 +217,24 @@ with no args, only workspace's capsules are deleted
|
|
|
217
217
|
**Workspace only**: yes
|
|
218
218
|
**Description**: switch between component versions or remove local changes
|
|
219
219
|
|
|
220
|
-
`bit checkout <version> [
|
|
221
|
-
`bit checkout head` => checkout
|
|
222
|
-
`bit checkout
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
|
229
|
-
|
|
|
230
|
-
| `--
|
|
231
|
-
| `--
|
|
232
|
-
| `--
|
|
233
|
-
| `--
|
|
234
|
-
| `--
|
|
235
|
-
| `--
|
|
236
|
-
| `--
|
|
237
|
-
| `--skip-
|
|
238
|
-
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
239
|
-
| `--ignore-package-json` | | do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags) |
|
|
240
|
-
| `--conf [path]` | | write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir) |
|
|
241
|
-
| `--ignore-dist` | | do not write dist files (when exist) |
|
|
220
|
+
`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
|
|
221
|
+
`bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all
|
|
222
|
+
`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
|
|
223
|
+
|
|
224
|
+
`bit checkout <to> [component-pattern]`
|
|
225
|
+
|
|
226
|
+
| **Option** | **Option alias** | **Description** |
|
|
227
|
+
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------- |
|
|
228
|
+
| `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
|
|
229
|
+
| `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
|
|
230
|
+
| `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
|
|
231
|
+
| `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
232
|
+
| `--reset` | `-r` | revert changes that were not snapped/tagged |
|
|
233
|
+
| `--all` | `-a` | all components |
|
|
234
|
+
| `--verbose` | `-v` | showing verbose output for inspection |
|
|
235
|
+
| `--reset` | | DEPRECATED. run "bit checkout reset" instead |
|
|
236
|
+
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
|
|
237
|
+
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
242
238
|
|
|
243
239
|
---
|
|
244
240
|
|