@teambit/harmony.content.cli-reference 1.95.56 → 1.95.57

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.
@@ -469,47 +469,6 @@
469
469
  "group": "development",
470
470
  "private": false
471
471
  },
472
- {
473
- "name": "remove <component-ids...>",
474
- "alias": "rm",
475
- "options": [
476
- [
477
- "r",
478
- "remote",
479
- "remove a component from a remote scope"
480
- ],
481
- [
482
- "t",
483
- "track",
484
- "keep tracking component in .bitmap (default = false), helps transform a tagged-component to new"
485
- ],
486
- [
487
- "d",
488
- "delete-files",
489
- "DEPRECATED (this is now the default). delete local component files"
490
- ],
491
- [
492
- "",
493
- "keep-files",
494
- "keep component files (just untrack the component)"
495
- ],
496
- [
497
- "f",
498
- "force",
499
- "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
500
- ],
501
- [
502
- "s",
503
- "silent",
504
- "skip confirmation"
505
- ]
506
- ],
507
- "description": "remove component(s) from the workspace, or a remote scope",
508
- "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)",
509
- "group": "collaborate",
510
- "private": false,
511
- "skipWorkspace": true
512
- },
513
472
  {
514
473
  "name": "_delete <path> <args>",
515
474
  "alias": "",
@@ -839,21 +798,6 @@
839
798
  "group": "general",
840
799
  "private": false
841
800
  },
842
- {
843
- "name": "globals",
844
- "alias": "",
845
- "options": [
846
- [
847
- "j",
848
- "json",
849
- "json format"
850
- ]
851
- ],
852
- "description": "list all globals",
853
- "extendedDescription": "",
854
- "group": "workspace",
855
- "private": false
856
- },
857
801
  {
858
802
  "name": "show <component-name>",
859
803
  "alias": "",
@@ -990,6 +934,21 @@
990
934
  }
991
935
  ]
992
936
  },
937
+ {
938
+ "name": "globals",
939
+ "alias": "",
940
+ "options": [
941
+ [
942
+ "j",
943
+ "json",
944
+ "json format"
945
+ ]
946
+ ],
947
+ "description": "list all globals",
948
+ "extendedDescription": "",
949
+ "group": "workspace",
950
+ "private": false
951
+ },
993
952
  {
994
953
  "name": "start [type] [pattern]",
995
954
  "alias": "c",
@@ -1406,645 +1365,172 @@
1406
1365
  ]
1407
1366
  },
1408
1367
  {
1409
- "name": "dependencies <sub-command>",
1410
- "alias": "deps",
1411
- "options": [],
1412
- "description": "manage dependencies",
1413
- "extendedDescription": "",
1414
- "group": "info",
1415
- "private": false,
1416
- "commands": [
1417
- {
1418
- "name": "get <component-name>",
1419
- "alias": "",
1420
- "options": [
1421
- [
1422
- "t",
1423
- "tree",
1424
- "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
1425
- ]
1426
- ],
1427
- "description": "show direct and indirect dependencies of the given component",
1428
- "extendedDescription": "",
1429
- "group": "info",
1430
- "private": false,
1431
- "arguments": [
1432
- {
1433
- "name": "component-name",
1434
- "description": "component name or component id"
1435
- }
1436
- ]
1437
- },
1438
- {
1439
- "name": "remove <component-pattern> <package...>",
1440
- "alias": "",
1441
- "options": [],
1442
- "description": "remove a dependency to component(s)",
1443
- "extendedDescription": "",
1444
- "group": "info",
1445
- "private": false,
1446
- "arguments": [
1447
- {
1448
- "name": "component-pattern",
1449
- "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"
1450
- },
1451
- {
1452
- "name": "package",
1453
- "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"
1454
- }
1455
- ]
1456
- },
1457
- {
1458
- "name": "debug <component-name>",
1459
- "alias": "",
1460
- "options": [],
1461
- "description": "show the immediate dependencies and how their versions were determined",
1462
- "extendedDescription": "",
1463
- "group": "info",
1464
- "private": false,
1465
- "arguments": [
1466
- {
1467
- "name": "component-name",
1468
- "description": "component name or component id"
1469
- }
1470
- ]
1471
- },
1472
- {
1473
- "name": "set <component-pattern> <package...>",
1474
- "alias": "",
1475
- "options": [
1476
- [
1477
- "d",
1478
- "dev",
1479
- "add to the devDependencies"
1480
- ],
1481
- [
1482
- "p",
1483
- "peer",
1484
- "add to the peerDependencies"
1485
- ]
1486
- ],
1487
- "description": "set a dependency to component(s)",
1488
- "extendedDescription": "",
1489
- "group": "info",
1490
- "private": false,
1491
- "arguments": [
1492
- {
1493
- "name": "component-pattern",
1494
- "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"
1495
- },
1496
- {
1497
- "name": "package",
1498
- "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
1499
- }
1500
- ]
1501
- }
1502
- ]
1503
- },
1504
- {
1505
- "name": "list [remote-scope]",
1506
- "alias": "ls",
1368
+ "name": "remove <component-pattern>",
1369
+ "alias": "rm",
1507
1370
  "options": [
1508
1371
  [
1509
- "i",
1510
- "ids",
1511
- "show only component ids unformatted"
1372
+ "r",
1373
+ "remote",
1374
+ "remove a component from a remote scope"
1512
1375
  ],
1513
1376
  [
1514
- "s",
1515
- "scope",
1516
- "show only components stored in the local scope, including indirect dependencies"
1377
+ "t",
1378
+ "track",
1379
+ "keep tracking component in .bitmap (default = false), helps transform a tagged-component to new"
1517
1380
  ],
1518
1381
  [
1519
- "o",
1520
- "outdated",
1521
- "show latest versions from remotes"
1382
+ "d",
1383
+ "delete-files",
1384
+ "DEPRECATED (this is now the default). delete local component files"
1522
1385
  ],
1523
1386
  [
1524
- "j",
1525
- "json",
1526
- "show the output in JSON format"
1387
+ "",
1388
+ "keep-files",
1389
+ "keep component files (just untrack the component)"
1527
1390
  ],
1528
1391
  [
1529
- "n",
1530
- "namespace <string>",
1531
- "show only specified namespace by using wildcards"
1392
+ "f",
1393
+ "force",
1394
+ "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
1395
+ ],
1396
+ [
1397
+ "s",
1398
+ "silent",
1399
+ "skip confirmation"
1532
1400
  ]
1533
1401
  ],
1534
- "description": "list components on a workspace, local scope or a remote scope.",
1535
- "extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
1536
- "group": "discover",
1402
+ "description": "remove component(s) from the workspace, or a remote scope",
1403
+ "extendedDescription": "",
1404
+ "group": "collaborate",
1537
1405
  "private": false,
1538
1406
  "remoteOp": true,
1539
- "skipWorkspace": true
1407
+ "skipWorkspace": true,
1408
+ "arguments": [
1409
+ {
1410
+ "name": "component-pattern",
1411
+ "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"
1412
+ }
1413
+ ]
1540
1414
  },
1541
1415
  {
1542
- "name": "import [component-patterns...]",
1416
+ "name": "insights [names...]",
1543
1417
  "alias": "",
1544
1418
  "options": [
1545
1419
  [
1546
- "p",
1547
- "path <path>",
1548
- "import components into a specific directory (a relative path in the workspace)"
1549
- ],
1550
- [
1551
- "o",
1552
- "objects",
1553
- "import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument"
1554
- ],
1555
- [
1556
- "d",
1557
- "display-dependencies",
1558
- "display the imported dependencies"
1559
- ],
1560
- [
1561
- "O",
1562
- "override",
1563
- "override local changes"
1564
- ],
1565
- [
1566
- "v",
1567
- "verbose",
1568
- "show verbose output for inspection"
1420
+ "l",
1421
+ "list",
1422
+ "list all insights"
1569
1423
  ],
1570
1424
  [
1571
1425
  "j",
1572
1426
  "json",
1573
- "return the output as JSON"
1574
- ],
1575
- [
1576
- "",
1577
- "conf",
1578
- "write the configuration file (component.json) of the component"
1579
- ],
1580
- [
1581
- "",
1582
- "skip-npm-install",
1583
- "DEPRECATED. use \"--skip-dependency-installation\" instead"
1584
- ],
1585
- [
1586
- "",
1587
- "skip-dependency-installation",
1588
- "do not install packages of the imported components"
1589
- ],
1590
- [
1591
- "m",
1592
- "merge [strategy]",
1593
- "merge local changes with the imported version. strategy should be \"theirs\", \"ours\" or \"manual\""
1594
- ],
1595
- [
1596
- "",
1597
- "dependencies",
1598
- "EXPERIMENTAL. import all dependencies and write them to the workspace"
1599
- ],
1600
- [
1601
- "",
1602
- "dependents",
1603
- "EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents"
1604
- ],
1605
- [
1606
- "",
1607
- "save-in-lane",
1608
- "EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
1609
- ],
1610
- [
1611
- "",
1612
- "all-history",
1613
- "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
1614
- ]
1615
- ],
1616
- "description": "import components from their remote scopes to the local workspace",
1617
- "extendedDescription": "https://bit.dev/docs/components/importing-components\nyou can use a pattern for multiple ids, such as bit import \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
1618
- "group": "collaborate",
1619
- "private": false,
1620
- "remoteOp": true,
1621
- "arguments": [
1622
- {
1623
- "name": "component-patterns...",
1624
- "description": "component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., \"utils/*\" (wrap with double quotes)"
1625
- }
1626
- ]
1627
- },
1628
- {
1629
- "name": "create <template-name> <component-names...>",
1630
- "alias": "",
1631
- "options": [
1632
- [
1633
- "n",
1634
- "namespace <string>",
1635
- "sets the component's namespace and nested dirs inside the scope"
1636
- ],
1637
- [
1638
- "s",
1639
- "scope <string>",
1640
- "sets the component's scope-name. if not entered, the default-scope will be used"
1641
- ],
1642
- [
1643
- "a",
1644
- "aspect <string>",
1645
- "aspect-id of the template. helpful when multiple aspects use the same template name"
1646
- ],
1647
- [
1648
- "p",
1649
- "path <string>",
1650
- "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
1651
- ],
1652
- [
1653
- "e",
1654
- "env <string>",
1655
- "set the component's environment. (overrides the env from variants and the template)"
1427
+ "return the insights in json format"
1656
1428
  ]
1657
1429
  ],
1658
- "description": "create a new component (source files and config) using a template.",
1430
+ "description": "Insights on component graph",
1659
1431
  "extendedDescription": "",
1660
1432
  "group": "development",
1661
- "private": false,
1662
- "arguments": [
1663
- {
1664
- "name": "template-name",
1665
- "description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
1666
- },
1667
- {
1668
- "name": "component-names...",
1669
- "description": "a list of component names to generate"
1670
- }
1671
- ],
1672
- "examples": [
1673
- {
1674
- "cmd": "bit create react ui/button",
1675
- "description": "creates a component named 'ui/button' using the 'react' template"
1676
- },
1677
- {
1678
- "cmd": "bit create react ui/button pages/register",
1679
- "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
1680
- },
1681
- {
1682
- "cmd": "bit create react ui/button --scope my-org.my-scope",
1683
- "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
1684
- },
1685
- {
1686
- "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
1687
- "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
1688
- }
1689
- ]
1433
+ "private": true
1690
1434
  },
