@teambit/harmony.content.cli-reference 1.95.30 → 1.95.33
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 +244 -125
- package/cli-reference.mdx +80 -96
- package/dist/cli-reference.json +244 -125
- package/dist/cli-reference.mdx.js +91 -167
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.33.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1655263660719.js → preview-1655782086029.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.30.tgz +0 -0
package/dist/cli-reference.json
CHANGED
|
@@ -65,52 +65,6 @@
|
|
|
65
65
|
"private": false,
|
|
66
66
|
"skipWorkspace": true
|
|
67
67
|
},
|
|
68
|
-
{
|
|
69
|
-
"name": "list [remote-scope]",
|
|
70
|
-
"alias": "ls",
|
|
71
|
-
"options": [
|
|
72
|
-
[
|
|
73
|
-
"i",
|
|
74
|
-
"ids",
|
|
75
|
-
"show only component ids unformatted"
|
|
76
|
-
],
|
|
77
|
-
[
|
|
78
|
-
"s",
|
|
79
|
-
"scope",
|
|
80
|
-
"show only components stored in the local scope, including indirect dependencies"
|
|
81
|
-
],
|
|
82
|
-
[
|
|
83
|
-
"b",
|
|
84
|
-
"bare",
|
|
85
|
-
"DEPRECATED. use --raw instead"
|
|
86
|
-
],
|
|
87
|
-
[
|
|
88
|
-
"r",
|
|
89
|
-
"raw",
|
|
90
|
-
"show raw output (only components ids, no styling)"
|
|
91
|
-
],
|
|
92
|
-
[
|
|
93
|
-
"o",
|
|
94
|
-
"outdated",
|
|
95
|
-
"show latest versions from remotes"
|
|
96
|
-
],
|
|
97
|
-
[
|
|
98
|
-
"j",
|
|
99
|
-
"json",
|
|
100
|
-
"show the output in JSON format"
|
|
101
|
-
],
|
|
102
|
-
[
|
|
103
|
-
"n",
|
|
104
|
-
"namespace <string>",
|
|
105
|
-
"show only specified namespace by using wildcards"
|
|
106
|
-
]
|
|
107
|
-
],
|
|
108
|
-
"description": "list components on a workspace, local scope or a remote scope.",
|
|
109
|
-
"extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
|
|
110
|
-
"group": "discover",
|
|
111
|
-
"private": false,
|
|
112
|
-
"skipWorkspace": true
|
|
113
|
-
},
|
|
114
68
|
{
|
|
115
69
|
"name": "config",
|
|
116
70
|
"alias": "",
|
|
@@ -518,7 +472,7 @@
|
|
|
518
472
|
[
|
|
519
473
|
"t",
|
|
520
474
|
"tests <file>/\"<file>,<file>\"",
|
|
521
|
-
"specify test files to track. use quotation marks to list files or use a glob pattern"
|
|
475
|
+
"LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern"
|
|
522
476
|
],
|
|
523
477
|
[
|
|
524
478
|
"n",
|
|
@@ -528,7 +482,7 @@
|
|
|
528
482
|
[
|
|
529
483
|
"e",
|
|
530
484
|
"exclude <file>/\"<file>,<file>\"",
|
|
531
|
-
"exclude file from being tracked. use quotation marks to list files or use a glob pattern"
|
|
485
|
+
"LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern"
|
|
532
486
|
],
|
|
533
487
|
[
|
|
534
488
|
"o",
|
|
@@ -562,7 +516,7 @@
|
|
|
562
516
|
"private": true
|
|
563
517
|
},
|
|
564
518
|
{
|
|
565
|
-
"name": "untag [
|
|
519
|
+
"name": "untag [component-name] [component-version]",
|
|
566
520
|
"alias": "",
|
|
567
521
|
"options": [
|
|
568
522
|
[
|
|
@@ -581,19 +535,19 @@
|
|
|
581
535
|
"revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
|
|
582
536
|
]
|
|
583
537
|
],
|
|
584
|
-
"description": "revert versions
|
|
538
|
+
"description": "revert tagged or snapped versions for component(s)",
|
|
585
539
|
"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)",
|
|
586
540
|
"group": "development",
|
|
587
541
|
"private": false
|
|
588
542
|
},
|
|
589
543
|
{
|
|
590
|
-
"name": "move <
|
|
544
|
+
"name": "move <current-component-dir> <new-component-dir>",
|
|
591
545
|
"alias": "mv",
|
|
592
546
|
"options": [
|
|
593
547
|
[
|
|
594
548
|
"c",
|
|
595
549
|
"component",
|
|
596
|
-
"move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
|
|
550
|
+
"LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
|
|
597
551
|
]
|
|
598
552
|
],
|
|
599
553
|
"description": "move a component to a different filesystem path",
|
|
@@ -602,7 +556,7 @@
|
|
|
602
556
|
"private": false
|
|
603
557
|
},
|
|
604
558
|
{
|
|
605
|
-
"name": "remove <ids...>",
|
|
559
|
+
"name": "remove <component-ids...>",
|
|
606
560
|
"alias": "rm",
|
|
607
561
|
"options": [
|
|
608
562
|
[
|
|
@@ -613,7 +567,7 @@
|
|
|
613
567
|
[
|
|
614
568
|
"t",
|
|
615
569
|
"track",
|
|
616
|
-
"keep tracking component (default = false)"
|
|
570
|
+
"keep tracking component in .bitmap (default = false), helps transform a tagged-component to new"
|
|
617
571
|
],
|
|
618
572
|
[
|
|
619
573
|
"d",
|
|
@@ -636,7 +590,7 @@
|
|
|
636
590
|
"skip confirmation"
|
|
637
591
|
]
|
|
638
592
|
],
|
|
639
|
-
"description": "remove component(s) from
|
|
593
|
+
"description": "remove component(s) from the workspace, or a remote scope",
|
|
640
594
|
"extendedDescription": "https://bit.dev/docs/components/removing-components\nyou can use a pattern for multiple ids, such as bit remove \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
641
595
|
"group": "collaborate",
|
|
642
596
|
"private": false,
|
|
@@ -767,7 +721,7 @@
|
|
|
767
721
|
"show tables instead of plain text for dependencies diff"
|
|
768
722
|
]
|
|
769
723
|
],
|
|
770
|
-
"description": "show diff between components files",
|
|
724
|
+
"description": "show the diff between the components' source files and config",
|
|
771
725
|
"extendedDescription": "bit diff => compare all modified components to their model version\n bit diff [ids...] => compare the specified components against their modified states\n bit diff [id] [version] => compare the specified version to used or modified files\n bit diff [id] [version] [to_version] => compare the specified version files to to_version files\n you can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
772
726
|
"group": "development",
|
|
773
727
|
"private": false
|
|
@@ -798,11 +752,11 @@
|
|
|
798
752
|
],
|
|
799
753
|
[
|
|
800
754
|
"",
|
|
801
|
-
"machine-name <
|
|
755
|
+
"machine-name <name>",
|
|
802
756
|
"specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token)"
|
|
803
757
|
]
|
|
804
758
|
],
|
|
805
|
-
"description": "log
|
|
759
|
+
"description": "log in to Bit cloud",
|
|
806
760
|
"extendedDescription": "",
|
|
807
761
|
"group": "general",
|
|
808
762
|
"private": false,
|
|
@@ -1048,21 +1002,6 @@
|
|
|
1048
1002
|
}
|
|
1049
1003
|
]
|
|
1050
1004
|
},
|
|
1051
|
-
{
|
|
1052
|
-
"name": "globals",
|
|
1053
|
-
"alias": "",
|
|
1054
|
-
"options": [
|
|
1055
|
-
[
|
|
1056
|
-
"j",
|
|
1057
|
-
"json",
|
|
1058
|
-
"json format"
|
|
1059
|
-
]
|
|
1060
|
-
],
|
|
1061
|
-
"description": "list all globals",
|
|
1062
|
-
"extendedDescription": "",
|
|
1063
|
-
"group": "workspace",
|
|
1064
|
-
"private": false
|
|
1065
|
-
},
|
|
1066
1005
|
{
|
|
1067
1006
|
"name": "envs",
|
|
1068
1007
|
"alias": "env",
|
|
@@ -1130,7 +1069,7 @@
|
|
|
1130
1069
|
"name": "unset <component-pattern>",
|
|
1131
1070
|
"options": [],
|
|
1132
1071
|
"description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
|
|
1133
|
-
"extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"
|
|
1072
|
+
"extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
1134
1073
|
"group": "development",
|
|
1135
1074
|
"arguments": [
|
|
1136
1075
|
{
|
|
@@ -1163,6 +1102,21 @@
|
|
|
1163
1102
|
}
|
|
1164
1103
|
]
|
|
1165
1104
|
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "globals",
|
|
1107
|
+
"alias": "",
|
|
1108
|
+
"options": [
|
|
1109
|
+
[
|
|
1110
|
+
"j",
|
|
1111
|
+
"json",
|
|
1112
|
+
"json format"
|
|
1113
|
+
]
|
|
1114
|
+
],
|
|
1115
|
+
"description": "list all globals",
|
|
1116
|
+
"extendedDescription": "",
|
|
1117
|
+
"group": "workspace",
|
|
1118
|
+
"private": false
|
|
1119
|
+
},
|
|
1166
1120
|
{
|
|
1167
1121
|
"name": "start [type] [pattern]",
|
|
1168
1122
|
"alias": "c",
|
|
@@ -1225,7 +1179,7 @@
|
|
|
1225
1179
|
"name": "set <scope-name> [component-pattern]",
|
|
1226
1180
|
"options": [],
|
|
1227
1181
|
"description": "Sets components with a default-scope. If no component is specified, sets the workspace with a default scope",
|
|
1228
|
-
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"
|
|
1182
|
+
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
1229
1183
|
"group": "development",
|
|
1230
1184
|
"arguments": [
|
|
1231
1185
|
{
|
|
@@ -1311,7 +1265,13 @@
|
|
|
1311
1265
|
"description": "installs workspace dependencies",
|
|
1312
1266
|
"extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
|
|
1313
1267
|
"group": "development",
|
|
1314
|
-
"private": false
|
|
1268
|
+
"private": false,
|
|
1269
|
+
"arguments": [
|
|
1270
|
+
{
|
|
1271
|
+
"name": "packages...",
|
|
1272
|
+
"description": "a list of packages to install (separated by spaces)"
|
|
1273
|
+
}
|
|
1274
|
+
]
|
|
1315
1275
|
},
|
|
1316
1276
|
{
|
|
1317
1277
|
"name": "update",
|
|
@@ -1353,7 +1313,7 @@
|
|
|
1353
1313
|
]
|
|
1354
1314
|
],
|
|
1355
1315
|
"description": "eject components configuration (create a `component.json` file)",
|
|
1356
|
-
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"
|
|
1316
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
1357
1317
|
"group": "development",
|
|
1358
1318
|
"private": false
|
|
1359
1319
|
},
|
|
@@ -1362,7 +1322,7 @@
|
|
|
1362
1322
|
"alias": "",
|
|
1363
1323
|
"options": [],
|
|
1364
1324
|
"description": "manage capsules",
|
|
1365
|
-
"extendedDescription": "a capsule is a directory
|
|
1325
|
+
"extendedDescription": "a capsule is a directory containing the component code, isolated from the workspace.\nnormally, capsules are created during the build process, the component files are copied and the packages are installed\nvia the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for\nother users after publishing/exporting them.",
|
|
1366
1326
|
"group": "capsules",
|
|
1367
1327
|
"private": false,
|
|
1368
1328
|
"commands": [
|
|
@@ -1376,13 +1336,13 @@
|
|
|
1376
1336
|
"json format"
|
|
1377
1337
|
]
|
|
1378
1338
|
],
|
|
1379
|
-
"description": "list
|
|
1339
|
+
"description": "list the capsules generated for this workspace",
|
|
1380
1340
|
"extendedDescription": "",
|
|
1381
1341
|
"group": "capsules",
|
|
1382
1342
|
"private": false
|
|
1383
1343
|
},
|
|
1384
1344
|
{
|
|
1385
|
-
"name": "create [
|
|
1345
|
+
"name": "create [component-id...]",
|
|
1386
1346
|
"alias": "",
|
|
1387
1347
|
"options": [
|
|
1388
1348
|
[
|
|
@@ -1426,7 +1386,7 @@
|
|
|
1426
1386
|
"npm, yarn or pnpm, default to npm"
|
|
1427
1387
|
]
|
|
1428
1388
|
],
|
|
1429
|
-
"description": "create capsules",
|
|
1389
|
+
"description": "create capsules for components",
|
|
1430
1390
|
"extendedDescription": "",
|
|
1431
1391
|
"group": "capsules",
|
|
1432
1392
|
"private": false
|
|
@@ -1460,7 +1420,7 @@
|
|
|
1460
1420
|
[
|
|
1461
1421
|
"v",
|
|
1462
1422
|
"verbose",
|
|
1463
|
-
"
|
|
1423
|
+
"show npm verbose output for inspection and print the stack trace"
|
|
1464
1424
|
],
|
|
1465
1425
|
[
|
|
1466
1426
|
"",
|
|
@@ -1473,13 +1433,13 @@
|
|
|
1473
1433
|
"EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project"
|
|
1474
1434
|
]
|
|
1475
1435
|
],
|
|
1476
|
-
"description": "
|
|
1436
|
+
"description": "automatically recompile modified components (on save)",
|
|
1477
1437
|
"extendedDescription": "",
|
|
1478
1438
|
"group": "development",
|
|
1479
1439
|
"private": false
|
|
1480
1440
|
},
|
|
1481
1441
|
{
|
|
1482
|
-
"name": "link [
|
|
1442
|
+
"name": "link [component-names...]",
|
|
1483
1443
|
"alias": "",
|
|
1484
1444
|
"options": [
|
|
1485
1445
|
[
|
|
@@ -1508,10 +1468,16 @@
|
|
|
1508
1468
|
"skip fetch missing objects from remotes before linking"
|
|
1509
1469
|
]
|
|
1510
1470
|
],
|
|
1511
|
-
"description": "
|
|
1471
|
+
"description": "create links in the node_modules directory, to core aspects and to components in the workspace",
|
|
1512
1472
|
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1513
1473
|
"group": "development",
|
|
1514
|
-
"private": false
|
|
1474
|
+
"private": false,
|
|
1475
|
+
"arguments": [
|
|
1476
|
+
{
|
|
1477
|
+
"name": "component-names...",
|
|
1478
|
+
"description": "names or IDs of the components to link"
|
|
1479
|
+
}
|
|
1480
|
+
]
|
|
1515
1481
|
},
|
|
1516
1482
|
{
|
|
1517
1483
|
"name": "pattern <pattern>",
|
|
@@ -1524,10 +1490,47 @@
|
|
|
1524
1490
|
]
|
|
1525
1491
|
],
|
|
1526
1492
|
"description": "list the component ids matching the given pattern",
|
|
1527
|
-
"extendedDescription": "",
|
|
1493
|
+
"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",
|
|
1528
1494
|
"group": "development",
|
|
1529
1495
|
"private": false
|
|
1530
1496
|
},
|
|
1497
|
+
{
|
|
1498
|
+
"name": "list [remote-scope]",
|
|
1499
|
+
"alias": "ls",
|
|
1500
|
+
"options": [
|
|
1501
|
+
[
|
|
1502
|
+
"i",
|
|
1503
|
+
"ids",
|
|
1504
|
+
"show only component ids unformatted"
|
|
1505
|
+
],
|
|
1506
|
+
[
|
|
1507
|
+
"s",
|
|
1508
|
+
"scope",
|
|
1509
|
+
"show only components stored in the local scope, including indirect dependencies"
|
|
1510
|
+
],
|
|
1511
|
+
[
|
|
1512
|
+
"o",
|
|
1513
|
+
"outdated",
|
|
1514
|
+
"show latest versions from remotes"
|
|
1515
|
+
],
|
|
1516
|
+
[
|
|
1517
|
+
"j",
|
|
1518
|
+
"json",
|
|
1519
|
+
"show the output in JSON format"
|
|
1520
|
+
],
|
|
1521
|
+
[
|
|
1522
|
+
"n",
|
|
1523
|
+
"namespace <string>",
|
|
1524
|
+
"show only specified namespace by using wildcards"
|
|
1525
|
+
]
|
|
1526
|
+
],
|
|
1527
|
+
"description": "list components on a workspace, local scope or a remote scope.",
|
|
1528
|
+
"extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
|
|
1529
|
+
"group": "discover",
|
|
1530
|
+
"private": false,
|
|
1531
|
+
"remoteOp": true,
|
|
1532
|
+
"skipWorkspace": true
|
|
1533
|
+
},
|
|
1531
1534
|
{
|
|
1532
1535
|
"name": "import [component-ids...]",
|
|
1533
1536
|
"alias": "",
|
|
@@ -1649,6 +1652,16 @@
|
|
|
1649
1652
|
"extendedDescription": "",
|
|
1650
1653
|
"group": "development",
|
|
1651
1654
|
"private": false,
|
|
1655
|
+
"arguments": [
|
|
1656
|
+
{
|
|
1657
|
+
"name": "template-name",
|
|
1658
|
+
"description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
|
|
1659
|
+
},
|
|
1660
|
+
{
|
|
1661
|
+
"name": "component-names...",
|
|
1662
|
+
"description": "a list of component names to generate"
|
|
1663
|
+
}
|
|
1664
|
+
],
|
|
1652
1665
|
"examples": [
|
|
1653
1666
|
{
|
|
1654
1667
|
"cmd": "bit create react ui/button",
|
|
@@ -1734,7 +1747,7 @@
|
|
|
1734
1747
|
]
|
|
1735
1748
|
},
|
|
1736
1749
|
{
|
|
1737
|
-
"name": "build [pattern]",
|
|
1750
|
+
"name": "build [component-pattern]",
|
|
1738
1751
|
"alias": "",
|
|
1739
1752
|
"options": [
|
|
1740
1753
|
[
|
|
@@ -1776,7 +1789,13 @@
|
|
|
1776
1789
|
"description": "run set of tasks for build",
|
|
1777
1790
|
"extendedDescription": "",
|
|
1778
1791
|
"group": "development",
|
|
1779
|
-
"private": false
|
|
1792
|
+
"private": false,
|
|
1793
|
+
"arguments": [
|
|
1794
|
+
{
|
|
1795
|
+
"name": "component-pattern",
|
|
1796
|
+
"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"
|
|
1797
|
+
}
|
|
1798
|
+
]
|
|
1780
1799
|
},
|
|
1781
1800
|
{
|
|
1782
1801
|
"name": "artifacts <pattern...>",
|
|
@@ -1924,7 +1943,7 @@
|
|
|
1924
1943
|
"private": true
|
|
1925
1944
|
},
|
|
1926
1945
|
{
|
|
1927
|
-
"name": "tag [component-
|
|
1946
|
+
"name": "tag [component-patterns...]",
|
|
1928
1947
|
"alias": "t",
|
|
1929
1948
|
"options": [
|
|
1930
1949
|
[
|
|
@@ -2054,14 +2073,14 @@
|
|
|
2054
2073
|
]
|
|
2055
2074
|
],
|
|
2056
2075
|
"description": "create an immutable and exportable component snapshot, tagged with a release version.",
|
|
2057
|
-
"extendedDescription": "if no
|
|
2076
|
+
"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",
|
|
2058
2077
|
"group": "development",
|
|
2059
2078
|
"private": false,
|
|
2060
2079
|
"remoteOp": true,
|
|
2061
2080
|
"arguments": [
|
|
2062
2081
|
{
|
|
2063
|
-
"name": "component-
|
|
2064
|
-
"description": "a list of component names or
|
|
2082
|
+
"name": "component-patterns...",
|
|
2083
|
+
"description": "a list of component names, IDs or patterns (separated by space). run \"bit pattern --help\" to get more data about patterns. By default, all modified are tagged."
|
|
2065
2084
|
}
|
|
2066
2085
|
],
|
|
2067
2086
|
"examples": [
|
|
@@ -2352,7 +2371,7 @@
|
|
|
2352
2371
|
[
|
|
2353
2372
|
"s",
|
|
2354
2373
|
"scope <scope-name>",
|
|
2355
|
-
"name of the scope to test"
|
|
2374
|
+
"DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
|
|
2356
2375
|
]
|
|
2357
2376
|
],
|
|
2358
2377
|
"description": "test components in the workspace",
|
|
@@ -2362,7 +2381,7 @@
|
|
|
2362
2381
|
"arguments": [
|
|
2363
2382
|
{
|
|
2364
2383
|
"name": "component-pattern",
|
|
2365
|
-
"description": "
|
|
2384
|
+
"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"
|
|
2366
2385
|
}
|
|
2367
2386
|
]
|
|
2368
2387
|
},
|
|
@@ -2377,12 +2396,12 @@
|
|
|
2377
2396
|
]
|
|
2378
2397
|
],
|
|
2379
2398
|
"description": "shows the API schema of a certain component.",
|
|
2380
|
-
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"
|
|
2399
|
+
"extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
2381
2400
|
"group": "development",
|
|
2382
2401
|
"private": false
|
|
2383
2402
|
},
|
|
2384
2403
|
{
|
|
2385
|
-
"name": "check-types [pattern]",
|
|
2404
|
+
"name": "check-types [component-pattern]",
|
|
2386
2405
|
"alias": "",
|
|
2387
2406
|
"options": [
|
|
2388
2407
|
[
|
|
@@ -2399,7 +2418,13 @@
|
|
|
2399
2418
|
"description": "check typescript types",
|
|
2400
2419
|
"extendedDescription": "",
|
|
2401
2420
|
"group": "development",
|
|
2402
|
-
"private": false
|
|
2421
|
+
"private": false,
|
|
2422
|
+
"arguments": [
|
|
2423
|
+
{
|
|
2424
|
+
"name": "component-pattern",
|
|
2425
|
+
"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"
|
|
2426
|
+
}
|
|
2427
|
+
]
|
|
2403
2428
|
},
|
|
2404
2429
|
{
|
|
2405
2430
|
"name": "aspect <sub-command>",
|
|
@@ -2421,12 +2446,18 @@
|
|
|
2421
2446
|
]
|
|
2422
2447
|
],
|
|
2423
2448
|
"description": "list all aspects configured on component(s)",
|
|
2424
|
-
"extendedDescription": "
|
|
2449
|
+
"extendedDescription": "",
|
|
2425
2450
|
"group": "development",
|
|
2426
|
-
"private": false
|
|
2451
|
+
"private": false,
|
|
2452
|
+
"arguments": [
|
|
2453
|
+
{
|
|
2454
|
+
"name": "pattern",
|
|
2455
|
+
"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"
|
|
2456
|
+
}
|
|
2457
|
+
]
|
|
2427
2458
|
},
|
|
2428
2459
|
{
|
|
2429
|
-
"name": "get <component-
|
|
2460
|
+
"name": "get <component-name>",
|
|
2430
2461
|
"alias": "",
|
|
2431
2462
|
"options": [
|
|
2432
2463
|
[
|
|
@@ -2440,37 +2471,87 @@
|
|
|
2440
2471
|
"format as json"
|
|
2441
2472
|
]
|
|
2442
2473
|
],
|
|
2443
|
-
"description": "
|
|
2474
|
+
"description": "list the aspects set on a component, as well as their config and data",
|
|
2444
2475
|
"extendedDescription": "",
|
|
2445
2476
|
"group": "development",
|
|
2446
|
-
"private": false
|
|
2477
|
+
"private": false,
|
|
2478
|
+
"arguments": [
|
|
2479
|
+
{
|
|
2480
|
+
"name": "component-name",
|
|
2481
|
+
"description": "the component name or component id"
|
|
2482
|
+
}
|
|
2483
|
+
]
|
|
2447
2484
|
},
|
|
2448
2485
|
{
|
|
2449
2486
|
"name": "set <pattern> <aspect-id> [config]",
|
|
2450
2487
|
"alias": "",
|
|
2451
2488
|
"options": [],
|
|
2452
|
-
"description": "set an aspect to
|
|
2453
|
-
"extendedDescription": "
|
|
2489
|
+
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|
|
2490
|
+
"extendedDescription": "",
|
|
2454
2491
|
"group": "development",
|
|
2455
|
-
"private": false
|
|
2492
|
+
"private": false,
|
|
2493
|
+
"arguments": [
|
|
2494
|
+
{
|
|
2495
|
+
"name": "pattern",
|
|
2496
|
+
"description": "the components to extend. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
"name": "aspect-id",
|
|
2500
|
+
"description": "the aspect's component id"
|
|
2501
|
+
},
|
|
2502
|
+
{
|
|
2503
|
+
"name": "config",
|
|
2504
|
+
"description": "the aspect config. enter the config as a stringified JSON (e.g. '{\"foo\":\"bar\"}' ). when no config is provided, an aspect is set with an empty config ({})."
|
|
2505
|
+
}
|
|
2506
|
+
]
|
|
2456
2507
|
},
|
|
2457
2508
|
{
|
|
2458
2509
|
"name": "unset <pattern> <aspect-id>",
|
|
2459
2510
|
"alias": "",
|
|
2460
2511
|
"options": [],
|
|
2461
2512
|
"description": "unset an aspect from component(s).",
|
|
2462
|
-
"extendedDescription": "
|
|
2513
|
+
"extendedDescription": "",
|
|
2463
2514
|
"group": "development",
|
|
2464
|
-
"private": false
|
|
2515
|
+
"private": false,
|
|
2516
|
+
"arguments": [
|
|
2517
|
+
{
|
|
2518
|
+
"name": "pattern",
|
|
2519
|
+
"description": "the components to target. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
|
|
2520
|
+
},
|
|
2521
|
+
{
|
|
2522
|
+
"name": "aspect-id",
|
|
2523
|
+
"description": "the aspect's component id"
|
|
2524
|
+
}
|
|
2525
|
+
]
|
|
2465
2526
|
},
|
|
2466
2527
|
{
|
|
2467
2528
|
"name": "update <aspect-id> [pattern]",
|
|
2468
2529
|
"alias": "",
|
|
2469
2530
|
"options": [],
|
|
2470
2531
|
"description": "update a version of an aspect",
|
|
2471
|
-
"extendedDescription": "
|
|
2532
|
+
"extendedDescription": "",
|
|
2472
2533
|
"group": "development",
|
|
2473
|
-
"private": false
|
|
2534
|
+
"private": false,
|
|
2535
|
+
"arguments": [
|
|
2536
|
+
{
|
|
2537
|
+
"name": "aspect-id",
|
|
2538
|
+
"description": "the aspect's component id"
|
|
2539
|
+
},
|
|
2540
|
+
{
|
|
2541
|
+
"name": "pattern",
|
|
2542
|
+
"description": "the components to update (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\". wrap the pattern with quotes"
|
|
2543
|
+
}
|
|
2544
|
+
],
|
|
2545
|
+
"examples": [
|
|
2546
|
+
{
|
|
2547
|
+
"cmd": "update scope.org/aspect '**/ui/**'",
|
|
2548
|
+
"description": "update \"ui\" components that use scope.org/aspect to use its latest version"
|
|
2549
|
+
},
|
|
2550
|
+
{
|
|
2551
|
+
"cmd": "bit aspect update scope.org/aspect@2.0.0",
|
|
2552
|
+
"description": "update all components that use scope.org/aspect to version 2.0.0 (of this aspect)."
|
|
2553
|
+
}
|
|
2554
|
+
]
|
|
2474
2555
|
}
|
|
2475
2556
|
]
|
|
2476
2557
|
},
|
|
@@ -2552,31 +2633,41 @@
|
|
|
2552
2633
|
"skipWorkspace": true
|
|
2553
2634
|
},
|
|
2554
2635
|
{
|
|
2555
|
-
"name": "rename <
|
|
2636
|
+
"name": "rename <current-name> <new-name>",
|
|
2556
2637
|
"alias": "",
|
|
2557
2638
|
"options": [
|
|
2558
2639
|
[
|
|
2559
2640
|
"s",
|
|
2560
|
-
"scope <
|
|
2641
|
+
"scope <scope-name>",
|
|
2561
2642
|
"default scope for the newly created component"
|
|
2562
2643
|
],
|
|
2563
2644
|
[
|
|
2564
2645
|
"p",
|
|
2565
|
-
"path <
|
|
2646
|
+
"path <relative-path>",
|
|
2566
2647
|
"relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
|
|
2567
2648
|
],
|
|
2568
2649
|
[
|
|
2569
2650
|
"r",
|
|
2570
2651
|
"refactor",
|
|
2571
|
-
"
|
|
2652
|
+
"update the import/require statements in all dependent components (in the same workspace)"
|
|
2572
2653
|
]
|
|
2573
2654
|
],
|
|
2574
|
-
"description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the
|
|
2575
|
-
"extendedDescription": "
|
|
2655
|
+
"description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
|
|
2656
|
+
"extendedDescription": "",
|
|
2576
2657
|
"group": "collaborate",
|
|
2577
2658
|
"private": false,
|
|
2578
2659
|
"remoteOp": true,
|
|
2579
|
-
"skipWorkspace": true
|
|
2660
|
+
"skipWorkspace": true,
|
|
2661
|
+
"arguments": [
|
|
2662
|
+
{
|
|
2663
|
+
"name": "current-name",
|
|
2664
|
+
"description": "the current component name (without its scope name)"
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"name": "new-name",
|
|
2668
|
+
"description": "the new component name (without its scope name)"
|
|
2669
|
+
}
|
|
2670
|
+
]
|
|
2580
2671
|
},
|
|
2581
2672
|
{
|
|
2582
2673
|
"name": "fork <source-component-id> [target-component-name]",
|
|
@@ -2850,7 +2941,13 @@
|
|
|
2850
2941
|
"description": "remove lanes",
|
|
2851
2942
|
"extendedDescription": "",
|
|
2852
2943
|
"group": "ungrouped",
|
|
2853
|
-
"private": true
|
|
2944
|
+
"private": true,
|
|
2945
|
+
"arguments": [
|
|
2946
|
+
{
|
|
2947
|
+
"name": "lanes...",
|
|
2948
|
+
"description": "A list of lane names, separated by spaces"
|
|
2949
|
+
}
|
|
2950
|
+
]
|
|
2854
2951
|
},
|
|
2855
2952
|
{
|
|
2856
2953
|
"name": "change-scope <lane-name> <remote-scope-name>",
|
|
@@ -2898,7 +2995,17 @@
|
|
|
2898
2995
|
"extendedDescription": "",
|
|
2899
2996
|
"group": "ungrouped",
|
|
2900
2997
|
"private": true,
|
|
2901
|
-
"skipWorkspace": false
|
|
2998
|
+
"skipWorkspace": false,
|
|
2999
|
+
"arguments": [
|
|
3000
|
+
{
|
|
3001
|
+
"name": "component-id",
|
|
3002
|
+
"description": "the component name or id of the component to use as the lane's readme"
|
|
3003
|
+
},
|
|
3004
|
+
{
|
|
3005
|
+
"name": "lane-name",
|
|
3006
|
+
"description": "the lane to attach the readme to (defaults to the current lane)"
|
|
3007
|
+
}
|
|
3008
|
+
]
|
|
2902
3009
|
},
|
|
2903
3010
|
{
|
|
2904
3011
|
"name": "remove-readme [laneName]",
|
|
@@ -2923,7 +3030,13 @@
|
|
|
2923
3030
|
"description": "import a remote lane to your workspace",
|
|
2924
3031
|
"extendedDescription": "",
|
|
2925
3032
|
"group": "ungrouped",
|
|
2926
|
-
"private": true
|
|
3033
|
+
"private": true,
|
|
3034
|
+
"arguments": [
|
|
3035
|
+
{
|
|
3036
|
+
"name": "lane",
|
|
3037
|
+
"description": "the remote lane name"
|
|
3038
|
+
}
|
|
3039
|
+
]
|
|
2927
3040
|
}
|
|
2928
3041
|
]
|
|
2929
3042
|
},
|
|
@@ -2963,7 +3076,7 @@
|
|
|
2963
3076
|
"private": true
|
|
2964
3077
|
},
|
|
2965
3078
|
{
|
|
2966
|
-
"name": "eject <pattern>",
|
|
3079
|
+
"name": "eject <component-pattern>",
|
|
2967
3080
|
"alias": "E",
|
|
2968
3081
|
"options": [
|
|
2969
3082
|
[
|
|
@@ -2982,10 +3095,16 @@
|
|
|
2982
3095
|
"keep the component files in the workspace intact"
|
|
2983
3096
|
]
|
|
2984
3097
|
],
|
|
2985
|
-
"description": "
|
|
2986
|
-
"extendedDescription": "
|
|
3098
|
+
"description": "replace components maintained in the workspace with their corresponding packages",
|
|
3099
|
+
"extendedDescription": "",
|
|
2987
3100
|
"group": "development",
|
|
2988
|
-
"private": false
|
|
3101
|
+
"private": false,
|
|
3102
|
+
"arguments": [
|
|
3103
|
+
{
|
|
3104
|
+
"name": "component-pattern",
|
|
3105
|
+
"description": "component name, component id, or component pattern.\nuse component pattern to select multiple components. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
|
|
3106
|
+
}
|
|
3107
|
+
]
|
|
2989
3108
|
},
|
|
2990
3109
|
{
|
|
2991
3110
|
"name": "resume-export <export-id> <remotes...>",
|
|
@@ -3039,7 +3158,7 @@
|
|
|
3039
3158
|
[
|
|
3040
3159
|
"",
|
|
3041
3160
|
"origin-directly",
|
|
3042
|
-
"
|
|
3161
|
+
"EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended!"
|
|
3043
3162
|
],
|
|
3044
3163
|
[
|
|
3045
3164
|
"",
|