@teambit/harmony.content.cli-reference 1.95.76 → 1.95.78
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 +156 -156
- package/cli-reference.mdx +34 -34
- package/dist/cli-reference.json +156 -156
- package/dist/cli-reference.mdx.js +58 -58
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.78.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1663990632780.js → preview-1664854758941.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.76.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -1455,122 +1455,6 @@
|
|
|
1455
1455
|
"group": "ungrouped",
|
|
1456
1456
|
"private": true
|
|
1457
1457
|
},
|
|
1458
|
-
{
|
|
1459
|
-
"name": "install [packages...]",
|
|
1460
|
-
"alias": "in",
|
|
1461
|
-
"options": [
|
|
1462
|
-
[
|
|
1463
|
-
"v",
|
|
1464
|
-
"variants <variants>",
|
|
1465
|
-
"add packages to specific variants"
|
|
1466
|
-
],
|
|
1467
|
-
[
|
|
1468
|
-
"t",
|
|
1469
|
-
"type [lifecycleType]",
|
|
1470
|
-
"\"runtime\" (default) or \"peer\" (dev is not a valid option)"
|
|
1471
|
-
],
|
|
1472
|
-
[
|
|
1473
|
-
"u",
|
|
1474
|
-
"update-existing [updateExisting]",
|
|
1475
|
-
"update existing dependencies version and types"
|
|
1476
|
-
],
|
|
1477
|
-
[
|
|
1478
|
-
"",
|
|
1479
|
-
"save-prefix [savePrefix]",
|
|
1480
|
-
"set the prefix to use when adding dependency to workspace.jsonc"
|
|
1481
|
-
],
|
|
1482
|
-
[
|
|
1483
|
-
"",
|
|
1484
|
-
"skip-dedupe [skipDedupe]",
|
|
1485
|
-
"do not dedupe dependencies on installation"
|
|
1486
|
-
],
|
|
1487
|
-
[
|
|
1488
|
-
"",
|
|
1489
|
-
"skip-import [skipImport]",
|
|
1490
|
-
"do not import bit objects post installation"
|
|
1491
|
-
],
|
|
1492
|
-
[
|
|
1493
|
-
"",
|
|
1494
|
-
"add-missing-peers [addMissingPeers]",
|
|
1495
|
-
"install all missing peer dependencies"
|
|
1496
|
-
]
|
|
1497
|
-
],
|
|
1498
|
-
"description": "installs workspace dependencies",
|
|
1499
|
-
"extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
|
|
1500
|
-
"group": "development",
|
|
1501
|
-
"private": false,
|
|
1502
|
-
"arguments": [
|
|
1503
|
-
{
|
|
1504
|
-
"name": "packages...",
|
|
1505
|
-
"description": "a list of packages to install (separated by spaces)"
|
|
1506
|
-
}
|
|
1507
|
-
]
|
|
1508
|
-
},
|
|
1509
|
-
{
|
|
1510
|
-
"name": "uninstall [packages...]",
|
|
1511
|
-
"alias": "un",
|
|
1512
|
-
"options": [],
|
|
1513
|
-
"description": "uninstall dependencies",
|
|
1514
|
-
"extendedDescription": "",
|
|
1515
|
-
"group": "development",
|
|
1516
|
-
"private": false
|
|
1517
|
-
},
|
|
1518
|
-
{
|
|
1519
|
-
"name": "update",
|
|
1520
|
-
"alias": "up",
|
|
1521
|
-
"options": [
|
|
1522
|
-
[
|
|
1523
|
-
"y",
|
|
1524
|
-
"yes",
|
|
1525
|
-
"automatically update all outdated packages"
|
|
1526
|
-
]
|
|
1527
|
-
],
|
|
1528
|
-
"description": "update dependencies",
|
|
1529
|
-
"extendedDescription": "",
|
|
1530
|
-
"group": "development",
|
|
1531
|
-
"private": false
|
|
1532
|
-
},
|
|
1533
|
-
{
|
|
1534
|
-
"name": "link [component-names...]",
|
|
1535
|
-
"alias": "",
|
|
1536
|
-
"options": [
|
|
1537
|
-
[
|
|
1538
|
-
"j",
|
|
1539
|
-
"json",
|
|
1540
|
-
"return the output as JSON"
|
|
1541
|
-
],
|
|
1542
|
-
[
|
|
1543
|
-
"",
|
|
1544
|
-
"verbose",
|
|
1545
|
-
"verbose output"
|
|
1546
|
-
],
|
|
1547
|
-
[
|
|
1548
|
-
"r",
|
|
1549
|
-
"rewire",
|
|
1550
|
-
"Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
|
|
1551
|
-
],
|
|
1552
|
-
[
|
|
1553
|
-
"",
|
|
1554
|
-
"target <dir>",
|
|
1555
|
-
"EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1556
|
-
],
|
|
1557
|
-
[
|
|
1558
|
-
"",
|
|
1559
|
-
"skip-fetching-objects",
|
|
1560
|
-
"skip fetch missing objects from remotes before linking"
|
|
1561
|
-
]
|
|
1562
|
-
],
|
|
1563
|
-
"description": "create links in the node_modules directory, to core aspects and to components in the workspace",
|
|
1564
|
-
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1565
|
-
"group": "development",
|
|
1566
|
-
"private": false,
|
|
1567
|
-
"arguments": [
|
|
1568
|
-
{
|
|
1569
|
-
"name": "component-names...",
|
|
1570
|
-
"description": "names or IDs of the components to link"
|
|
1571
|
-
}
|
|
1572
|
-
]
|
|
1573
|
-
},
|
|
1574
1458
|
{
|
|
1575
1459
|
"name": "create <template-name> <component-names...>",
|
|
1576
1460
|
"alias": "",
|
|
@@ -1791,6 +1675,158 @@
|
|
|
1791
1675
|
}
|
|
1792
1676
|
]
|
|
1793
1677
|
},
|
|
1678
|
+
{
|
|
1679
|
+
"name": "compile [component-names...]",
|
|
1680
|
+
"alias": "",
|
|
1681
|
+
"options": [
|
|
1682
|
+
[
|
|
1683
|
+
"c",
|
|
1684
|
+
"changed",
|
|
1685
|
+
"compile only new and modified components"
|
|
1686
|
+
],
|
|
1687
|
+
[
|
|
1688
|
+
"v",
|
|
1689
|
+
"verbose",
|
|
1690
|
+
"show more data, such as, dist paths"
|
|
1691
|
+
],
|
|
1692
|
+
[
|
|
1693
|
+
"j",
|
|
1694
|
+
"json",
|
|
1695
|
+
"return the compile results in json format"
|
|
1696
|
+
],
|
|
1697
|
+
[
|
|
1698
|
+
"d",
|
|
1699
|
+
"delete-dist-dir",
|
|
1700
|
+
"delete existing dist folder before writing new compiled files"
|
|
1701
|
+
]
|
|
1702
|
+
],
|
|
1703
|
+
"description": "compile components in the workspace",
|
|
1704
|
+
"extendedDescription": "",
|
|
1705
|
+
"group": "development",
|
|
1706
|
+
"private": false,
|
|
1707
|
+
"arguments": [
|
|
1708
|
+
{
|
|
1709
|
+
"name": "component-names...",
|
|
1710
|
+
"description": "a list of component names or component IDs (defaults to all components)"
|
|
1711
|
+
}
|
|
1712
|
+
]
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"name": "install [packages...]",
|
|
1716
|
+
"alias": "in",
|
|
1717
|
+
"options": [
|
|
1718
|
+
[
|
|
1719
|
+
"v",
|
|
1720
|
+
"variants <variants>",
|
|
1721
|
+
"add packages to specific variants"
|
|
1722
|
+
],
|
|
1723
|
+
[
|
|
1724
|
+
"t",
|
|
1725
|
+
"type [lifecycleType]",
|
|
1726
|
+
"\"runtime\" (default) or \"peer\" (dev is not a valid option)"
|
|
1727
|
+
],
|
|
1728
|
+
[
|
|
1729
|
+
"u",
|
|
1730
|
+
"update-existing [updateExisting]",
|
|
1731
|
+
"update existing dependencies version and types"
|
|
1732
|
+
],
|
|
1733
|
+
[
|
|
1734
|
+
"",
|
|
1735
|
+
"save-prefix [savePrefix]",
|
|
1736
|
+
"set the prefix to use when adding dependency to workspace.jsonc"
|
|
1737
|
+
],
|
|
1738
|
+
[
|
|
1739
|
+
"",
|
|
1740
|
+
"skip-dedupe [skipDedupe]",
|
|
1741
|
+
"do not dedupe dependencies on installation"
|
|
1742
|
+
],
|
|
1743
|
+
[
|
|
1744
|
+
"",
|
|
1745
|
+
"skip-import [skipImport]",
|
|
1746
|
+
"do not import bit objects post installation"
|
|
1747
|
+
],
|
|
1748
|
+
[
|
|
1749
|
+
"",
|
|
1750
|
+
"add-missing-peers [addMissingPeers]",
|
|
1751
|
+
"install all missing peer dependencies"
|
|
1752
|
+
]
|
|
1753
|
+
],
|
|
1754
|
+
"description": "installs workspace dependencies",
|
|
1755
|
+
"extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
|
|
1756
|
+
"group": "development",
|
|
1757
|
+
"private": false,
|
|
1758
|
+
"arguments": [
|
|
1759
|
+
{
|
|
1760
|
+
"name": "packages...",
|
|
1761
|
+
"description": "a list of packages to install (separated by spaces)"
|
|
1762
|
+
}
|
|
1763
|
+
]
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
"name": "uninstall [packages...]",
|
|
1767
|
+
"alias": "un",
|
|
1768
|
+
"options": [],
|
|
1769
|
+
"description": "uninstall dependencies",
|
|
1770
|
+
"extendedDescription": "",
|
|
1771
|
+
"group": "development",
|
|
1772
|
+
"private": false
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"name": "update",
|
|
1776
|
+
"alias": "up",
|
|
1777
|
+
"options": [
|
|
1778
|
+
[
|
|
1779
|
+
"y",
|
|
1780
|
+
"yes",
|
|
1781
|
+
"automatically update all outdated packages"
|
|
1782
|
+
]
|
|
1783
|
+
],
|
|
1784
|
+
"description": "update dependencies",
|
|
1785
|
+
"extendedDescription": "",
|
|
1786
|
+
"group": "development",
|
|
1787
|
+
"private": false
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
"name": "link [component-names...]",
|
|
1791
|
+
"alias": "",
|
|
1792
|
+
"options": [
|
|
1793
|
+
[
|
|
1794
|
+
"j",
|
|
1795
|
+
"json",
|
|
1796
|
+
"return the output as JSON"
|
|
1797
|
+
],
|
|
1798
|
+
[
|
|
1799
|
+
"",
|
|
1800
|
+
"verbose",
|
|
1801
|
+
"verbose output"
|
|
1802
|
+
],
|
|
1803
|
+
[
|
|
1804
|
+
"r",
|
|
1805
|
+
"rewire",
|
|
1806
|
+
"Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
|
|
1807
|
+
],
|
|
1808
|
+
[
|
|
1809
|
+
"",
|
|
1810
|
+
"target <dir>",
|
|
1811
|
+
"EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
|
|
1812
|
+
],
|
|
1813
|
+
[
|
|
1814
|
+
"",
|
|
1815
|
+
"skip-fetching-objects",
|
|
1816
|
+
"skip fetch missing objects from remotes before linking"
|
|
1817
|
+
]
|
|
1818
|
+
],
|
|
1819
|
+
"description": "create links in the node_modules directory, to core aspects and to components in the workspace",
|
|
1820
|
+
"extendedDescription": "https://bit.dev/docs/workspace/component-links",
|
|
1821
|
+
"group": "development",
|
|
1822
|
+
"private": false,
|
|
1823
|
+
"arguments": [
|
|
1824
|
+
{
|
|
1825
|
+
"name": "component-names...",
|
|
1826
|
+
"description": "names or IDs of the components to link"
|
|
1827
|
+
}
|
|
1828
|
+
]
|
|
1829
|
+
},
|
|
1794
1830
|
{
|
|
1795
1831
|
"name": "insights [names...]",
|
|
1796
1832
|
"alias": "",
|
|
@@ -2703,8 +2739,8 @@
|
|
|
2703
2739
|
]
|
|
2704
2740
|
},
|
|
2705
2741
|
{
|
|
2706
|
-
"name": "
|
|
2707
|
-
"alias": "
|
|
2742
|
+
"name": "deps <sub-command>",
|
|
2743
|
+
"alias": "dependencies",
|
|
2708
2744
|
"options": [],
|
|
2709
2745
|
"description": "manage dependencies",
|
|
2710
2746
|
"extendedDescription": "",
|
|
@@ -2746,7 +2782,7 @@
|
|
|
2746
2782
|
"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"
|
|
2747
2783
|
},
|
|
2748
2784
|
{
|
|
2749
|
-
"name": "package",
|
|
2785
|
+
"name": "package...",
|
|
2750
2786
|
"description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
|
|
2751
2787
|
}
|
|
2752
2788
|
]
|
|
@@ -2791,7 +2827,7 @@
|
|
|
2791
2827
|
"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"
|
|
2792
2828
|
},
|
|
2793
2829
|
{
|
|
2794
|
-
"name": "package",
|
|
2830
|
+
"name": "package...",
|
|
2795
2831
|
"description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
|
|
2796
2832
|
}
|
|
2797
2833
|
]
|
|
@@ -2946,42 +2982,6 @@
|
|
|
2946
2982
|
"group": "development",
|
|
2947
2983
|
"private": false
|
|
2948
2984
|
},
|
|
2949
|
-
{
|
|
2950
|
-
"name": "compile [component-names...]",
|
|
2951
|
-
"alias": "",
|
|
2952
|
-
"options": [
|
|
2953
|
-
[
|
|
2954
|
-
"c",
|
|
2955
|
-
"changed",
|
|
2956
|
-
"compile only new and modified components"
|
|
2957
|
-
],
|
|
2958
|
-
[
|
|
2959
|
-
"v",
|
|
2960
|
-
"verbose",
|
|
2961
|
-
"show more data, such as, dist paths"
|
|
2962
|
-
],
|
|
2963
|
-
[
|
|
2964
|
-
"j",
|
|
2965
|
-
"json",
|
|
2966
|
-
"return the compile results in json format"
|
|
2967
|
-
],
|
|
2968
|
-
[
|
|
2969
|
-
"d",
|
|
2970
|
-
"delete-dist-dir",
|
|
2971
|
-
"delete existing dist folder before writing new compiled files"
|
|
2972
|
-
]
|
|
2973
|
-
],
|
|
2974
|
-
"description": "compile components in the workspace",
|
|
2975
|
-
"extendedDescription": "",
|
|
2976
|
-
"group": "development",
|
|
2977
|
-
"private": false,
|
|
2978
|
-
"arguments": [
|
|
2979
|
-
{
|
|
2980
|
-
"name": "component-names...",
|
|
2981
|
-
"description": "a list of component names or component IDs (defaults to all components)"
|
|
2982
|
-
}
|
|
2983
|
-
]
|
|
2984
|
-
},
|
|
2985
2985
|
{
|
|
2986
2986
|
"name": "run <app-name>",
|
|
2987
2987
|
"alias": "c",
|
package/cli-reference.mdx
CHANGED
|
@@ -368,17 +368,40 @@ https://bit.dev/docs/config/bit-config
|
|
|
368
368
|
|
|
369
369
|
---
|
|
370
370
|
|
|
371
|
-
##
|
|
371
|
+
## dependents
|
|
372
|
+
|
|
373
|
+
**Workspace only**: yes
|
|
374
|
+
**Description**: EXPERIMENTAL. show dependents of the given component
|
|
375
|
+
|
|
376
|
+
`bit dependents <component-name>`
|
|
377
|
+
|
|
378
|
+
---
|
|
379
|
+
|
|
380
|
+
## deprecate
|
|
381
|
+
|
|
382
|
+
**Alias**: `d`
|
|
383
|
+
**Workspace only**: no
|
|
384
|
+
**Description**: deprecate a component
|
|
385
|
+
|
|
386
|
+
`bit deprecate <component-name>`
|
|
387
|
+
|
|
388
|
+
| **Option** | **Option alias** | **Description** |
|
|
389
|
+
| ------------------- | :--------------: | ------------------------------------------------------------ |
|
|
390
|
+
| `--new-id <string>` | | if replaced by another component, enter the new component id |
|
|
391
|
+
|
|
392
|
+
---
|
|
393
|
+
|
|
394
|
+
## deps
|
|
372
395
|
|
|
373
|
-
**Alias**: `
|
|
396
|
+
**Alias**: `dependencies`
|
|
374
397
|
**Workspace only**: yes
|
|
375
398
|
**Description**: manage dependencies
|
|
376
399
|
|
|
377
|
-
`bit
|
|
400
|
+
`bit deps <sub-command>`
|
|
378
401
|
|
|
379
|
-
###
|
|
402
|
+
### deps get
|
|
380
403
|
|
|
381
|
-
**Usage**: `
|
|
404
|
+
**Usage**: `deps get <component-name>`
|
|
382
405
|
|
|
383
406
|
**Description**: show direct and indirect dependencies of the given component
|
|
384
407
|
|
|
@@ -386,21 +409,21 @@ https://bit.dev/docs/config/bit-config
|
|
|
386
409
|
| ---------- | :--------------: | ---------------------------------------------------------------- |
|
|
387
410
|
| `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
|
|
388
411
|
|
|
389
|
-
###
|
|
412
|
+
### deps remove
|
|
390
413
|
|
|
391
|
-
**Usage**: `
|
|
414
|
+
**Usage**: `deps remove <component-pattern> <package...>`
|
|
392
415
|
|
|
393
416
|
**Description**: remove a dependency to component(s)
|
|
394
417
|
|
|
395
|
-
###
|
|
418
|
+
### deps debug
|
|
396
419
|
|
|
397
|
-
**Usage**: `
|
|
420
|
+
**Usage**: `deps debug <component-name>`
|
|
398
421
|
|
|
399
422
|
**Description**: show the immediate dependencies and how their versions were determined
|
|
400
423
|
|
|
401
|
-
###
|
|
424
|
+
### deps set
|
|
402
425
|
|
|
403
|
-
**Usage**: `
|
|
426
|
+
**Usage**: `deps set <component-pattern> <package...>`
|
|
404
427
|
|
|
405
428
|
**Description**: set a dependency to component(s)
|
|
406
429
|
|
|
@@ -411,29 +434,6 @@ https://bit.dev/docs/config/bit-config
|
|
|
411
434
|
|
|
412
435
|
---
|
|
413
436
|
|
|
414
|
-
## dependents
|
|
415
|
-
|
|
416
|
-
**Workspace only**: yes
|
|
417
|
-
**Description**: EXPERIMENTAL. show dependents of the given component
|
|
418
|
-
|
|
419
|
-
`bit dependents <component-name>`
|
|
420
|
-
|
|
421
|
-
---
|
|
422
|
-
|
|
423
|
-
## deprecate
|
|
424
|
-
|
|
425
|
-
**Alias**: `d`
|
|
426
|
-
**Workspace only**: no
|
|
427
|
-
**Description**: deprecate a component
|
|
428
|
-
|
|
429
|
-
`bit deprecate <component-name>`
|
|
430
|
-
|
|
431
|
-
| **Option** | **Option alias** | **Description** |
|
|
432
|
-
| ------------------- | :--------------: | ------------------------------------------------------------ |
|
|
433
|
-
| `--new-id <string>` | | if replaced by another component, enter the new component id |
|
|
434
|
-
|
|
435
|
-
---
|
|
436
|
-
|
|
437
437
|
## diff
|
|
438
438
|
|
|
439
439
|
**Workspace only**: yes
|