@teambit/harmony.content.cli-reference 1.95.128 → 1.95.129

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 +14 -14
  2. package/cli-reference.mdx +166 -1
  3. package/dist/cli-reference.json +14 -14
  4. package/dist/cli-reference.mdx.js +854 -3
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/dist/{preview-1678787991876.js → preview-1678982624699.js} +2 -2
  7. package/package-tar/teambit-harmony.content.cli-reference-1.95.129.tgz +0 -0
  8. package/package.json +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.128.tgz +0 -0
package/cli-reference.json CHANGED
@@ -1839,8 +1839,8 @@
1839
1839
  ],
1840
1840
  [
1841
1841
  "e",
1842
- "entire-lane",
1843
- "write also new components that were introduced on the remote lane and do not exist locally"
1842
+ "workspace-only",
1843
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
1844
1844
  ],
1845
1845
  [
1846
1846
  "v",
@@ -2647,8 +2647,8 @@
2647
2647
  ],
2648
2648
  "description": "manage lanes",
2649
2649
  "extendedDescription": "",
2650
- "group": "ungrouped",
2651
- "private": true,
2650
+ "group": "collaborate",
2651
+ "private": false,
2652
2652
  "remoteOp": true,
2653
2653
  "skipWorkspace": true,
2654
2654
  "commands": [
@@ -2685,7 +2685,7 @@
2685
2685
  "description": "list lanes",
2686
2686
  "extendedDescription": "",
2687
2687
  "group": "ungrouped",
2688
- "private": true,
2688
+ "private": false,
2689
2689
  "remoteOp": true,
2690
2690
  "skipWorkspace": true
2691
2691
  },
@@ -2742,7 +2742,7 @@
2742
2742
  "description": "show lane details. if no lane specified, show the current lane",
2743
2743
  "extendedDescription": "",
2744
2744
  "group": "ungrouped",
2745
- "private": true,
2745
+ "private": false,
2746
2746
  "remoteOp": true,
2747
2747
  "skipWorkspace": true
2748
2748
  },
@@ -2758,13 +2758,13 @@
2758
2758
  [
2759
2759
  "",
2760
2760
  "alias <name>",
2761
- "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
2761
+ "a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with \"bit lane alias\")"
2762
2762
  ]
2763
2763
  ],
2764
2764
  "description": "creates a new lane and switches to it",
2765
2765
  "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.",
2766
2766
  "group": "ungrouped",