1691
1435
  {
1692
- "name": "templates",
1436
+ "name": "component-issues",
1693
1437
  "alias": "",
1694
1438
  "options": [
1695
1439
  [
1696
- "s",
1697
- "show-all",
1698
- "show hidden templates"
1440
+ "j",
1441
+ "json",
1442
+ "json format"
1699
1443
  ]
1700
1444
  ],
1701
- "description": "list templates for \"bit create\" and \"bit new\"",
1702
- "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
1445
+ "description": "list available component-issues",
1446
+ "extendedDescription": "",
1703
1447
  "group": "development",
1704
1448
  "private": false
1705
1449
  },
1706
1450
  {
1707
- "name": "new <template-name> <workspace-name>",
1708
- "alias": "",
1451
+ "name": "tag [component-patterns...]",
1452
+ "alias": "t",
1709
1453
  "options": [
1710
1454
  [
1711
- "a",
1712
- "aspect <aspect-id>",
1713
- "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
1455
+ "m",
1456
+ "message <message>",
1457
+ "a log message describing latest changes"
1714
1458
  ],
1715
1459
  [
1716
- "d",
1717
- "default-scope <scope-name>",
1718
- "set defaultScope in the new workspace.jsonc"
1460
+ "",
1461
+ "unmodified",
1462
+ "include unmodified components (by default, only new and modified components are tagged)"
1719
1463
  ],
1720
1464
  [
1721
1465
  "",
1722
- "standalone",
1723
- "DEPRECATED. use --skip-git instead"
1466
+ "editor [editor]",
1467
+ "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
1724
1468
  ],
1725
1469
  [
1726
- "s",
1727
- "skip-git",
1728
- "skip generation of Git repository"
1470
+ "v",
1471
+ "ver <version>",
1472
+ "tag with the given version"
1729
1473
  ],
1730
1474
  [
1731
- "e",
1732
- "empty",
1733
- "empty workspace with no components (relevant for templates that add components by default)"
1475
+ "l",
1476
+ "increment <level>",
1477
+ "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
1734
1478
  ],
1735
1479
  [
1736
1480
  "",
1737
- "load-from <path-to-template>",
1738
- "path to the workspace containing the template. helpful during a development of a workspace-template"
1739
- ]
1740
- ],
1741
- "description": "create a new workspace from a template",
1742
- "extendedDescription": "",
1743
- "group": "start",
1744
- "private": false,
1745
- "arguments": [
1746
- {
1747
- "name": "template-name",
1748
- "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
1749
- },
1750
- {
1751
- "name": "workspace-name",
1752
- "description": "the name for the new workspace and workspace directory"
1753
- }
1754
- ]
1755
- },
1756
- {
1757
- "name": "build [component-pattern]",
1758
- "alias": "",
1759
- "options": [
1760
- [
1761
- "a",
1762
- "all",
1763
- "build all components, not only modified and new"
1481
+ "prerelease-id <id>",
1482
+ "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
1764
1483
  ],
1765
1484
  [
1766
- "d",
1767
- "dev",
1768
- "run the pipeline in dev mode"
1485
+ "p",
1486
+ "patch",
1487
+ "syntactic sugar for \"--increment patch\""
1769
1488
  ],
1770
1489
  [
1771
1490
  "",
1772
- "install",
1773
- "install core aspects in capsules"
1491
+ "minor",
1492
+ "syntactic sugar for \"--increment minor\""
1774
1493
  ],
1775
1494
  [
1776
1495
  "",
1777
- "reuse-capsules",
1778
- "avoid deleting the capsules root-dir before starting the build"
1496
+ "major",
1497
+ "syntactic sugar for \"--increment major\""
1779
1498
  ],
1780
1499
  [
1781
1500
  "",
1782
- "tasks <string>",
1783
- "build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
1501
+ "pre-release [identifier]",
1502
+ "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
1784
1503
  ],
1785
1504
  [
1786
1505
  "",
1787
- "cache-packages-on-capsule-root",
1788
- "set the package-manager cache on the capsule root"
1506
+ "snapped",
1507
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1789
1508
  ],
1790
1509
  [
1791
1510
  "",
1792
- "list-tasks <string>",
1793
- "list tasks of an env or a component-id for each one of the pipelines: build, tag and snap"
1794
- ]
1795
- ],
1796
- "description": "run set of tasks for build",
1797
- "extendedDescription": "",
1798
- "group": "development",
1799
- "private": false,
1800
- "arguments": [
1801
- {
1802
- "name": "component-pattern",
1803
- "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"
1804
- }
1805
- ]
1806
- },
1807
- {
1808
- "name": "artifacts <component-pattern>",
1809
- "alias": "",
1810
- "options": [
1511
+ "unmerged",
1512
+ "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
1513
+ ],
1811
1514
  [
1812
1515
  "",
1813
- "aspect <aspect-id>",
1814
- "show/download only artifacts generated by this aspect-id"
1516
+ "skip-tests",
1517
+ "skip running component tests during tag process"
1815
1518
  ],
1816
1519
  [
1817
1520
  "",
1818
- "task <task-id>",
1819
- "show/download only artifacts generated by this task-id"
1521
+ "skip-auto-tag",
1522
+ "skip auto tagging dependents"
1820
1523
  ],
1821
1524
  [
1822
1525
  "",
1823
- "files <glob>",
1824
- "show/download only artifacts matching the given files or the glob pattern (wrap glob patterns in quotes)"
1526
+ "soft",
1527
+ "do not persist. only keep note of the changes to be made"
1825
1528
  ],
1826
1529
  [
1827
1530
  "",
1828
- "out-dir <string>",
1829
- "download the files to the specified dir"
1830
- ]
1831
- ],
1832
- "description": "EXPERIMENTAL. list and download components artifacts",
1833
- "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
1834
- "group": "development",
1835
- "private": false,
1836
- "arguments": [
1837
- {
1838
- "name": "component-pattern",
1839
- "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"
1840
- }
1841
- ]
1842
- },
1843
- {
1844
- "name": "pack <componentId> [scopePath]",
1845
- "alias": "",
1846
- "options": [
1847
- [
1848
- "d",
1849
- "out-dir <out-dir>",
1850
- "directory to put the result tar file"
1851
- ],
1852
- [
1853
- "o",
1854
- "override",
1855
- "override existing pack file"
1856
- ],
1857
- [
1858
- "k",
1859
- "keep",
1860
- "should keep isolated environment [default = false]"
1861
- ],
1862
- [
1863
- "p",
1864
- "prefix",
1865
- "keep custom (binding) prefix"
1866
- ],
1867
- [
1868
- "j",
1869
- "json",
1870
- "return the output as JSON"
1871
- ]
1872
- ],
1873
- "description": "create tar for npm publish",
1874
- "extendedDescription": "",
1875
- "group": "collaborate",
1876
- "private": false
1877
- },
1878
- {
1879
- "name": "publish <component-pattern>",
1880
- "alias": "",
1881
- "options": [
1882
- [
1883
- "d",
1884
- "dry-run",
1885
- "npm publish --dry-run"
1886
- ],
1887
- [
1888
- "",
1889
- "allow-staged",
1890
- "allow publish components that were not exported yet (not recommended)"
1891
- ],
1892
- [
1893
- "j",
1894
- "json",
1895
- "return the output as JSON"
1896
- ]
1897
- ],
1898
- "description": "publish components to npm (npm publish)",
1899
- "extendedDescription": "",
1900
- "group": "collaborate",
1901
- "private": true,
1902
- "arguments": [
1903
- {
1904
- "name": "component-pattern",
1905
- "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"
1906
- }
1907
- ]
1908
- },
1909
- {
1910
- "name": "refactor <sub-command>",
1911
- "alias": "",
1912
- "options": [],
1913
- "description": "EXPERIMENTAL. source code refactoring / codemod",
1914
- "extendedDescription": "",
1915
- "group": "development",
1916
- "private": false,
1917
- "commands": [
1918
- {
1919
- "name": "dependency-name <old-id> <new-id>",
1920
- "alias": "",
1921
- "options": [],
1922
- "description": "replace the dependency's old package-name with a new one in the code",
1923
- "extendedDescription": "the `<old-id>` and `<new-id>` arguments can be either a component-id or a package-name.",
1924
- "group": "development",
1925
- "private": false
1926
- }
1927
- ]
1928
- },
1929
- {
1930
- "name": "component-issues",
1931
- "alias": "",
1932
- "options": [
1933
- [
1934
- "j",
1935
- "json",
1936
- "json format"
1937
- ]
1938
- ],
1939
- "description": "list available component-issues",
1940
- "extendedDescription": "",
1941
- "group": "development",
1942
- "private": false
1943
- },
1944
- {
1945
- "name": "insights [names...]",
1946
- "alias": "",
1947
- "options": [
1948
- [
1949
- "l",
1950
- "list",
1951
- "list all insights"
1952
- ],
1953
- [
1954
- "j",
1955
- "json",
1956
- "return the insights in json format"
1957
- ]
1958
- ],
1959
- "description": "Insights on component graph",
1960
- "extendedDescription": "",
1961
- "group": "development",
1962
- "private": true
1963
- },
1964
- {
1965
- "name": "tag [component-patterns...]",
1966
- "alias": "t",
1967
- "options": [
1968
- [
1969
- "m",
1970
- "message <message>",
1971
- "a log message describing latest changes"
1972
- ],
1973
- [
1974
- "",
1975
- "unmodified",
1976
- "include unmodified components (by default, only new and modified components are tagged)"
1977
- ],
1978
- [
1979
- "",
1980
- "editor [editor]",
1981
- "EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim)."
1982
- ],
1983
- [
1984
- "v",
1985
- "ver <version>",
1986
- "tag with the given version"
1987
- ],
1988
- [
1989
- "l",
1990
- "increment <level>",
1991
- "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
1992
- ],
1993
- [
1994
- "",
1995
- "prerelease-id <id>",
1996
- "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
1997
- ],
1998
- [
1999
- "p",
2000
- "patch",
2001
- "syntactic sugar for \"--increment patch\""
2002
- ],
2003
- [
2004
- "",
2005
- "minor",
2006
- "syntactic sugar for \"--increment minor\""
2007
- ],
2008
- [
2009
- "",
2010
- "major",
2011
- "syntactic sugar for \"--increment major\""
2012
- ],
2013
- [
2014
- "",
2015
- "pre-release [identifier]",
2016
- "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
2017
- ],
2018
- [
2019
- "",
2020
- "snapped",
2021
- "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2022
- ],
2023
- [
2024
- "",
2025
- "unmerged",
2026
- "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
2027
- ],
2028
- [
2029
- "",
2030
- "skip-tests",
2031
- "skip running component tests during tag process"
2032
- ],
2033
- [
2034
- "",
2035
- "skip-auto-tag",
2036
- "skip auto tagging dependents"
2037
- ],
2038
- [
2039
- "",
2040
- "soft",
2041
- "do not persist. only keep note of the changes to be made"
2042
- ],
2043
- [
2044
- "",
2045
- "persist",
2046
- "persist the changes generated by --soft tag"
2047
- ],
1531
+ "persist",
1532
+ "persist the changes generated by --soft tag"
1533
+ ],
2048
1534
  [
2049
1535
  "",
2050
1536
  "disable-tag-pipeline",
@@ -2286,973 +1772,1493 @@
2286
1772
  "private": false
2287
1773
  },
2288
1774
  {
2289
- "name": "status",
2290
- "alias": "s",
1775
+ "name": "lane [lane-name]",
1776
+ "alias": "",
2291
1777
  "options": [
1778
+ [
1779
+ "d",
1780
+ "details",
1781
+ "show more details on the state of each component in each lane"
1782
+ ],
2292
1783
  [
2293
1784
  "j",
2294
1785
  "json",
2295
- "return a json version of the component"
1786
+ "show lanes details in json format"
2296
1787
  ],
2297
1788
  [
2298
- "",
2299
- "verbose",
2300
- "show full snap hashes"
1789
+ "r",
1790
+ "remote <string>",
1791
+ "show remote lanes"
2301
1792
  ],
2302
1793
  [
2303
1794
  "",
2304
- "strict",
2305
- "in case issues found, exit with code 1"
2306
- ]
2307
- ],
2308
- "description": "present the current status of components in the workspace, and notifies when issues are detected",
2309
- "extendedDescription": "",
2310
- "group": "development",
2311
- "private": false
2312
- },
2313
- {
2314
- "name": "compile [component-names...]",
2315
- "alias": "",
2316
- "options": [
2317
- [
2318
- "c",
2319
- "changed",
2320
- "compile only new and modified components"
2321
- ],
2322
- [
2323
- "v",
2324
- "verbose",
2325
- "show more data, such as, dist paths"
2326
- ],
2327
- [
2328
- "j",
2329
- "json",
2330
- "return the compile results in json format"
1795
+ "merged",
1796
+ "show merged lanes"
2331
1797
  ],
2332
1798
  [
2333
- "d",
2334
- "delete-dist-dir",
2335
- "delete existing dist folder before writing new compiled files"
1799
+ "",
1800
+ "not-merged",
1801
+ "show not merged lanes"
2336
1802
  ]
2337
1803
  ],
2338
- "description": "compile components in the workspace",
1804
+ "description": "show lanes details\nhttps://bit.dev/docs/components/lanes",
2339
1805
  "extendedDescription": "",
2340
- "group": "development",
2341
- "private": false,
2342
- "arguments": [
1806
+ "group": "ungrouped",
1807
+ "private": true,
1808
+ "remoteOp": true,
1809
+ "skipWorkspace": true,
1810
+ "commands": [
2343
1811
  {
2344
- "name": "component-names...",
2345
- "description": "a list of component names or component IDs (defaults to all components)"
1812
+ "name": "list",
1813
+ "alias": "",
1814
+ "options": [
1815
+ [
1816
+ "d",
1817
+ "details",
1818
+ "show more details on the state of each component in each lane"
1819
+ ],
1820
+ [
1821
+ "j",
1822
+ "json",
1823
+ "show lanes details in a json format"
1824
+ ],
1825
+ [
1826
+ "r",
1827
+ "remote <remote-scope-name>",
1828
+ "show remote lanes"
1829
+ ],
1830
+ [
1831
+ "",
1832
+ "merged",
1833
+ "show merged lanes"
1834
+ ],
1835
+ [
1836
+ "",
1837
+ "not-merged",
1838
+ "show lanes that are not merged"
1839
+ ]
1840
+ ],
1841
+ "description": "list lanes",
1842
+ "extendedDescription": "",
1843
+ "group": "ungrouped",
1844
+ "private": true,
1845
+ "remoteOp": true,
1846
+ "skipWorkspace": true
1847
+ },
1848
+ {
1849
+ "name": "switch <lane>",
1850
+ "alias": "",
1851
+ "options": [
1852
+ [
1853
+ "n",
1854
+ "alias <string>",
1855
+ "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
1856
+ ],
1857
+ [
1858
+ "m",
1859
+ "merge [strategy]",
1860
+ "merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
1861
+ ],
1862
+ [
1863
+ "a",
1864
+ "get-all",
1865
+ "checkout all components in a lane include ones that do not exist in the workspace"
1866
+ ],
1867
+ [
1868
+ "",
1869
+ "skip-dependency-installation",
1870
+ "do not install packages of the imported components"
1871
+ ],
1872
+ [
1873
+ "j",
1874
+ "json",
1875
+ "return the output as JSON"
1876
+ ]
1877
+ ],
1878
+ "description": "switch to the specified lane",
1879
+ "extendedDescription": "",
1880
+ "group": "ungrouped",
1881
+ "private": true
1882
+ },
1883
+ {
1884
+ "name": "show <lane-name>",
1885
+ "alias": "",
1886
+ "options": [
1887
+ [
1888
+ "j",
1889
+ "json",
1890
+ "show the lane details in json format"
1891
+ ],
1892
+ [
1893
+ "r",
1894
+ "remote <string>",
1895
+ "show remote lanes"
1896
+ ]
1897
+ ],
1898
+ "description": "show lane details",
1899
+ "extendedDescription": "",
1900
+ "group": "ungrouped",
1901
+ "private": true,
1902
+ "remoteOp": true,
1903
+ "skipWorkspace": true
1904
+ },
1905
+ {
1906
+ "name": "create <lane-name>",
1907
+ "alias": "",
1908
+ "options": [
1909
+ [
1910
+ "",
1911
+ "remote-scope <scope-name>",
1912
+ "remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
1913
+ ],
1914
+ [
1915
+ "",
1916
+ "alias <name>",
1917
+ "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
1918
+ ]
1919
+ ],
1920
+ "description": "creates a new lane and switches to it",
1921
+ "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
1922
+ "group": "ungrouped",
1923
+ "private": true,
1924
+ "arguments": [
1925
+ {
1926
+ "name": "lane-name",
1927
+ "description": "the name for the new lane"
1928
+ }
1929
+ ]
1930
+ },
1931
+ {
1932
+ "name": "remove <lanes...>",
1933
+ "alias": "",
1934
+ "options": [
1935
+ [
1936
+ "r",
1937
+ "remote",
1938
+ "remove a remote lane (in the lane arg, use remote/lane-id syntax)"
1939
+ ],
1940
+ [
1941
+ "f",
1942
+ "force",
1943
+ "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
1944
+ ],
1945
+ [
1946
+ "s",
1947
+ "silent",
1948
+ "skip confirmation"
1949
+ ]
1950
+ ],
1951
+ "description": "remove lanes",
1952
+ "extendedDescription": "",
1953
+ "group": "ungrouped",
1954
+ "private": true,
1955
+ "arguments": [
1956
+ {
1957
+ "name": "lanes...",
1958
+ "description": "A list of lane names, separated by spaces"
1959
+ }
1960
+ ]
1961
+ },
1962
+ {
1963
+ "name": "change-scope <lane-name> <remote-scope-name>",
1964
+ "alias": "",
1965
+ "options": [],
1966
+ "description": "changes the remote scope of a lane",
1967
+ "extendedDescription": "",
1968
+ "group": "ungrouped",
1969
+ "private": true
1970
+ },
1971
+ {
1972
+ "name": "alias <lane-name> <alias>",
1973
+ "alias": "",
1974
+ "options": [],
1975
+ "description": "adds an alias to a lane",
1976
+ "extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
1977
+ "group": "ungrouped",
1978
+ "private": true
1979
+ },
1980
+ {
1981
+ "name": "rename <current-name> <new-name>",
1982
+ "alias": "",
1983
+ "options": [],
1984
+ "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
1985
+ "extendedDescription": "",
1986
+ "group": "ungrouped",
1987
+ "private": true
1988
+ },
1989
+ {
1990
+ "name": "diff [values...]",
1991
+ "alias": "",
1992
+ "options": [
1993
+ [
1994
+ "",
1995
+ "pattern <component-pattern>",
1996
+ "EXPERIMENTAL. show lane-diff for the specified component-pattern only"
1997
+ ]
1998
+ ],
1999
+ "description": "show diff between lanes",
2000
+ "extendedDescription": "bit lane diff => diff between the current lane and default lane. (only inside workspace).\nbit lane diff to => diff between the current lane (or default-lane when in scope) and \"to\" lane.\nbit lane diff from to => diff between \"from\" lane and \"to\" lane.",
2001
+ "group": "ungrouped",
2002
+ "private": true,
2003
+ "remoteOp": true,
2004
+ "skipWorkspace": true
2005
+ },
2006
+ {
2007
+ "name": "add-readme <component-name> [lane-name]",
2008
+ "alias": "",
2009
+ "options": [],
2010
+ "description": "EXPERIMENTAL. adds a readme component to a lane",
2011
+ "extendedDescription": "",
2012
+ "group": "ungrouped",
2013
+ "private": true,
2014
+ "skipWorkspace": false,
2015
+ "arguments": [
2016
+ {
2017
+ "name": "component-id",
2018
+ "description": "the component name or id of the component to use as the lane's readme"
2019
+ },
2020
+ {
2021
+ "name": "lane-name",
2022
+ "description": "the lane to attach the readme to (defaults to the current lane)"
2023
+ }
2024
+ ]
2025
+ },
2026
+ {
2027
+ "name": "remove-readme [laneName]",
2028
+ "alias": "",
2029
+ "options": [],
2030
+ "description": "EXPERIMENTAL. remove lane readme component",
2031
+ "extendedDescription": "",
2032
+ "group": "ungrouped",
2033
+ "private": true,
2034
+ "skipWorkspace": false
2035
+ },
2036
+ {
2037
+ "name": "import <lane>",
2038
+ "alias": "",
2039
+ "options": [
2040
+ [
2041
+ "",
2042
+ "skip-dependency-installation",
2043
+ "do not install packages of the imported components"
2044
+ ]
2045
+ ],
2046
+ "description": "import a remote lane to your workspace",
2047
+ "extendedDescription": "",
2048
+ "group": "ungrouped",
2049
+ "private": true,
2050
+ "arguments": [
2051
+ {
2052
+ "name": "lane",
2053
+ "description": "the remote lane name"
2054
+ }
2055
+ ]
2056
+ },
2057
+ {
2058
+ "name": "merge <lane> [pattern]",
2059
+ "alias": "",
2060
+ "options": [
2061
+ [
2062
+ "",
2063
+ "ours",
2064
+ "in case of a conflict, override the used version with the current modification"
2065
+ ],
2066
+ [
2067
+ "",
2068
+ "theirs",
2069
+ "in case of a conflict, override the current modification with the specified version"
2070
+ ],
2071
+ [
2072
+ "",
2073
+ "manual",
2074
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2075
+ ],
2076
+ [
2077
+ "",
2078
+ "workspace",
2079
+ "merge only components in a lane that exist in the workspace"
2080
+ ],
2081
+ [
2082
+ "",
2083
+ "no-snap",
2084
+ "do not auto snap in case the merge completed without conflicts"
2085
+ ],
2086
+ [
2087
+ "",
2088
+ "build",
2089
+ "in case of snap during the merge, run the build-pipeline (similar to bit snap --build)"
2090
+ ],
2091
+ [
2092
+ "m",
2093
+ "message <message>",
2094
+ "override the default message for the auto snap"
2095
+ ],
2096
+ [
2097
+ "",
2098
+ "keep-readme",
2099
+ "skip deleting the lane readme component after merging"
2100
+ ],
2101
+ [
2102
+ "",
2103
+ "squash",
2104
+ "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2105
+ ],
2106
+ [
2107
+ "",
2108
+ "verbose",
2109
+ "show details of components that were not merged legitimately"
2110
+ ],
2111
+ [
2112
+ "",
2113
+ "skip-dependency-installation",
2114
+ "do not install packages of the imported components"
2115
+ ],
2116
+ [
2117
+ "",
2118
+ "remote",
2119
+ "relevant when the target-lane locally is differ than the remote and you want the remote"
2120
+ ],
2121
+ [
2122
+ "",
2123
+ "include-deps",
2124
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2125
+ ]
2126
+ ],
2127
+ "description": "merge a local or a remote lane",
2128
+ "extendedDescription": "if the <lane> exists locally, it will be merged from the local lane.\notherwise, it will fetch the lane from the remote and merge it.\nin case the <lane> exists locally but you want to merge the remote version of it, use --remote flag",
2129
+ "private": true,
2130
+ "remoteOp": true,
2131
+ "arguments": [
2132
+ {
2133
+ "name": "lane",
2134
+ "description": "lane-name or lane-id (if not exists locally) to merge to the current lane"
2135
+ },
2136
+ {
2137
+ "name": "pattern",
2138
+ "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2139
+ }
2140
+ ]
2346
2141
  }
2347
2142
  ]
2348
2143
  },
2349
2144
  {
2350
- "name": "run <app-name>",
2351
- "alias": "c",
2145
+ "name": "switch <lane>",
2146
+ "alias": "",
2352
2147
  "options": [
2353
2148
  [
2354
- "d",
2355
- "dev",
2356
- "start the application in dev mode."
2149
+ "n",
2150
+ "alias <string>",
2151
+ "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
2357
2152
  ],
2358
2153
  [
2359
- "v",
2360
- "verbose",
2361
- "showing verbose output for inspection and prints stack trace"
2154
+ "m",
2155
+ "merge [strategy]",
2156
+ "merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
2362
2157
  ],
2363
2158
  [
2364
- "",
2365
- "skip-watch",
2366
- "avoid running the watch process that compiles components in the background"
2159
+ "a",
2160
+ "get-all",
2161
+ "checkout all components in a lane include ones that do not exist in the workspace"
2367
2162
  ],
2368
2163
  [
2369
2164
  "",
2370
- "ssr",
2371
- "run app in server side rendering mode."
2372
- ]
2373
- ],
2374
- "description": "run an app (independent of bit's dev server)",
2375
- "extendedDescription": "",
2376
- "group": "apps",
2377
- "private": false,
2378
- "arguments": [
2379
- {
2380
- "name": "app-name",
2381
- "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2382
- }
2383
- ]
2384
- },
2385
- {
2386
- "name": "app-list",
2387
- "alias": "",
2388
- "options": [
2165
+ "skip-dependency-installation",
2166
+ "do not install packages of the imported components"
2167
+ ],
2389
2168
  [
2390
2169
  "j",
2391
2170
  "json",
2392
- "return the component data in json format"
2171
+ "return the output as JSON"
2393
2172
  ]
2394
2173
  ],
2395
- "description": "DEPRECATED. use \"bit app list\"",
2174
+ "description": "switch to the specified lane",
2396
2175
  "extendedDescription": "",
2397
- "group": "apps",
2176
+ "group": "ungrouped",
2398
2177
  "private": true
2399
2178
  },
2400
2179
  {
2401
- "name": "app <sub-command>",
2402
- "alias": "",
2180
+ "name": "dependencies <sub-command>",
2181
+ "alias": "deps",
2403
2182
  "options": [],
2404
- "description": "Manages apps",
2183
+ "description": "manage dependencies",
2405
2184
  "extendedDescription": "",
2406
- "group": "apps",
2185
+ "group": "info",
2407
2186
  "private": false,
2408
2187
  "commands": [
2409
2188
  {
2410
- "name": "list",
2189
+ "name": "get <component-name>",
2411
2190
  "alias": "",
2412
2191
  "options": [
2413
2192
  [
2414
- "j",
2415
- "json",
2416
- "return the component data in json format"
2193
+ "t",
2194
+ "tree",
2195
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
2417
2196
  ]
2418
2197
  ],
2419
- "description": "list all registered apps",
2198
+ "description": "show direct and indirect dependencies of the given component",
2420
2199
  "extendedDescription": "",
2421
- "group": "apps",
2422
- "private": false
2200
+ "group": "info",
2201
+ "private": false,
2202
+ "arguments": [
2203
+ {
2204
+ "name": "component-name",
2205
+ "description": "component name or component id"
2206
+ }
2207
+ ]
2423
2208
  },
2424
2209
  {
2425
- "name": "run <app-name>",
2426
- "alias": "c",
2210
+ "name": "remove <component-pattern> <package...>",
2211
+ "alias": "",
2212
+ "options": [],
2213
+ "description": "remove a dependency to component(s)",
2214
+ "extendedDescription": "",
2215
+ "group": "info",
2216
+ "private": false,
2217
+ "arguments": [
2218
+ {
2219
+ "name": "component-pattern",
2220
+ "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"
2221
+ },
2222
+ {
2223
+ "name": "package",
2224
+ "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"
2225
+ }
2226
+ ]
2227
+ },
2228
+ {
2229
+ "name": "debug <component-name>",
2230
+ "alias": "",
2231
+ "options": [],
2232
+ "description": "show the immediate dependencies and how their versions were determined",
2233
+ "extendedDescription": "",
2234
+ "group": "info",
2235
+ "private": false,
2236
+ "arguments": [
2237
+ {
2238
+ "name": "component-name",
2239
+ "description": "component name or component id"
2240
+ }
2241
+ ]
2242
+ },
2243
+ {
2244
+ "name": "set <component-pattern> <package...>",
2245
+ "alias": "",
2427
2246
  "options": [
2428
2247
  [
2429
2248
  "d",
2430
2249
  "dev",
2431
- "start the application in dev mode."
2432
- ],
2433
- [
2434
- "v",
2435
- "verbose",
2436
- "showing verbose output for inspection and prints stack trace"
2437
- ],
2438
- [
2439
- "",
2440
- "skip-watch",
2441
- "avoid running the watch process that compiles components in the background"
2250
+ "add to the devDependencies"
2442
2251
  ],
2443
2252
  [
2444
- "",
2445
- "ssr",
2446
- "run app in server side rendering mode."
2253
+ "p",
2254
+ "peer",
2255
+ "add to the peerDependencies"
2447
2256
  ]
2448
2257
  ],
2449
- "description": "run an app (independent of bit's dev server)",
2258
+ "description": "set a dependency to component(s)",
2450
2259
  "extendedDescription": "",
2451
- "group": "apps",
2260
+ "group": "info",
2452
2261
  "private": false,
2453
2262
  "arguments": [
2454
2263
  {
2455
- "name": "app-name",
2456
- "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2264
+ "name": "component-pattern",
2265
+ "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"
2266
+ },
2267
+ {
2268
+ "name": "package",
2269
+ "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
2457
2270
  }
2458
2271
  ]
2459
2272
  }
2460
2273
  ]
2461
2274
  },
2462
2275
  {
2463
- "name": "test [component-pattern]",
2464
- "alias": "at",
2276
+ "name": "list [remote-scope]",
2277
+ "alias": "ls",
2278
+ "options": [
2279
+ [
2280
+ "i",
2281
+ "ids",
2282
+ "show only component ids unformatted"
2283
+ ],
2284
+ [
2285
+ "s",
2286
+ "scope",
2287
+ "show only components stored in the local scope, including indirect dependencies"
2288
+ ],
2289
+ [
2290
+ "o",
2291
+ "outdated",
2292
+ "show latest versions from remotes"
2293
+ ],
2294
+ [
2295
+ "j",
2296
+ "json",
2297
+ "show the output in JSON format"
2298
+ ],
2299
+ [
2300
+ "n",
2301
+ "namespace <string>",
2302
+ "show only specified namespace by using wildcards"
2303
+ ]
2304
+ ],
2305
+ "description": "list components on a workspace, local scope or a remote scope.",
2306
+ "extendedDescription": "https://bit.dev/docs/reference/cli-reference#list",
2307
+ "group": "discover",
2308
+ "private": false,
2309
+ "remoteOp": true,
2310
+ "skipWorkspace": true
2311
+ },
2312
+ {
2313
+ "name": "import [component-patterns...]",
2314
+ "alias": "",
2465
2315
  "options": [
2466
2316
  [
2467
- "w",
2468
- "watch",
2469
- "start the tester in watch mode."
2317
+ "p",
2318
+ "path <path>",
2319
+ "import components into a specific directory (a relative path in the workspace)"
2320
+ ],
2321
+ [
2322
+ "o",
2323
+ "objects",
2324
+ "import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument"
2325
+ ],
2326
+ [
2327
+ "d",
2328
+ "display-dependencies",
2329
+ "display the imported dependencies"
2330
+ ],
2331
+ [
2332
+ "O",
2333
+ "override",
2334
+ "override local changes"
2470
2335
  ],
2471
2336
  [
2472
- "d",
2473
- "debug",
2474
- "start the tester in debug mode."
2337
+ "v",
2338
+ "verbose",
2339
+ "show verbose output for inspection"
2475
2340
  ],
2476
2341
  [
2477
- "a",
2478
- "all",
2479
- "test all components, not only new and modified"
2342
+ "j",
2343
+ "json",
2344
+ "return the output as JSON"
2480
2345
  ],
2481
2346
  [
2482
2347
  "",
2483
- "junit <filepath>",
2484
- "write tests results as JUnit XML format into the specified file path"
2348
+ "conf",
2349
+ "write the configuration file (component.json) of the component"
2485
2350
  ],
2486
2351
  [
2487
2352
  "",
2488
- "coverage",
2489
- "show code coverage data"
2353
+ "skip-npm-install",
2354
+ "DEPRECATED. use \"--skip-dependency-installation\" instead"
2490
2355
  ],
2491
2356
  [
2492
- "e",
2493
- "env <id>",
2494
- "test only the given env"
2357
+ "",
2358
+ "skip-dependency-installation",
2359
+ "do not install packages of the imported components"
2495
2360
  ],
2496
2361
  [
2497
- "s",
2498
- "scope <scope-name>",
2499
- "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
2362
+ "m",
2363
+ "merge [strategy]",
2364
+ "merge local changes with the imported version. strategy should be \"theirs\", \"ours\" or \"manual\""
2365
+ ],
2366
+ [
2367
+ "",
2368
+ "dependencies",
2369
+ "EXPERIMENTAL. import all dependencies and write them to the workspace"
2370
+ ],
2371
+ [
2372
+ "",
2373
+ "dependents",
2374
+ "EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents"
2375
+ ],
2376
+ [
2377
+ "",
2378
+ "save-in-lane",
2379
+ "EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
2380
+ ],
2381
+ [
2382
+ "",
2383
+ "all-history",
2384
+ "relevant for fetching all components objects. avoid optimizations, fetch all history versions, always"
2500
2385
  ]
2501
2386
  ],
2502
- "description": "test components in the workspace",
2503
- "extendedDescription": "",
2504
- "group": "development",
2387
+ "description": "import components from their remote scopes to the local workspace",
2388
+ "extendedDescription": "https://bit.dev/docs/components/importing-components\nyou can use a pattern for multiple ids, such as bit import \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2389
+ "group": "collaborate",
2505
2390
  "private": false,
2391
+ "remoteOp": true,
2506
2392
  "arguments": [
2507
2393
  {
2508
- "name": "component-pattern",
2509
- "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"
2394
+ "name": "component-patterns...",
2395
+ "description": "component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., \"utils/*\" (wrap with double quotes)"
2510
2396
  }
2511
2397
  ]
2512
2398
  },
2513
2399
  {
2514
- "name": "schema <pattern>",
2400
+ "name": "create <template-name> <component-names...>",
2515
2401
  "alias": "",
2516
2402
  "options": [
2517
2403
  [
2518
- "j",
2519
- "json",
2520
- "return the component data in json format"
2521
- ]
2522
- ],
2523
- "description": "shows the API schema of a certain component.",
2524
- "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",
2525
- "group": "development",
2526
- "private": false
2527
- },
2528
- {
2529
- "name": "check-types [component-pattern]",
2530
- "alias": "",
2531
- "options": [
2404
+ "n",
2405
+ "namespace <string>",
2406
+ "sets the component's namespace and nested dirs inside the scope"
2407
+ ],
2408
+ [
2409
+ "s",
2410
+ "scope <string>",
2411
+ "sets the component's scope-name. if not entered, the default-scope will be used"
2412
+ ],
2532
2413
  [
2533
2414
  "a",
2534
- "all",
2535
- "check-types for all components, not only modified and new"
2415
+ "aspect <string>",
2416
+ "aspect-id of the template. helpful when multiple aspects use the same template name"
2536
2417
  ],
2537
2418
  [
2538
- "",
2539
- "strict",
2540
- "in case issues found, exit with code 1"
2419
+ "p",
2420
+ "path <string>",
2421
+ "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
2422
+ ],
2423
+ [
2424
+ "e",
2425
+ "env <string>",
2426
+ "set the component's environment. (overrides the env from variants and the template)"
2541
2427
  ]
2542
2428
  ],
2543
- "description": "check typescript types",
2429
+ "description": "create a new component (source files and config) using a template.",
2544
2430
  "extendedDescription": "",
2545
2431
  "group": "development",
2546
2432
  "private": false,
2547
2433
  "arguments": [
2548
2434
  {
2549
- "name": "component-pattern",
2550
- "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"
2551
- }
2552
- ]
2553
- },
2554
- {
2555
- "name": "aspect <sub-command>",
2556
- "alias": "",
2557
- "options": [],
2558
- "description": "EXPERIMENTAL. manage aspects",
2559
- "extendedDescription": "",
2560
- "group": "development",
2561
- "private": false,
2562
- "commands": [
2563
- {
2564
- "name": "list [pattern]",
2565
- "alias": "",
2566
- "options": [
2567
- [
2568
- "d",
2569
- "debug",
2570
- "show the origins were the aspects were taken from"
2571
- ]
2572
- ],
2573
- "description": "list all aspects configured on component(s)",
2574
- "extendedDescription": "",
2575
- "group": "development",
2576
- "private": false,
2577
- "arguments": [
2578
- {
2579
- "name": "pattern",
2580
- "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"
2581
- }
2582
- ]
2435
+ "name": "template-name",
2436
+ "description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
2583
2437
  },
2584
2438
  {
2585
- "name": "get <component-name>",
2586
- "alias": "",
2587
- "options": [
2588
- [
2589
- "d",
2590
- "debug",
2591
- "show the origins were the aspects were taken from"
2592
- ],
2593
- [
2594
- "j",
2595
- "json",
2596
- "format as json"
2597
- ]
2598
- ],
2599
- "description": "list the aspects set on a component, as well as their config and data",
2600
- "extendedDescription": "",
2601
- "group": "development",
2602
- "private": false,
2603
- "arguments": [
2604
- {
2605
- "name": "component-name",
2606
- "description": "the component name or component id"
2607
- }
2608
- ]
2439
+ "name": "component-names...",
2440
+ "description": "a list of component names to generate"
2441
+ }
2442
+ ],
2443
+ "examples": [
2444
+ {
2445
+ "cmd": "bit create react ui/button",
2446
+ "description": "creates a component named 'ui/button' using the 'react' template"
2609
2447
  },
2610
2448
  {
2611
- "name": "set <pattern> <aspect-id> [config]",
2612
- "alias": "",
2613
- "options": [
2614
- [
2615
- "m",
2616
- "merge",
2617
- "merge with an existing config if exits. (by default, it replaces the config)"
2618
- ]
2619
- ],
2620
- "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
2621
- "extendedDescription": "",
2622
- "group": "development",
2623
- "private": false,
2624
- "arguments": [
2625
- {
2626
- "name": "pattern",
2627
- "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"
2628
- },
2629
- {
2630
- "name": "aspect-id",
2631
- "description": "the aspect's component id"
2632
- },
2633
- {
2634
- "name": "config",
2635
- "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 ({})."
2636
- }
2637
- ]
2449
+ "cmd": "bit create react ui/button pages/register",
2450
+ "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
2638
2451
  },
2639
2452
  {
2640
- "name": "unset <pattern> <aspect-id>",
2641
- "alias": "",
2642
- "options": [],
2643
- "description": "unset an aspect from component(s).",
2644
- "extendedDescription": "",
2645
- "group": "development",
2646
- "private": false,
2647
- "arguments": [
2648
- {
2649
- "name": "pattern",
2650
- "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"
2651
- },
2652
- {
2653
- "name": "aspect-id",
2654
- "description": "the aspect's component id"
2655
- }
2656
- ]
2453
+ "cmd": "bit create react ui/button --scope my-org.my-scope",
2454
+ "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
2657
2455
  },
2658
2456
  {
2659
- "name": "update <aspect-id> [pattern]",
2660
- "alias": "",
2661
- "options": [],
2662
- "description": "update a version of an aspect",
2663
- "extendedDescription": "",
2664
- "group": "development",
2665
- "private": false,
2666
- "arguments": [
2667
- {
2668
- "name": "aspect-id",
2669
- "description": "the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote"
2670
- },
2671
- {
2672
- "name": "pattern",
2673
- "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"
2674
- }
2675
- ],
2676
- "examples": [
2677
- {
2678
- "cmd": "update scope.org/aspect '**/ui/**'",
2679
- "description": "update \"ui\" components that use scope.org/aspect to use its latest version"
2680
- },
2681
- {
2682
- "cmd": "bit aspect update scope.org/aspect@2.0.0",
2683
- "description": "update all components that use scope.org/aspect to version 2.0.0 (of this aspect)."
2684
- }
2685
- ]
2457
+ "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
2458
+ "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
2686
2459
  }
2687
2460
  ]
2688
2461
  },
2689
2462
  {
2690
- "name": "clear-cache",
2691
- "alias": "cc",
2463
+ "name": "templates",
2464
+ "alias": "",
2692
2465
  "options": [
2693
2466
  [
2694
- "r",
2695
- "remote <remote-name>",
2696
- "clear memory cache from a remote scope"
2467
+ "s",
2468
+ "show-all",
2469
+ "show hidden templates"
2697
2470
  ]
2698
2471
  ],
2699
- "description": "clears Bit's cache from current working machine",
2700
- "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash\nhttps://bit.dev/docs/workspace/clearing-cache",
2701
- "group": "general",
2702
- "private": false,
2703
- "skipWorkspace": true
2472
+ "description": "list templates for \"bit create\" and \"bit new\"",
2473
+ "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
2474
+ "group": "development",
2475
+ "private": false
2704
2476
  },
2705
2477
  {
2706
- "name": "log <id>",
2478
+ "name": "new <template-name> <workspace-name>",
2707
2479
  "alias": "",
2708
2480
  "options": [
2709
2481
  [
2710
- "r",
2711
- "remote",
2712
- "show log of a remote component"
2482
+ "a",
2483
+ "aspect <aspect-id>",
2484
+ "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
2485
+ ],
2486
+ [
2487
+ "d",
2488
+ "default-scope <scope-name>",
2489
+ "set defaultScope in the new workspace.jsonc"
2713
2490
  ],
2714
2491
  [
2715
2492
  "",
2716
- "parents",
2717
- "EXPERIMENTAL. show parents and lanes data"
2493
+ "standalone",
2494
+ "DEPRECATED. use --skip-git instead"
2718
2495
  ],
2719
2496
  [
2720
- "j",
2721
- "json",
2722
- "json format"
2497
+ "s",
2498
+ "skip-git",
2499
+ "skip generation of Git repository"
2500
+ ],
2501
+ [
2502
+ "e",
2503
+ "empty",
2504
+ "empty workspace with no components (relevant for templates that add components by default)"
2505
+ ],
2506
+ [
2507
+ "",
2508
+ "load-from <path-to-template>",
2509
+ "path to the workspace containing the template. helpful during a development of a workspace-template"
2723
2510
  ]
2724
2511
  ],
2725
- "description": "show components(s) version history",
2726
- "extendedDescription": "https://bit.dev/docs/reference/cli-reference#log",
2727
- "group": "info",
2512
+ "description": "create a new workspace from a template",
2513
+ "extendedDescription": "",
2514
+ "group": "start",
2728
2515
  "private": false,
2729
- "remoteOp": true,
2730
- "skipWorkspace": true,
2731
2516
  "arguments": [
2732
2517
  {
2733
- "name": "id",
2734
- "description": "component-id or component-name"
2518
+ "name": "template-name",
2519
+ "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
2520
+ },
2521
+ {
2522
+ "name": "workspace-name",
2523
+ "description": "the name for the new workspace and workspace directory"
2735
2524
  }
2736
2525
  ]
2737
2526
  },
2738
2527
  {
2739
- "name": "deprecate <component-name>",
2740
- "alias": "d",
2528
+ "name": "build [component-pattern]",
2529
+ "alias": "",
2741
2530
  "options": [
2531
+ [
2532
+ "a",
2533
+ "all",
2534
+ "build all components, not only modified and new"
2535
+ ],
2536
+ [
2537
+ "d",
2538
+ "dev",
2539
+ "run the pipeline in dev mode"
2540
+ ],
2742
2541
  [
2743
2542
  "",
2744
- "new-id <string>",
2745
- "if replaced by another component, enter the new component id"
2543
+ "install",
2544
+ "install core aspects in capsules"
2545
+ ],
2546
+ [
2547
+ "",
2548
+ "reuse-capsules",
2549
+ "avoid deleting the capsules root-dir before starting the build"
2550
+ ],
2551
+ [
2552
+ "",
2553
+ "tasks <string>",
2554
+ "build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
2555
+ ],
2556
+ [
2557
+ "",
2558
+ "cache-packages-on-capsule-root",
2559
+ "set the package-manager cache on the capsule root"
2560
+ ],
2561
+ [
2562
+ "",
2563
+ "list-tasks <string>",
2564
+ "list tasks of an env or a component-id for each one of the pipelines: build, tag and snap"
2746
2565
  ]
2747
2566
  ],
2748
- "description": "deprecate a component",
2567
+ "description": "run set of tasks for build",
2749
2568
  "extendedDescription": "",
2750
- "group": "collaborate",
2569
+ "group": "development",
2751
2570
  "private": false,
2752
- "remoteOp": true,
2753
- "skipWorkspace": true,
2754
2571
  "arguments": [
2755
2572
  {
2756
- "name": "component-name",
2757
- "description": "component name or component id"
2573
+ "name": "component-pattern",
2574
+ "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"
2758
2575
  }
2759
2576
  ]
2760
2577
  },
