@teambit/harmony.content.cli-reference 1.95.148 → 1.95.150

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.
@@ -878,7 +878,7 @@
878
878
  ]
879
879
  },
880
880
  {
881
- "name": "start [type] [pattern]",
881
+ "name": "start [component-pattern]",
882
882
  "alias": "c",
883
883
  "options": [
884
884
  [
@@ -907,7 +907,7 @@
907
907
  "show verbose output for inspection and prints stack trace"
908
908
  ],
909
909
  [
910
- "",
910
+ "n",
911
911
  "no-browser",
912
912
  "do not automatically open browser when ready"
913
913
  ],
@@ -915,12 +915,23 @@
915
915
  "",
916
916
  "skip-compilation",
917
917
  "skip the auto-compilation before starting the web-server"
918
+ ],
919
+ [
920
+ "u",
921
+ "ui-root-name [type]",
922
+ "name of the ui root to use, e.g. \"teambit.scope/scope\" or \"teambit.workspace/workspace\""
918
923
  ]
919
924
  ],
920
925
  "description": "run the ui/development server",
921
926
  "extendedDescription": "",
922
927
  "group": "development",
923
- "private": false
928
+ "private": false,
929
+ "arguments": [
930
+ {
931
+ "name": "component-pattern",
932
+ "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"
933
+ }
934
+ ]
924
935
  },
925
936
  {
926
937
  "name": "ui-build [type]",
@@ -1245,25 +1256,6 @@
1245
1256
  "group": "development",
1246
1257
  "private": false
1247
1258
  },
1248
- {
1249
- "name": "move <current-component-dir> <new-component-dir>",
1250
- "alias": "mv",
1251
- "options": [],
1252
- "description": "move a component to a different filesystem path",
1253
- "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
1254
- "group": "development",
1255
- "private": false,
1256
- "arguments": [
1257
- {
1258
- "name": "current-component-dir",
1259
- "description": "the current relative path (in the workspace) to the component directory"
1260
- },
1261
- {
1262
- "name": "new-component-dir",
1263
- "description": "the new relative path (in the workspace) to the component directory"
1264
- }
1265
- ]
1266
- },
1267
1259
  {
1268
1260
  "name": "add [path...]",
1269
1261
  "alias": "a",
@@ -1304,21 +1296,6 @@
1304
1296
  "group": "development",
1305
1297
  "private": false
1306
1298
  },
1307
- {
1308
- "name": "server",
1309
- "alias": "",
1310
- "options": [
1311
- [
1312
- "p",
1313
- "port [port]",
1314
- "port to run the server on"
1315
- ]
1316
- ],
1317
- "description": "EXPERIMENTAL. communicate with bit cli program via http requests",
1318
- "extendedDescription": "",
1319
- "group": "general",
1320
- "private": false
1321
- },
1322
1299
  {
1323
1300
  "name": "create <template-name> <component-names...>",
1324
1301
  "alias": "",
@@ -1505,6 +1482,11 @@
1505
1482
  "",
1506
1483
  "skip-tests",
1507
1484
  "skip running component tests during tag process"
1485
+ ],
1486
+ [
1487
+ "",
1488
+ "fail-fast",
1489
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
1508
1490
  ]
1509
1491
  ],
1510
1492
  "description": "run set of tasks for build",
@@ -1554,42 +1536,6 @@
1554
1536
  }
1555
1537
  ]
1556
1538
  },
1557
- {
1558
- "name": "compile [component-names...]",
1559
- "alias": "",
1560
- "options": [
1561
- [
1562
- "c",
1563
- "changed",
1564
- "compile only new and modified components"
1565
- ],
1566
- [
1567
- "v",
1568
- "verbose",
1569
- "show more data, such as, dist paths"
1570
- ],
1571
- [
1572
- "j",
1573
- "json",
1574
- "return the compile results in json format"
1575
- ],
1576
- [
1577
- "d",
1578
- "delete-dist-dir",
1579
- "delete existing dist folder before writing new compiled files"
1580
- ]
1581
- ],
1582
- "description": "compile components in the workspace",
1583
- "extendedDescription": "",
1584
- "group": "development",
1585
- "private": false,
1586
- "arguments": [
1587
- {
1588
- "name": "component-names...",
1589
- "description": "a list of component names or component IDs (defaults to all components)"
1590
- }
1591
- ]
1592
- },
1593
1539
  {
1594
1540
  "name": "run <app-name>",
1595
1541
  "alias": "c",
@@ -1718,6 +1664,42 @@
1718
1664
  "group": "development",
1719
1665
  "private": true
1720
1666
  },
