@teambit/harmony.content.cli-reference 1.95.55 → 1.95.58

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