2761
2578
  {
2762
- "name": "undeprecate <id>",
2579
+ "name": "artifacts <component-pattern>",
2763
2580
  "alias": "",
2764
- "options": [],
2765
- "description": "undeprecate a deprecated component (local/remote)",
2766
- "extendedDescription": "",
2767
- "group": "collaborate",
2581
+ "options": [
2582
+ [
2583
+ "",
2584
+ "aspect <aspect-id>",
2585
+ "show/download only artifacts generated by this aspect-id"
2586
+ ],
2587
+ [
2588
+ "",
2589
+ "task <task-id>",
2590
+ "show/download only artifacts generated by this task-id"
2591
+ ],
2592
+ [
2593
+ "",
2594
+ "files <glob>",
2595
+ "show/download only artifacts matching the given files or the glob pattern (wrap glob patterns in quotes)"
2596
+ ],
2597
+ [
2598
+ "",
2599
+ "out-dir <string>",
2600
+ "download the files to the specified dir"
2601
+ ]
2602
+ ],
2603
+ "description": "EXPERIMENTAL. list and download components artifacts",
2604
+ "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
2605
+ "group": "development",
2768
2606
  "private": false,
2769
- "remoteOp": true,
2770
- "skipWorkspace": true
2607
+ "arguments": [
2608
+ {
2609
+ "name": "component-pattern",
2610
+ "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"
2611
+ }
2612
+ ]
2771
2613
  },