1667
+ {
1668
+ "name": "compile [component-names...]",
1669
+ "alias": "",
1670
+ "options": [
1671
+ [
1672
+ "c",
1673
+ "changed",
1674
+ "compile only new and modified components"
1675
+ ],
1676
+ [
1677
+ "v",
1678
+ "verbose",
1679
+ "show more data, such as, dist paths"
1680
+ ],
1681
+ [
1682
+ "j",
1683
+ "json",
1684
+ "return the compile results in json format"
1685
+ ],
1686
+ [
1687
+ "d",
1688
+ "delete-dist-dir",
1689
+ "delete existing dist folder before writing new compiled files"
1690
+ ]
1691
+ ],
1692
+ "description": "compile components in the workspace",
1693
+ "extendedDescription": "",
1694
+ "group": "development",
1695
+ "private": false,
1696
+ "arguments": [
1697
+ {
1698
+ "name": "component-names...",
1699
+ "description": "a list of component names or component IDs (defaults to all components)"
1700
+ }
1701
+ ]
1702
+ },
1721
1703
  {
1722
1704
  "name": "install [packages...]",
1723
1705
  "alias": "in",
@@ -1854,6 +1836,25 @@
1854
1836
  }
1855
1837
  ]
1856
1838
  },
1839
+ {
1840
+ "name": "move <current-component-dir> <new-component-dir>",
1841
+ "alias": "mv",
1842
+ "options": [],
1843
+ "description": "move a component to a different filesystem path",
1844
+ "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
1845
+ "group": "development",
1846
+ "private": false,
1847
+ "arguments": [
1848
+ {
1849
+ "name": "current-component-dir",
1850
+ "description": "the current relative path (in the workspace) to the component directory"
1851
+ },
1852
+ {
1853
+ "name": "new-component-dir",
1854
+ "description": "the new relative path (in the workspace) to the component directory"
1855
+ }
1856
+ ]
1857
+ },
1857
1858
  {
1858
1859
  "name": "import [component-patterns...]",
1859
1860
  "alias": "",
@@ -2054,71 +2055,6 @@
2054
2055
  "group": "collaborate",
2055
2056
  "private": false
2056
2057
  },
2057
- {
2058
- "name": "checkout <to> [component-pattern]",
2059
- "alias": "U",
2060
- "options": [
2061
- [
2062
- "i",
2063
- "interactive-merge",
2064
- "when a component is modified and the merge process found conflicts, display options to resolve them"
2065
- ],
2066
- [
2067
- "o",
2068
- "ours",
2069
- "in case of a conflict, override the used version with the current modification"
2070
- ],
2071
- [
2072
- "t",
2073
- "theirs",
2074
- "in case of a conflict, override the current modification with the specified version"
2075
- ],
2076
- [
2077
- "m",
2078
- "manual",
2079
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2080
- ],
2081
- [
2082
- "r",
2083
- "reset",
2084
- "revert changes that were not snapped/tagged"
2085
- ],
2086
- [
2087
- "a",
2088
- "all",
2089
- "all components"
2090
- ],
2091
- [
2092
- "e",
2093
- "workspace-only",
2094
- "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2095
- ],
2096
- [
2097
- "v",
2098
- "verbose",
2099
- "showing verbose output for inspection"
2100
- ],
2101
- [
2102
- "x",
2103
- "skip-dependency-installation",
2104
- "do not install packages of the imported components"
2105
- ]
2106
- ],
2107
- "description": "switch between component versions or remove local changes",
2108
- "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2109
- "group": "development",
2110
- "private": false,
2111
- "arguments": [
2112
- {
2113
- "name": "to",
2114
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2115
- },
2116
- {
2117
- "name": "component-pattern",
2118
- "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"
2119
- }
2120
- ]
2121
- },
2122
2058
  {
2123
2059
  "name": "resume-export <export-id> <remotes...>",
2124
2060
  "alias": "",
@@ -2315,6 +2251,11 @@
2315
2251
  "ignore-newest-version",
2316
2252
  "ignore existing of newer versions (default = false)"
2317
2253
  ],