2767
- "private": true,
2767
+ "private": false,
2768
2768
  "arguments": [
2769
2769
  {
2770
2770
  "name": "lane-name",
@@ -2810,7 +2810,7 @@
2810
2810
  "description": "changes the remote scope of a lane",
2811
2811
  "extendedDescription": "",
2812
2812
  "group": "ungrouped",
2813
- "private": true
2813
+ "private": false
2814
2814
  },
2815
2815
  {
2816
2816
  "name": "alias <lane-name> <alias>",
@@ -2819,7 +2819,7 @@
2819
2819
  "description": "adds an alias to a lane",
2820
2820
  "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.",
2821
2821
  "group": "ungrouped",
2822
- "private": true
2822
+ "private": false
2823
2823
  },
2824
2824
  {
2825
2825
  "name": "rename <current-name> <new-name>",
@@ -2828,7 +2828,7 @@
2828
2828
  "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
2829
2829
  "extendedDescription": "",
2830
2830
  "group": "ungrouped",
2831
- "private": true
2831
+ "private": false
2832
2832
  },
2833
2833
  {
2834
2834
  "name": "diff [values...]",
@@ -2854,7 +2854,7 @@
2854
2854
  "description": "EXPERIMENTAL. adds a readme component to a lane",
2855
2855
  "extendedDescription": "",
2856
2856
  "group": "ungrouped",
2857
- "private": true,
2857
+ "private": false,
2858
2858
  "skipWorkspace": false,
2859
2859
  "arguments": [
2860
2860
  {
@@ -2874,7 +2874,7 @@
2874
2874
  "description": "EXPERIMENTAL. remove lane readme component",
2875
2875
  "extendedDescription": "",
2876
2876
  "group": "ungrouped",
2877
- "private": true,
2877
+ "private": false,
2878
2878
  "skipWorkspace": false
2879
2879
  },
2880
2880
  {
@@ -2890,7 +2890,7 @@
2890
2890
  "description": "import a remote lane to your workspace",
2891
2891
  "extendedDescription": "",
2892
2892
  "group": "ungrouped",
2893
- "private": true,
2893
+ "private": false,
2894
2894
  "arguments": [
2895
2895
  {
2896
2896
  "name": "lane",
package/cli-reference.mdx CHANGED
@@ -240,7 +240,7 @@ with no args, only workspace's capsules are deleted
240
240
  | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
241
241
  | `--reset` | `-r` | revert changes that were not snapped/tagged |
242
242
  | `--all` | `-a` | all components |
243
- | `--entire-lane` | `-e` | write also new components that were introduced on the remote lane and do not exist locally |
243
+ | `--workspace-only` | `-e` | when on a lane, avoid introducing new components from the remote lane that do not exist locally |
244
244
  | `--verbose` | `-v` | showing verbose output for inspection |
245
245
  | `--reset` | | DEPRECATED. run "bit checkout reset" instead |
246
246
  | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
@@ -745,6 +745,171 @@ when no package is specified, all workspace dependencies are installed and all w
745
745
 
746
746
  ---
747
747
 
748
+ ## lane
749
+
750
+ **Description**: manage lanes
751
+
752
+ `bit lane [lane-name]`
753
+
754
+ ### lane list
755
+
756
+ **Usage**: `lane list`
757
+
758
+ **Description**: list lanes
759
+
760
+ | **Option** | **Option alias** | **Description** |
761
+ | ------------------------------ | :--------------: | ------------------------------------------------------------- |
762
+ | `--details` | `-d` | show more details on the state of each component in each lane |
763
+ | `--json` | `-j` | show lanes details in a json format |
764
+ | `--remote <remote-scope-name>` | `-r` | show remote lanes |
765
+ | `--merged` | | show merged lanes |
766
+ | `--not-merged` | | show lanes that are not merged |
767
+
768
+ ### lane switch
769
+
770
+ **Usage**: `lane switch <lane>`
771
+
772
+ **Description**: switch to the specified lane
773
+
774
+ | **Option** | **Option alias** | **Description** |
775
+ | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
776
+ | `--alias <string>` | `-n` | relevant when the specified lane is a remote late. name a local lane differently than the remote lane |
777
+ | `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
778
+ | `--get-all` | `-a` | checkout all components in a lane include ones that do not exist in the workspace |
779
+ | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
780
+ | `--json` | `-j` | return the output as JSON |
781
+
782
+ ### lane show
783
+
784
+ **Usage**: `lane show [lane-name]`
785
+
786
+ **Description**: show lane details. if no lane specified, show the current lane
787
+
788
+ | **Option** | **Option alias** | **Description** |
789
+ | ------------------- | :--------------: | ------------------------------------ |
790
+ | `--json` | `-j` | show the lane details in json format |
791
+ | `--remote <string>` | `-r` | show remote lanes |
792
+
793
+ ### lane create
794
+
795
+ **Usage**: `lane create <lane-name>`
796
+
797
+ **Description**: creates a new lane and switches to it
798
+ a lane created from main (default-lane) is empty until components are snapped.
799
+ a lane created from another lane has all the components of the original lane.
800
+
801
+ | **Option** | **Option alias** | **Description** |
802
+ | ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------- |
803
+ | `--remote-scope <scope-name>` | | remote scope where this lane will be exported to, default to the defaultScope (can be changed later with "bit lane change-scope") |
804
+ | `--alias <name>` | | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias") |
805
+
806
+ ### lane remove
807
+
808
+ **Usage**: `lane remove <lanes...>`
809
+
810
+ **Description**: remove lanes
811
+
812
+ | **Option** | **Option alias** | **Description** |
813
+ | ---------- | :--------------: | ----------------------------------------------------------------- |
814
+ | `--remote` | `-r` | remove a remote lane (in the lane arg, use remote/lane-id syntax) |
815
+ | `--force` | `-f` | removes the lane even when the lane was not merged yet |
816
+ | `--silent` | `-s` | skip confirmation |
817
+
818
+ ### lane change-scope
819
+
820
+ **Usage**: `lane change-scope <lane-name> <remote-scope-name>`
821
+
822
+ **Description**: changes the remote scope of a lane
823
+
824
+ ### lane alias
825
+
826
+ **Usage**: `lane alias <lane-name> <alias>`
827
+
828
+ **Description**: adds an alias to a lane
829
+ an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.
830
+ it is useful when having multiple lanes with the same name, but with different remote scopes.
831
+
832
+ ### lane rename
833
+
834
+ **Usage**: `lane rename <current-name> <new-name>`
835
+
836
+ **Description**: EXPERIMENTAL. change the lane-name locally and on the remote (if exported)
837
+
838
+ ### lane diff
839
+
840
+ **Usage**: `lane diff [values...]`
841
+
842
+ **Description**: show diff between lanes
843
+ bit lane diff => diff between the current lane and default lane. (only inside workspace).
844
+ bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
845
+ bit lane diff from to => diff between "from" lane and "to" lane.
846
+
847
+ | **Option** | **Option alias** | **Description** |
848
+ | ------------------------------- | :--------------: | --------------------------------------------------------------------- |
849
+ | `--pattern <component-pattern>` | | EXPERIMENTAL. show lane-diff for the specified component-pattern only |
850
+
851
+ ### lane add-readme
852
+
853
+ **Usage**: `lane add-readme <component-name> [lane-name]`
854
+
855
+ **Description**: EXPERIMENTAL. adds a readme component to a lane
856
+
857
+ ### lane remove-readme
858
+
859
+ **Usage**: `lane remove-readme [laneName]`
860
+
861
+ **Description**: EXPERIMENTAL. remove lane readme component
862
+
863
+ ### lane import
864
+
865
+ **Usage**: `lane import <lane>`
866
+
867
+ **Description**: import a remote lane to your workspace
868
+
869
+ | **Option** | **Option alias** | **Description** |
870
+ | -------------------------------- | :--------------: | -------------------------------------------------- |
871
+ | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
872
+
873
+ ### lane merge
874
+
875
+ **Usage**: `lane merge <lane> [pattern]`
876
+
877
+ **Description**: merge a local or a remote lane
878
+ by default, the provided lane will be fetched from the remote before merging.
879
+ to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
880
+
881
+ when the current and the other lanes are diverged in history and the files could be merged with no conflicts,
882
+ it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
883
+
884
+ | **Option** | **Option alias** | **Description** |
885
+ | -------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
886
+ | `--ours` | | in case of a conflict, override the used version with the current modification |
887
+ | `--theirs` | | in case of a conflict, override the current modification with the specified version |
888
+ | `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
889
+ | `--workspace` | | merge only components in a lane that exist in the workspace |
890
+ | `--no-snap` | | do not auto snap in case the merge completed without conflicts |
891
+ | `--tag` | | tag all lane components after merging into main (also tag-merge in case of snap-merge) |
892
+ | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
893
+ | `--message <message>` | `-m` | override the default message for the auto snap |
894
+ | `--keep-readme` | | skip deleting the lane readme component after merging |
895
+ | `--no-squash` | | EXPERIMENTAL. relevant for merging lanes into main, which by default squash. |
896
+ | `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files |
897
+ | `--verbose` | | show details of components that were not merged legitimately |
898
+ | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
899
+ | `--skip-fetch` | | use the current target-lane if exits locally without updating it from the remote |
900
+ | `--include-deps` | | EXPERIMENTAL. relevant for "--pattern" and "--workspace". merge also dependencies of the given components |
901
+ | `--resolve-unrelated [merge-strategy]` | | EXPERIMENTAL. relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be "ours" (default) or "theirs" |
902
+
903
+ | **Option** | **Option alias** | **Description** |
904
+ | ------------------- | :--------------: | ------------------------------------------------------------- |
905
+ | `--details` | `-d` | show more details on the state of each component in each lane |
906
+ | `--json` | `-j` | show lanes details in json format |
907
+ | `--remote <string>` | `-r` | show remote lanes |
908
+ | `--merged` | | show merged lanes |
909
+ | `--not-merged` | | show not merged lanes |
910
+
911
+ ---
912
+
748
913
  ## link
749
914
 
750
915
  **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
package/dist/cli-reference.json CHANGED
@@ -1839,8 +1839,8 @@
1839
1839
  ],
1840
1840
  [
1841
1841
  "e",
1842
- "entire-lane",
1843
- "write also new components that were introduced on the remote lane and do not exist locally"
1842
+ "workspace-only",
1843
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
1844
1844
  ],
1845
1845
  [
1846
1846
  "v",
@@ -2647,8 +2647,8 @@
2647
2647
  ],
2648
2648
  "description": "manage lanes",
2649
2649
  "extendedDescription": "",
2650
- "group": "ungrouped",
2651
- "private": true,
2650
+ "group": "collaborate",
2651
+ "private": false,
2652
2652
  "remoteOp": true,
2653
2653
  "skipWorkspace": true,
2654
2654
  "commands": [
@@ -2685,7 +2685,7 @@
2685
2685
  "description": "list lanes",
2686
2686
  "extendedDescription": "",
2687
2687
  "group": "ungrouped",
2688
- "private": true,
2688
+ "private": false,
2689
2689
  "remoteOp": true,
2690
2690
  "skipWorkspace": true
2691
2691
  },
@@ -2742,7 +2742,7 @@
2742
2742
  "description": "show lane details. if no lane specified, show the current lane",
2743
2743
  "extendedDescription": "",
2744
2744
  "group": "ungrouped",
2745
- "private": true,
2745
+ "private": false,
2746
2746
  "remoteOp": true,
2747
2747
  "skipWorkspace": true
2748
2748
  },
@@ -2758,13 +2758,13 @@
2758
2758
  [
2759
2759
  "",
2760
2760
  "alias <name>",
2761
- "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
2761
+ "a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with \"bit lane alias\")"
2762
2762
  ]
2763
2763
  ],
2764
2764
  "description": "creates a new lane and switches to it",
2765
2765
  "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.",
2766
2766
  "group": "ungrouped",
2767
- "private": true,
2767
+ "private": false,
2768
2768
  "arguments": [
2769
2769
  {
2770
2770
  "name": "lane-name",
@@ -2810,7 +2810,7 @@
2810
2810
  "description": "changes the remote scope of a lane",
2811
2811
  "extendedDescription": "",
2812
2812
  "group": "ungrouped",
2813
- "private": true
2813
+ "private": false
2814
2814
  },
2815
2815
  {
2816
2816
  "name": "alias <lane-name> <alias>",
@@ -2819,7 +2819,7 @@
2819
2819
  "description": "adds an alias to a lane",
2820
2820
  "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.",
2821
2821
  "group": "ungrouped",
2822
- "private": true
2822
+ "private": false
2823
2823
  },
2824
2824
  {
2825
2825
  "name": "rename <current-name> <new-name>",
@@ -2828,7 +2828,7 @@
2828
2828
  "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
2829
2829
  "extendedDescription": "",
2830
2830
  "group": "ungrouped",
2831
- "private": true
2831
+ "private": false
2832
2832
  },
2833
2833
  {
2834
2834
  "name": "diff [values...]",
@@ -2854,7 +2854,7 @@
2854
2854
  "description": "EXPERIMENTAL. adds a readme component to a lane",
2855
2855
  "extendedDescription": "",
2856
2856
  "group": "ungrouped",
2857
- "private": true,
2857
+ "private": false,
2858
2858
  "skipWorkspace": false,
2859
2859
  "arguments": [
2860
2860
  {
@@ -2874,7 +2874,7 @@
2874
2874
  "description": "EXPERIMENTAL. remove lane readme component",
2875
2875
  "extendedDescription": "",
2876
2876
  "group": "ungrouped",
2877
- "private": true,
2877
+ "private": false,
2878
2878
  "skipWorkspace": false
2879
2879
  },
2880
2880
  {
@@ -2890,7 +2890,7 @@
2890
2890
  "description": "import a remote lane to your workspace",
2891
2891
  "extendedDescription": "",
2892
2892
  "group": "ungrouped",
2893
- "private": true,
2893
+ "private": false,
2894
2894
  "arguments": [
2895
2895
  {
2896
2896
  "name": "lane",