2772
2614
  {
2773
- "name": "rename <current-name> <new-name>",
2615
+ "name": "pack <componentId> [scopePath]",
2774
2616
  "alias": "",
2775
2617
  "options": [
2776
2618
  [
2777
- "s",
2778
- "scope <scope-name>",
2779
- "default scope for the newly created component"
2619
+ "d",
2620
+ "out-dir <out-dir>",
2621
+ "directory to put the result tar file"
2622
+ ],
2623
+ [
2624
+ "o",
2625
+ "override",
2626
+ "override existing pack file"
2627
+ ],
2628
+ [
2629
+ "k",
2630
+ "keep",
2631
+ "should keep isolated environment [default = false]"
2780
2632
  ],
2781
2633
  [
2782
2634
  "p",
2783
- "path <relative-path>",
2784
- "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
2635
+ "prefix",
2636
+ "keep custom (binding) prefix"
2785
2637
  ],
2786
2638
  [
2787
- "r",
2788
- "refactor",
2789
- "update the import/require statements in all dependent components (in the same workspace)"
2639
+ "j",
2640
+ "json",
2641
+ "return the output as JSON"
2790
2642
  ]
2791
2643
  ],
2792
- "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
2644
+ "description": "create tar for npm publish",
2793
2645
  "extendedDescription": "",
2794
2646
  "group": "collaborate",
2795
- "private": false,
2796
- "remoteOp": true,
2797
- "skipWorkspace": true,
2647
+ "private": false
2648
+ },
2649
+ {
2650
+ "name": "publish <component-pattern>",
2651
+ "alias": "",
2652
+ "options": [
2653
+ [
2654
+ "d",
2655
+ "dry-run",
2656
+ "npm publish --dry-run"
2657
+ ],
2658
+ [
2659
+ "",
2660
+ "allow-staged",
2661
+ "allow publish components that were not exported yet (not recommended)"
2662
+ ],
2663
+ [
2664
+ "j",
2665
+ "json",
2666
+ "return the output as JSON"
2667
+ ]
2668
+ ],
2669
+ "description": "publish components to npm (npm publish)",
2670
+ "extendedDescription": "",
2671
+ "group": "collaborate",
2672
+ "private": true,
2798
2673
  "arguments": [
2799
2674
  {
2800
- "name": "current-name",
2801
- "description": "the current component name (without its scope name)"
2802
- },
2675
+ "name": "component-pattern",
2676
+ "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"
2677
+ }
2678
+ ]
2679
+ },
2680
+ {
2681
+ "name": "refactor <sub-command>",
2682
+ "alias": "",
2683
+ "options": [],
2684
+ "description": "EXPERIMENTAL. source code refactoring / codemod",
2685
+ "extendedDescription": "",
2686
+ "group": "development",
2687
+ "private": false,
2688
+ "commands": [
2803
2689
  {
2804
- "name": "new-name",
2805
- "description": "the new component name (without its scope name)"
2690
+ "name": "dependency-name <old-id> <new-id>",
2691
+ "alias": "",
2692
+ "options": [],
2693
+ "description": "replace the dependency's old package-name with a new one in the code",
2694
+ "extendedDescription": "the `<old-id>` and `<new-id>` arguments can be either a component-id or a package-name.",
2695
+ "group": "development",
2696
+ "private": false
2806
2697
  }
2807
2698
  ]
2808
2699
  },
2809
2700
  {
2810
- "name": "fork <source-component-id> [target-component-name]",
2701
+ "name": "status",
2702
+ "alias": "s",
2703
+ "options": [
2704
+ [
2705
+ "j",
2706
+ "json",
2707
+ "return a json version of the component"
2708
+ ],
2709
+ [
2710
+ "",
2711
+ "verbose",
2712
+ "show full snap hashes"
2713
+ ],
2714
+ [
2715
+ "",
2716
+ "strict",
2717
+ "in case issues found, exit with code 1"
2718
+ ]
2719
+ ],
2720
+ "description": "present the current status of components in the workspace, and notifies when issues are detected",
2721
+ "extendedDescription": "",
2722
+ "group": "development",
2723
+ "private": false
2724
+ },
2725
+ {
2726
+ "name": "compile [component-names...]",
2811
2727
  "alias": "",
2812
2728
  "options": [
2813
2729
  [
2814
- "s",
2815
- "scope <string>",
2816
- "default scope for the new component"
2730
+ "c",
2731
+ "changed",
2732
+ "compile only new and modified components"
2817
2733
  ],
2818
2734
  [
2819
- "p",
2820
- "path <string>",
2821
- "relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>`"
2735
+ "v",
2736
+ "verbose",
2737
+ "show more data, such as, dist paths"
2822
2738
  ],
2823
2739
  [
2824
- "r",
2825
- "refactor",
2826
- "update the import/require statements in all dependent components (in the same workspace)"
2740
+ "j",
2741
+ "json",
2742
+ "return the compile results in json format"
2827
2743
  ],
2828
2744
  [
2829
- "",
2830
- "skip-dependency-installation",
2831
- "do not install packages of the imported components"
2745
+ "d",
2746
+ "delete-dist-dir",
2747
+ "delete existing dist folder before writing new compiled files"
2832
2748
  ]
2833
2749
  ],
2834
- "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
2750
+ "description": "compile components in the workspace",
2835
2751
  "extendedDescription": "",
2836
- "group": "collaborate",
2752
+ "group": "development",
2837
2753
  "private": false,
2838
- "remoteOp": true,
2839
- "skipWorkspace": true,
2840
2754
  "arguments": [
2841
2755
  {
2842
- "name": "source-component-id",
2843
- "description": "the component id of the source component"
2844
- },
2845
- {
2846
- "name": "target-component-name",
2847
- "description": "the name for the new component (component name without scope). to set a different scope, use the '--scope' flag"
2756
+ "name": "component-names...",
2757
+ "description": "a list of component names or component IDs (defaults to all components)"
2848
2758
  }
2849
2759
  ]
2850
2760
  },