2254
+ [
2255
+ "",
2256
+ "fail-fast",
2257
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2258
+ ],
2318
2259
  [
2319
2260
  "b",
2320
2261
  "build",
@@ -2418,6 +2359,11 @@
2418
2359
  "all",
2419
2360
  "DEPRECATED (not needed anymore, it is the default now). snap all new and modified components"
2420
2361
  ],
2362
+ [
2363
+ "",
2364
+ "fail-fast",
2365
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2366
+ ],
2421
2367
  [
2422
2368
  "f",
2423
2369
  "force",
@@ -2616,6 +2562,137 @@
2616
2562
  "group": "ungrouped",
2617
2563
  "private": true
2618
2564
  },
2565
+ {
2566
+ "name": "checkout <to> [component-pattern]",
2567
+ "alias": "U",
2568
+ "options": [
2569
+ [
2570
+ "i",
2571
+ "interactive-merge",
2572
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
2573
+ ],
2574
+ [
2575
+ "o",
2576
+ "ours",
2577
+ "in case of a conflict, override the used version with the current modification"
2578
+ ],
2579
+ [
2580
+ "t",
2581
+ "theirs",
2582
+ "in case of a conflict, override the current modification with the specified version"
2583
+ ],
2584
+ [
2585
+ "m",
2586
+ "manual",
2587
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2588
+ ],
2589
+ [
2590
+ "r",
2591
+ "reset",
2592
+ "revert changes that were not snapped/tagged"
2593
+ ],
2594
+ [
2595
+ "a",
2596
+ "all",
2597
+ "all components"
2598
+ ],
2599
+ [
2600
+ "e",
2601
+ "workspace-only",
2602
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2603
+ ],
2604
+ [
2605
+ "v",
2606
+ "verbose",
2607
+ "showing verbose output for inspection"
2608
+ ],
2609
+ [
2610
+ "x",
2611
+ "skip-dependency-installation",
2612
+ "do not install packages of the imported components"
2613
+ ]
2614
+ ],
2615
+ "description": "switch between component versions or remove local changes",
2616
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2617
+ "group": "development",
2618
+ "private": false,
2619
+ "arguments": [
2620
+ {
2621
+ "name": "to",
2622
+ "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2623
+ },
2624
+ {
2625
+ "name": "component-pattern",
2626
+ "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"
2627
+ }
2628
+ ]
2629
+ },
2630
+ {
2631
+ "name": "stash [sub-command]",
2632
+ "alias": "",
2633
+ "options": [
2634
+ [
2635
+ "p",
2636
+ "pattern",
2637
+ "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"
2638
+ ],
2639
+ [
2640
+ "m",
2641
+ "message <string>",
2642
+ "message to be attached to the stashed components"
2643
+ ]
2644
+ ],
2645
+ "description": "EXPERIMENTAL (more like a POC). stash modified components",
2646
+ "extendedDescription": "",
2647
+ "group": "development",
2648
+ "private": true,
2649
+ "commands": [
2650
+ {
2651
+ "name": "save",
2652
+ "alias": "",
2653
+ "options": [
2654
+ [
2655
+ "p",
2656
+ "pattern",
2657
+ "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"
2658
+ ],
2659
+ [
2660
+ "m",
2661
+ "message <string>",
2662
+ "message to be attached to the stashed components"
2663
+ ]
2664
+ ],
2665
+ "description": "stash modified components",
2666
+ "extendedDescription": "",
2667
+ "group": "development",
2668
+ "private": false
2669
+ },
2670
+ {
2671
+ "name": "load",
2672
+ "alias": "",
2673
+ "options": [],
2674
+ "description": "load latest stash, checkout components and delete stash",
2675
+ "extendedDescription": "",
2676
+ "group": "development",
2677
+ "private": false
2678
+ }
2679
+ ]
2680
+ },
2681
+ {
2682
+ "name": "server",
2683
+ "alias": "",
2684
+ "options": [
2685
+ [
2686
+ "p",
2687
+ "port [port]",
2688
+ "port to run the server on"
2689
+ ]
2690
+ ],
2691
+ "description": "EXPERIMENTAL. communicate with bit cli program via http requests",
2692
+ "extendedDescription": "",
2693
+ "group": "general",
2694
+ "private": false
2695
+ },
2619
2696
  {
2620
2697
  "name": "merge [ids...]",
2621
2698
  "alias": "",
@@ -2807,8 +2884,8 @@
2807
2884
  ],