2851
2761
  {
2852
- "name": "lane [lane-name]",
2853
- "alias": "",
2762
+ "name": "run <app-name>",
2763
+ "alias": "c",
2854
2764
  "options": [
2855
2765
  [
2856
2766
  "d",
2857
- "details",
2858
- "show more details on the state of each component in each lane"
2859
- ],
2860
- [
2861
- "j",
2862
- "json",
2863
- "show lanes details in json format"
2767
+ "dev",
2768
+ "start the application in dev mode."
2864
2769
  ],
2865
2770
  [
2866
- "r",
2867
- "remote <string>",
2868
- "show remote lanes"
2771
+ "v",
2772
+ "verbose",
2773
+ "showing verbose output for inspection and prints stack trace"
2869
2774
  ],
2870
2775
  [
2871
2776
  "",
2872
- "merged",
2873
- "show merged lanes"
2777
+ "skip-watch",
2778
+ "avoid running the watch process that compiles components in the background"
2874
2779
  ],
2875
2780
  [
2876
2781
  "",
2877
- "not-merged",
2878
- "show not merged lanes"
2782
+ "ssr",
2783
+ "run app in server side rendering mode."
2879
2784
  ]
2880
2785
  ],
2881
- "description": "show lanes details\nhttps://bit.dev/docs/components/lanes",
2786
+ "description": "run an app (independent of bit's dev server)",
2882
2787
  "extendedDescription": "",
2883
- "group": "ungrouped",
2884
- "private": true,
2885
- "remoteOp": true,
2886
- "skipWorkspace": true,
2887
- "commands": [
2888
- {
2889
- "name": "list",
2890
- "alias": "",
2891
- "options": [
2892
- [
2893
- "d",
2894
- "details",
2895
- "show more details on the state of each component in each lane"
2896
- ],
2897
- [
2898
- "j",
2899
- "json",
2900
- "show lanes details in a json format"
2901
- ],
2902
- [
2903
- "r",
2904
- "remote <remote-scope-name>",
2905
- "show remote lanes"
2906
- ],
2907
- [
2908
- "",
2909
- "merged",
2910
- "show merged lanes"
2911
- ],
2912
- [
2913
- "",
2914
- "not-merged",
2915
- "show lanes that are not merged"
2916
- ]
2917
- ],
2918
- "description": "list lanes",
2919
- "extendedDescription": "",
2920
- "group": "ungrouped",
2921
- "private": true,
2922
- "remoteOp": true,
2923
- "skipWorkspace": true
2924
- },
2925
- {
2926
- "name": "switch <lane>",
2927
- "alias": "",
2928
- "options": [
2929
- [
2930
- "n",
2931
- "alias <string>",
2932
- "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
2933
- ],
2934
- [
2935
- "m",
2936
- "merge [strategy]",
2937
- "merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
2938
- ],
2939
- [
2940
- "a",
2941
- "get-all",
2942
- "checkout all components in a lane include ones that do not exist in the workspace"
2943
- ],
2944
- [
2945
- "",
2946
- "skip-dependency-installation",
2947
- "do not install packages of the imported components"
2948
- ],
2949
- [
2950
- "j",
2951
- "json",
2952
- "return the output as JSON"
2953
- ]
2954
- ],
2955
- "description": "switch to the specified lane",
2956
- "extendedDescription": "",
2957
- "group": "ungrouped",
2958
- "private": true
2959
- },
2960
- {
2961
- "name": "show <lane-name>",
2962
- "alias": "",
2963
- "options": [
2964
- [
2965
- "j",
2966
- "json",
2967
- "show the lane details in json format"
2968
- ],
2969
- [
2970
- "r",
2971
- "remote <string>",
2972
- "show remote lanes"
2973
- ]
2974
- ],
2975
- "description": "show lane details",
2976
- "extendedDescription": "",
2977
- "group": "ungrouped",
2978
- "private": true,
2979
- "remoteOp": true,
2980
- "skipWorkspace": true
2981
- },
2982
- {
2983
- "name": "create <lane-name>",
2984
- "alias": "",
2985
- "options": [
2986
- [
2987
- "",
2988
- "remote-scope <scope-name>",
2989
- "remote scope where this lane will be exported to, default to the defaultScope (can be changed later with \"bit lane change-scope\")"
2990
- ],
2991
- [
2992
- "",
2993
- "alias <name>",
2994
- "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
2995
- ]
2996
- ],
2997
- "description": "creates a new lane and switches to it",
2998
- "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
2999
- "group": "ungrouped",
3000
- "private": true,
3001
- "arguments": [
3002
- {
3003
- "name": "lane-name",
3004
- "description": "the name for the new lane"
3005
- }
3006
- ]
3007
- },
2788
+ "group": "apps",
2789
+ "private": false,
2790
+ "arguments": [
3008
2791
  {
3009
- "name": "merge <lane> [pattern]",
3010
- "alias": "",
3011
- "options": [
3012
- [
3013
- "",
3014
- "ours",
3015
- "in case of a conflict, override the used version with the current modification"
3016
- ],
3017
- [
3018
- "",
3019
- "theirs",
3020
- "in case of a conflict, override the current modification with the specified version"
3021
- ],
3022
- [
3023
- "",
3024
- "manual",
3025
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
3026
- ],
3027
- [
3028
- "",
3029
- "workspace",
3030
- "merge only components in a lane that exist in the workspace"
3031
- ],
3032
- [
3033
- "",
3034
- "no-snap",
3035
- "do not auto snap in case the merge completed without conflicts"
3036
- ],
3037
- [
3038
- "",
3039
- "build",
3040
- "in case of snap during the merge, run the build-pipeline (similar to bit snap --build)"
3041
- ],
3042
- [
3043
- "m",
3044
- "message <message>",
3045
- "override the default message for the auto snap"
3046
- ],
2792
+ "name": "app-name",
2793
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2794
+ }
2795
+ ]
2796
+ },
2797
+ {
2798
+ "name": "app-list",
2799
+ "alias": "",
2800
+ "options": [
2801
+ [
2802
+ "j",
2803
+ "json",
2804
+ "return the component data in json format"
2805
+ ]
2806
+ ],
2807
+ "description": "DEPRECATED. use \"bit app list\"",
2808
+ "extendedDescription": "",
2809
+ "group": "apps",
2810
+ "private": true
2811
+ },
2812
+ {
2813
+ "name": "app <sub-command>",
2814
+ "alias": "",
2815
+ "options": [],
2816
+ "description": "Manages apps",
2817
+ "extendedDescription": "",
2818
+ "group": "apps",
2819
+ "private": false,
2820
+ "commands": [
2821
+ {
2822
+ "name": "list",
2823
+ "alias": "",
2824
+ "options": [
3047
2825
  [
3048
- "",
3049
- "keep-readme",
3050
- "skip deleting the lane readme component after merging"
3051
- ],
2826
+ "j",
2827
+ "json",
2828
+ "return the component data in json format"
2829
+ ]
2830
+ ],
2831
+ "description": "list all registered apps",
2832
+ "extendedDescription": "",
2833
+ "group": "apps",
2834
+ "private": false
2835
+ },
2836
+ {
2837
+ "name": "run <app-name>",
2838
+ "alias": "c",
2839
+ "options": [
3052
2840
  [
3053
- "",
3054
- "squash",
3055
- "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2841
+ "d",
2842
+ "dev",
2843
+ "start the application in dev mode."
3056
2844
  ],
3057
2845
  [
3058
- "",
2846
+ "v",
3059
2847
  "verbose",
3060
- "show details of components that were not merged legitimately"
3061
- ],
3062
- [
3063
- "",
3064
- "skip-dependency-installation",
3065
- "do not install packages of the imported components"
2848
+ "showing verbose output for inspection and prints stack trace"
3066
2849
  ],
3067
2850
  [
3068
2851
  "",
3069
- "remote",
3070
- "relevant when the target-lane locally is differ than the remote and you want the remote"
2852
+ "skip-watch",
2853
+ "avoid running the watch process that compiles components in the background"
3071
2854
  ],
3072
2855
  [
3073
2856
  "",
3074
- "include-deps",
3075
- "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2857
+ "ssr",
2858
+ "run app in server side rendering mode."
3076
2859
  ]
3077
2860
  ],
3078
- "description": "merge a local or a remote lane",
3079
- "extendedDescription": "if the <lane> exists locally, it will be merged from the local lane.\notherwise, it will fetch the lane from the remote and merge it.\nin case the <lane> exists locally but you want to merge the remote version of it, use --remote flag",
3080
- "group": "ungrouped",
3081
- "private": true,
3082
- "remoteOp": true,
2861
+ "description": "run an app (independent of bit's dev server)",
2862
+ "extendedDescription": "",
2863
+ "group": "apps",
2864
+ "private": false,
3083
2865
  "arguments": [
3084
2866
  {
3085
- "name": "lane",
3086
- "description": "lane-name or lane-id (if not exists locally) to merge to the current lane"
3087
- },
3088
- {
3089
- "name": "pattern",
3090
- "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2867
+ "name": "app-name",
2868
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
3091
2869
  }
3092
2870
  ]
3093
- },
2871
+ }
2872
+ ]
2873
+ },
2874
+ {
2875
+ "name": "test [component-pattern]",
2876
+ "alias": "at",
2877
+ "options": [
2878
+ [
2879
+ "w",
2880
+ "watch",
2881
+ "start the tester in watch mode."
2882
+ ],
2883
+ [
2884
+ "d",
2885
+ "debug",
2886
+ "start the tester in debug mode."
2887
+ ],
2888
+ [
2889
+ "a",
2890
+ "all",
2891
+ "test all components, not only new and modified"
2892
+ ],
2893
+ [
2894
+ "",
2895
+ "junit <filepath>",
2896
+ "write tests results as JUnit XML format into the specified file path"
2897
+ ],
2898
+ [
2899
+ "",
2900
+ "coverage",
2901
+ "show code coverage data"
2902
+ ],
2903
+ [
2904
+ "e",
2905
+ "env <id>",
2906
+ "test only the given env"
2907
+ ],
2908
+ [
2909
+ "s",
2910
+ "scope <scope-name>",
2911
+ "DEPRECATED. (use the pattern instead, e.g. \"scopeName/**\"). name of the scope to test"
2912
+ ]
2913
+ ],
2914
+ "description": "test components in the workspace",
2915
+ "extendedDescription": "",
2916
+ "group": "development",
2917
+ "private": false,
2918
+ "arguments": [
3094
2919
  {
3095
- "name": "remove <lanes...>",
2920
+ "name": "component-pattern",
2921
+ "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"
2922
+ }
2923
+ ]
2924
+ },
2925
+ {
2926
+ "name": "schema <pattern>",
2927
+ "alias": "",
2928
+ "options": [
2929
+ [
2930
+ "j",
2931
+ "json",
2932
+ "return the component data in json format"
2933
+ ]
2934
+ ],
2935
+ "description": "shows the API schema of a certain component.",
2936
+ "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",
2937
+ "group": "development",
2938
+ "private": false
2939
+ },
2940
+ {
2941
+ "name": "check-types [component-pattern]",
2942
+ "alias": "",
2943
+ "options": [
2944
+ [
2945
+ "a",
2946
+ "all",
2947
+ "check-types for all components, not only modified and new"
2948
+ ],
2949
+ [
2950
+ "",
2951
+ "strict",
2952
+ "in case issues found, exit with code 1"
2953
+ ]
2954
+ ],
2955
+ "description": "check typescript types",
2956
+ "extendedDescription": "",
2957
+ "group": "development",
2958
+ "private": false,
2959
+ "arguments": [
2960
+ {
2961
+ "name": "component-pattern",
2962
+ "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"
2963
+ }
2964
+ ]
2965
+ },
2966
+ {
2967
+ "name": "aspect <sub-command>",
2968
+ "alias": "",
2969
+ "options": [],
2970
+ "description": "EXPERIMENTAL. manage aspects",
2971
+ "extendedDescription": "",
2972
+ "group": "development",
2973
+ "private": false,
2974
+ "commands": [
2975
+ {
2976
+ "name": "list [pattern]",
3096
2977
  "alias": "",
3097
2978
  "options": [
3098
2979
  [
3099
- "r",
3100
- "remote",
3101
- "remove a remote lane (in the lane arg, use remote/lane-id syntax)"
3102
- ],
3103
- [
3104
- "f",
3105
- "force",
3106
- "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
3107
- ],
3108
- [
3109
- "s",
3110
- "silent",
3111
- "skip confirmation"
2980
+ "d",
2981
+ "debug",
2982
+ "show the origins were the aspects were taken from"
3112
2983
  ]
3113
2984
  ],
3114
- "description": "remove lanes",
2985
+ "description": "list all aspects configured on component(s)",
3115
2986
  "extendedDescription": "",
3116
- "group": "ungrouped",
3117
- "private": true,
2987
+ "group": "development",
2988
+ "private": false,
3118
2989
  "arguments": [
3119
2990
  {
3120
- "name": "lanes...",
3121
- "description": "A list of lane names, separated by spaces"
2991
+ "name": "pattern",
2992
+ "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"
3122
2993
  }
3123
2994
  ]
3124
2995
  },
3125
2996
  {
3126
- "name": "change-scope <lane-name> <remote-scope-name>",
3127
- "alias": "",
3128
- "options": [],
3129
- "description": "changes the remote scope of a lane",
3130
- "extendedDescription": "",
3131
- "group": "ungrouped",
3132
- "private": true
3133
- },
3134
- {
3135
- "name": "alias <lane-name> <alias>",
3136
- "alias": "",
3137
- "options": [],
3138
- "description": "adds an alias to a lane",
3139
- "extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
3140
- "group": "ungrouped",
3141
- "private": true
3142
- },
3143
- {
3144
- "name": "rename <current-name> <new-name>",
2997
+ "name": "get <component-name>",
3145
2998
  "alias": "",
3146
- "options": [],
3147
- "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
2999
+ "options": [
3000
+ [
3001
+ "d",
3002
+ "debug",
3003
+ "show the origins were the aspects were taken from"
3004
+ ],
3005
+ [
3006
+ "j",
3007
+ "json",
3008
+ "format as json"
3009
+ ]
3010
+ ],
3011
+ "description": "list the aspects set on a component, as well as their config and data",
3148
3012
  "extendedDescription": "",
3149
- "group": "ungrouped",
3150
- "private": true
3013
+ "group": "development",
3014
+ "private": false,
3015
+ "arguments": [
3016
+ {
3017
+ "name": "component-name",
3018
+ "description": "the component name or component id"
3019
+ }
3020
+ ]
3151
3021
  },
3152
3022
  {
3153
- "name": "diff [values...]",
3023
+ "name": "set <pattern> <aspect-id> [config]",
3154
3024
  "alias": "",
3155
3025
  "options": [
3156
3026
  [
3157
- "",
3158
- "pattern <component-pattern>",
3159
- "EXPERIMENTAL. show lane-diff for the specified component-pattern only"
3027
+ "m",
3028
+ "merge",
3029
+ "merge with an existing config if exits. (by default, it replaces the config)"
3160
3030
  ]
3161
3031
  ],
3162
- "description": "show diff between lanes",
3163
- "extendedDescription": "bit lane diff => diff between the current lane and default lane. (only inside workspace).\nbit lane diff to => diff between the current lane (or default-lane when in scope) and \"to\" lane.\nbit lane diff from to => diff between \"from\" lane and \"to\" lane.",
3164
- "group": "ungrouped",
3165
- "private": true,
3166
- "remoteOp": true,
3167
- "skipWorkspace": true
3168
- },
3169
- {
3170
- "name": "add-readme <component-name> [lane-name]",
3171
- "alias": "",
3172
- "options": [],
3173
- "description": "EXPERIMENTAL. adds a readme component to a lane",
3032
+ "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
3174
3033
  "extendedDescription": "",
3175
- "group": "ungrouped",
3176
- "private": true,
3177
- "skipWorkspace": false,
3034
+ "group": "development",
3035
+ "private": false,
3178
3036
  "arguments": [
3179
3037
  {
3180
- "name": "component-id",
3181
- "description": "the component name or id of the component to use as the lane's readme"
3038
+ "name": "pattern",
3039
+ "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"
3182
3040
  },
3183
3041
  {
3184
- "name": "lane-name",
3185
- "description": "the lane to attach the readme to (defaults to the current lane)"
3042
+ "name": "aspect-id",
3043
+ "description": "the aspect's component id"
3044
+ },
3045
+ {
3046
+ "name": "config",
3047
+ "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 ({})."
3186
3048
  }
3187
3049
  ]
3188
3050
  },
3189
3051
  {
3190
- "name": "remove-readme [laneName]",
3052
+ "name": "unset <pattern> <aspect-id>",
3191
3053
  "alias": "",
3192
3054
  "options": [],
3193
- "description": "EXPERIMENTAL. remove lane readme component",
3055
+ "description": "unset an aspect from component(s).",
3194
3056
  "extendedDescription": "",
3195
- "group": "ungrouped",
3196
- "private": true,
3197
- "skipWorkspace": false
3057
+ "group": "development",
3058
+ "private": false,
3059
+ "arguments": [
3060
+ {
3061
+ "name": "pattern",
3062
+ "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"
3063
+ },
3064
+ {
3065
+ "name": "aspect-id",
3066
+ "description": "the aspect's component id"
3067
+ }
3068
+ ]
3198
3069
  },
3199
3070
  {
3200
- "name": "import <lane>",
3071
+ "name": "update <aspect-id> [pattern]",
3201
3072
  "alias": "",
3202
- "options": [
3203
- [
3204
- "",
3205
- "skip-dependency-installation",
3206
- "do not install packages of the imported components"
3207
- ]
3208
- ],
3209
- "description": "import a remote lane to your workspace",
3073
+ "options": [],
3074
+ "description": "update a version of an aspect",
3210
3075
  "extendedDescription": "",
3211
- "group": "ungrouped",
3212
- "private": true,
3076
+ "group": "development",
3077
+ "private": false,
3213
3078
  "arguments": [
3214
3079
  {
3215
- "name": "lane",
3216
- "description": "the remote lane name"
3080
+ "name": "aspect-id",
3081
+ "description": "the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote"
3082
+ },
3083
+ {
3084
+ "name": "pattern",
3085
+ "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"
3086
+ }
3087
+ ],
3088
+ "examples": [
3089
+ {
3090
+ "cmd": "update scope.org/aspect '**/ui/**'",
3091
+ "description": "update \"ui\" components that use scope.org/aspect to use its latest version"
3092
+ },
3093
+ {
3094
+ "cmd": "bit aspect update scope.org/aspect@2.0.0",
3095
+ "description": "update all components that use scope.org/aspect to version 2.0.0 (of this aspect)."
3217
3096
  }
3218
3097
  ]
3219
3098
  }
3220
3099
  ]
3221
3100
  },
3222
3101
  {
3223
- "name": "switch <lane>",
3102
+ "name": "clear-cache",
3103
+ "alias": "cc",
3104
+ "options": [
3105
+ [
3106
+ "r",
3107
+ "remote <remote-name>",
3108
+ "clear memory cache from a remote scope"
3109
+ ]
3110
+ ],
3111
+ "description": "clears Bit's cache from current working machine",
3112
+ "extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash\nhttps://bit.dev/docs/workspace/clearing-cache",
3113
+ "group": "general",
3114
+ "private": false,
3115
+ "skipWorkspace": true
3116
+ },
3117
+ {
3118
+ "name": "log <id>",
3224
3119
  "alias": "",
3225
3120
  "options": [
3226
3121
  [
3227
- "n",
3228
- "alias <string>",
3229
- "relevant when the specified lane is a remote late. name a local lane differently than the remote lane"
3122
+ "r",
3123
+ "remote",
3124
+ "show log of a remote component"
3230
3125
  ],
3231
3126
  [
3232
- "m",
3233
- "merge [strategy]",
3234
- "merge local changes with the checked out version. strategy should be \"theirs\", \"ours\" or \"manual\""
3127
+ "",
3128
+ "parents",
3129
+ "EXPERIMENTAL. show parents and lanes data"
3235
3130
  ],
3236
3131
  [
3237
- "a",
3238
- "get-all",
3239
- "checkout all components in a lane include ones that do not exist in the workspace"
3132
+ "j",
3133
+ "json",
3134
+ "json format"
3135
+ ]
3136
+ ],
3137
+ "description": "show components(s) version history",
3138
+ "extendedDescription": "https://bit.dev/docs/reference/cli-reference#log",
3139
+ "group": "info",
3140
+ "private": false,
3141
+ "remoteOp": true,
3142
+ "skipWorkspace": true,
3143
+ "arguments": [
3144
+ {
3145
+ "name": "id",
3146
+ "description": "component-id or component-name"
3147
+ }
3148
+ ]
3149
+ },
3150
+ {
3151
+ "name": "deprecate <component-name>",
3152
+ "alias": "d",
3153
+ "options": [
3154
+ [
3155
+ "",
3156
+ "new-id <string>",
3157
+ "if replaced by another component, enter the new component id"
3158
+ ]
3159
+ ],
3160
+ "description": "deprecate a component",
3161
+ "extendedDescription": "",
3162
+ "group": "collaborate",
3163
+ "private": false,
3164
+ "remoteOp": true,
3165
+ "skipWorkspace": true,
3166
+ "arguments": [
3167
+ {
3168
+ "name": "component-name",
3169
+ "description": "component name or component id"
3170
+ }
3171
+ ]
3172
+ },
3173
+ {
3174
+ "name": "undeprecate <id>",
3175
+ "alias": "",
3176
+ "options": [],
3177
+ "description": "undeprecate a deprecated component (local/remote)",
3178
+ "extendedDescription": "",
3179
+ "group": "collaborate",
3180
+ "private": false,
3181
+ "remoteOp": true,
3182
+ "skipWorkspace": true
3183
+ },
3184
+ {
3185
+ "name": "rename <current-name> <new-name>",
3186
+ "alias": "",
3187
+ "options": [
3188
+ [
3189
+ "s",
3190
+ "scope <scope-name>",
3191
+ "default scope for the newly created component"
3192
+ ],
3193
+ [
3194
+ "p",
3195
+ "path <relative-path>",
3196
+ "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
3197
+ ],
3198
+ [
3199
+ "r",
3200
+ "refactor",
3201
+ "update the import/require statements in all dependent components (in the same workspace)"
3202
+ ]
3203
+ ],
3204
+ "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
3205
+ "extendedDescription": "",
3206
+ "group": "collaborate",
3207
+ "private": false,
3208
+ "remoteOp": true,
3209
+ "skipWorkspace": true,
3210
+ "arguments": [
3211
+ {
3212
+ "name": "current-name",
3213
+ "description": "the current component name (without its scope name)"
3214
+ },
3215
+ {
3216
+ "name": "new-name",
3217
+ "description": "the new component name (without its scope name)"
3218
+ }
3219
+ ]
3220
+ },
3221
+ {
3222
+ "name": "fork <source-component-id> [target-component-name]",
3223
+ "alias": "",
3224
+ "options": [
3225
+ [
3226
+ "s",
3227
+ "scope <string>",
3228
+ "default scope for the new component"
3229
+ ],
3230
+ [
3231
+ "p",
3232
+ "path <string>",
3233
+ "relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>`"
3234
+ ],
3235
+ [
3236
+ "r",
3237
+ "refactor",
3238
+ "update the import/require statements in all dependent components (in the same workspace)"
3240
3239
  ],
3241
3240
  [
3242
3241
  "",
3243
3242
  "skip-dependency-installation",
3244
3243
  "do not install packages of the imported components"
3245
- ],
3246
- [
3247
- "j",
3248
- "json",
3249
- "return the output as JSON"
3250
3244
  ]
3251
3245
  ],
3252
- "description": "switch to the specified lane",
3246
+ "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
3253
3247
  "extendedDescription": "",
3254
- "group": "ungrouped",
3255
- "private": true
3248
+ "group": "collaborate",
3249
+ "private": false,
3250
+ "remoteOp": true,
3251
+ "skipWorkspace": true,
3252
+ "arguments": [
3253
+ {
3254
+ "name": "source-component-id",
3255
+ "description": "the component id of the source component"
3256
+ },
3257
+ {
3258
+ "name": "target-component-name",
3259
+ "description": "the name for the new component (component name without scope). to set a different scope, use the '--scope' flag"
3260
+ }
3261
+ ]
3256
3262
  },
3257
3263
  {
3258
3264
  "name": "eject <component-pattern>",