2808
2885
  [
2809
2886
  "r",
2810
- "remote <string>",
2811
- "show remote lanes"
2887
+ "remote",
2888
+ "show the lane from remote"
2812
2889
  ]
2813
2890
  ],
2814
2891
  "description": "show lane details. if no lane specified, show the current lane",
package/cli-reference.mdx CHANGED
@@ -154,6 +154,7 @@ and a package.tgz file generated by pkg aspect.
154
154
  | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
155
155
  | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
156
156
  | `--skip-tests` | | skip running component tests during tag process |
157
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
157
158
 
158
159
  ---
159
160
 
@@ -789,10 +790,10 @@ when no package is specified, all workspace dependencies are installed and all w
789
790
 
790
791
  **Description**: show lane details. if no lane specified, show the current lane
791
792
 
792
- | **Option** | **Option alias** | **Description** |
793
- | ------------------- | :--------------: | ------------------------------------ |
794
- | `--json` | `-j` | show the lane details in json format |
795
- | `--remote <string>` | `-r` | show remote lanes |
793
+ | **Option** | **Option alias** | **Description** |
794
+ | ---------- | :--------------: | ------------------------------------ |
795
+ | `--json` | `-j` | show the lane details in json format |
796
+ | `--remote` | `-r` | show the lane from remote |
796
797
 
797
798
  ### lane create
798
799
 
@@ -1365,6 +1366,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1365
1366
  | `--force-deploy` | | run the deploy pipeline although the build failed |
1366
1367
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1367
1368
  | `--all` | `-a` | DEPRECATED (not needed anymore, it is the default now). snap all new and modified components |
1369
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
1368
1370
  | `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-snap even if tests are failing and even when component has not changed |
1369
1371
 
1370
1372
  ---
@@ -1374,17 +1376,18 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1374
1376
  **Alias**: `c`
1375
1377
  **Description**: run the ui/development server
1376
1378
 
1377
- `bit start [type] [pattern]`
1379
+ `bit start [component-pattern]`
1378
1380
 
1379
- | **Option** | **Option alias** | **Description** |
1380
- | ---------------------- | :--------------: | --------------------------------------------------------- |
1381
- | `--dev` | `-d` | start UI server in dev mode. |
1382
- | `--port [port-number]` | `-p` | port of the UI server. |
1383
- | `--rebuild` | `-r` | rebuild the UI |
1384
- | `--skip-ui-build` | | skip building UI |
1385
- | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1386
- | `--no-browser` | | do not automatically open browser when ready |
1387
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1381
+ | **Option** | **Option alias** | **Description** |
1382
+ | ----------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1383
+ | `--dev` | `-d` | start UI server in dev mode. |
1384
+ | `--port [port-number]` | `-p` | port of the UI server. |
1385
+ | `--rebuild` | `-r` | rebuild the UI |
1386
+ | `--skip-ui-build` | | skip building UI |
1387
+ | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1388
+ | `--no-browser` | `-n` | do not automatically open browser when ready |
1389
+ | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1390
+ | `--ui-root-name [type]` | `-u` | name of the ui root to use, e.g. "teambit.scope/scope" or "teambit.workspace/workspace" |
1388
1391
 
1389
1392
  ---
1390
1393
 
@@ -1450,6 +1453,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1450
1453
  | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1451
1454
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1452
1455
  | `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
1456
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
1453
1457
  | `--build` | `-b` | EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag |
1454
1458
  | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1455
1459
  | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |