@teambit/harmony.content.cli-reference 2.0.215 → 2.0.217

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.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.100'
2
+ description: 'Bit command synopses. Bit version: 1.6.102'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -266,31 +266,6 @@
266
266
  "j",
267
267
  "json",
268
268
  "json format"
269
- ],
270
- [
271
- "g",
272
- "graph",
273
- "generate graph image"
274
- ],
275
- [
276
- "p",
277
- "graph-path <image>",
278
- "relevant for --graph only. image path and format. use one of the following extensions: [gif, png, svg]"
279
- ],
280
- [
281
- "",
282
- "layout <name>",
283
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
284
- ],
285
- [
286
- "",
287
- "short-hash",
288
- "relevant for --graph only. show only 9 chars of the hash"
289
- ],
290
- [
291
- "",
292
- "mark <string>",
293
- "relevant for --graph only. paint the given node-ids in the graph in red color, for multiple, separate by commas"
294
269
  ]
295
270
  ],
296
271
  "description": "cat version-history object by component-id",
@@ -700,6 +675,42 @@
700
675
  }
701
676
  ]
702
677
  },
678
+ {
679
+ "name": "graph [id]",
680
+ "alias": "",
681
+ "options": [
682
+ [
683
+ "i",
684
+ "image <image>",
685
+ "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
686
+ ],
687
+ [
688
+ "r",
689
+ "remote [remoteName]",
690
+ "remote name (name is optional, leave empty when id is specified)"
691
+ ],
692
+ [
693
+ "",
694
+ "all-versions",
695
+ "enter all components versions into the graph, not only latest"
696
+ ],
697
+ [
698
+ "",
699
+ "layout <name>",
700
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
701
+ ],
702
+ [
703
+ "j",
704
+ "json",
705
+ "json format"
706
+ ]
707
+ ],
708
+ "description": "generate an image file with the workspace components' dependencies graph",
709
+ "extendedDescription": "",
710
+ "group": "discover",
711
+ "private": false,
712
+ "remoteOp": true
713
+ },
703
714
  {
704
715
  "name": "start [component-pattern]",
705
716
  "alias": "c",
@@ -765,42 +776,6 @@
765
776
  "group": "development",
766
777
  "private": true
767
778
  },
768
- {
769
- "name": "graph [id]",
770
- "alias": "",
771
- "options": [
772
- [
773
- "i",
774
- "image <image>",
775
- "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
776
- ],
777
- [
778
- "r",
779
- "remote [remoteName]",
780
- "remote name (name is optional, leave empty when id is specified)"
781
- ],
782
- [
783
- "",
784
- "all-versions",
785
- "enter all components versions into the graph, not only latest"
786
- ],
787
- [
788
- "",
789
- "layout <name>",
790
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
791
- ],
792
- [
793
- "j",
794
- "json",
795
- "json format"
796
- ]
797
- ],
798
- "description": "generate an image file with the workspace components' dependencies graph",
799
- "extendedDescription": "",
800
- "group": "discover",
801
- "private": false,
802
- "remoteOp": true
803
- },
804
779
  {
805
780
  "name": "scope <sub-command>",
806
781
  "alias": "",
@@ -921,6 +896,103 @@
921
896
  }
922
897
  ]
923
898
  },
899
+ {
900
+ "name": "version-history <sub-command>",
901
+ "alias": "vh",
902
+ "options": [],
903
+ "description": "manage the version-history of components",
904
+ "extendedDescription": "",
905
+ "group": "info",
906
+ "private": false,
907
+ "commands": [
908
+ {
909
+ "name": "graph <component-id>",
910
+ "alias": "",
911
+ "options": [
912
+ [
913
+ "s",
914
+ "short-hash",
915
+ "show only 9 chars of the hash"
916
+ ],
917
+ [
918
+ "m",
919
+ "mark <string>",
920
+ "paint the given node-ids in the graph in red color, for multiple, separate by commas"
921
+ ],
922
+ [
923
+ "",
924
+ "png",
925
+ "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
926
+ ],
927
+ [
928
+ "l",
929
+ "layout <name>",
930
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
931
+ ]
932
+ ],
933
+ "description": "generate a graph of the version history of a component and save as an SVG file",
934
+ "extendedDescription": "",
935
+ "group": "info",
936
+ "private": false
937
+ },
938
+ {
939
+ "name": "show <component-id>",
940
+ "alias": "vh",
941
+ "options": [
942
+ [
943
+ "s",
944
+ "short-hash",
945
+ "show only 9 chars of the hash"
946
+ ],
947
+ [
948
+ "j",
949
+ "json",
950
+ "json format"
951
+ ]
952
+ ],
953
+ "description": "show the version-history of a component",
954
+ "extendedDescription": "",
955
+ "group": "info",
956
+ "private": false
957
+ },
958
+ {
959
+ "name": "build <component-pattern>",
960
+ "alias": "",
961
+ "options": [
962
+ [
963
+ "",
964
+ "from-snap <snap>",
965
+ "build the version history from a specific snap. the pattern must be a single component-id"
966
+ ],
967
+ [
968
+ "",
969
+ "from-all-lanes",
970
+ "build the version history from the heads of all lanes that include this component"
971
+ ],
972
+ [
973
+ "",
974
+ "delete-existing",
975
+ "delete the existing version history before building it"
976
+ ],
977
+ [
978
+ "",
979
+ "remote <scope>",
980
+ "make the change on the remote scope"
981
+ ]
982
+ ],
983
+ "description": "rebuild the version history of a component. helpful when it got corrupted for some reason",
984
+ "extendedDescription": "",
985
+ "group": "info",
986
+ "private": false,
987
+ "arguments": [
988
+ {
989
+ "name": "component-pattern",
990
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
991
+ }
992
+ ]
993
+ }
994
+ ]
995
+ },
924
996
  {
925
997
  "name": "eject-conf <pattern>",
926
998
  "alias": "",
@@ -4708,7 +4780,7 @@
4708
4780
  ]
4709
4781
  ],
4710
4782
  "description": "update dependencies for components and tag/snap the results",
4711
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the update.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4783
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the update.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n versionToSnap?: string; // specific hash to snap\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4712
4784
  "group": "development",
4713
4785
  "private": true
4714
4786
  },
package/cli-reference.mdx CHANGED
@@ -2114,6 +2114,56 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
2114
2114
 
2115
2115
  ---
2116
2116
 
2117
+ ## version-history
2118
+
2119
+ **Alias**: `vh`
2120
+ **Description**: manage the version-history of components
2121
+
2122
+ `bit version-history <sub-command>`
2123
+
2124
+ ### version-history graph
2125
+
2126
+ **Usage**: `version-history graph <component-id>`
2127
+
2128
+ **Description**: generate a graph of the version history of a component and save as an SVG file
2129
+
2130
+ | **Option** | **Option alias** | **Description** |
2131
+ | ----------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
2132
+ | `--short-hash` | `-s` | show only 9 chars of the hash |
2133
+ | `--mark <string>` | `-m` | paint the given node-ids in the graph in red color, for multiple, separate by commas |
2134
+ | `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
2135
+ | `--layout <name>` | `-l` | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
2136
+
2137
+ ### version-history show
2138
+
2139
+ **Usage**: `version-history show <component-id>`
2140
+
2141
+ **Description**: show the version-history of a component
2142
+
2143
+ | **Option** | **Option alias** | **Description** |
2144
+ | -------------- | :--------------: | ----------------------------- |
2145
+ | `--short-hash` | `-s` | show only 9 chars of the hash |
2146
+ | `--json` | `-j` | json format |
2147
+
2148
+ ### version-history build
2149
+
2150
+ **Usage**: `version-history build <component-pattern>`
2151
+
2152
+ **Description**: rebuild the version history of a component. helpful when it got corrupted for some reason
2153
+
2154
+ | **Arg** | **Description** |
2155
+ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2156
+ | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
2157
+
2158
+ | **Option** | **Option alias** | **Description** |
2159
+ | -------------------- | :--------------: | ----------------------------------------------------------------------------------------- |
2160
+ | `--from-snap <snap>` | | build the version history from a specific snap. the pattern must be a single component-id |
2161
+ | `--from-all-lanes` | | build the version history from the heads of all lanes that include this component |
2162
+ | `--delete-existing` | | delete the existing version history before building it |
2163
+ | `--remote <scope>` | | make the change on the remote scope |
2164
+
2165
+ ---
2166
+
2117
2167
  ## watch
2118
2168
 
2119
2169
  **Description**: automatically recompile modified components (on save)
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.100'
2
+ description: 'Bit command synopses. Bit version: 1.6.102'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -266,31 +266,6 @@
266
266
  "j",
267
267
  "json",
268
268
  "json format"
269
- ],
270
- [
271
- "g",
272
- "graph",
273
- "generate graph image"
274
- ],
275
- [
276
- "p",
277
- "graph-path <image>",
278
- "relevant for --graph only. image path and format. use one of the following extensions: [gif, png, svg]"
279
- ],
280
- [
281
- "",
282
- "layout <name>",
283
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
284
- ],
285
- [
286
- "",
287
- "short-hash",
288
- "relevant for --graph only. show only 9 chars of the hash"
289
- ],
290
- [
291
- "",
292
- "mark <string>",
293
- "relevant for --graph only. paint the given node-ids in the graph in red color, for multiple, separate by commas"
294
269
  ]
295
270
  ],
296
271
  "description": "cat version-history object by component-id",
@@ -700,6 +675,42 @@
700
675
  }
701
676
  ]
702
677
  },
678
+ {
679
+ "name": "graph [id]",
680
+ "alias": "",
681
+ "options": [
682
+ [
683
+ "i",
684
+ "image <image>",
685
+ "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
686
+ ],
687
+ [
688
+ "r",
689
+ "remote [remoteName]",
690
+ "remote name (name is optional, leave empty when id is specified)"
691
+ ],
692
+ [
693
+ "",
694
+ "all-versions",
695
+ "enter all components versions into the graph, not only latest"
696
+ ],
697
+ [
698
+ "",
699
+ "layout <name>",
700
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
701
+ ],
702
+ [
703
+ "j",
704
+ "json",
705
+ "json format"
706
+ ]
707
+ ],
708
+ "description": "generate an image file with the workspace components' dependencies graph",
709
+ "extendedDescription": "",
710
+ "group": "discover",
711
+ "private": false,
712
+ "remoteOp": true
713
+ },
703
714
  {
704
715
  "name": "start [component-pattern]",
705
716
  "alias": "c",
@@ -765,42 +776,6 @@
765
776
  "group": "development",
766
777
  "private": true
767
778
  },
768
- {
769
- "name": "graph [id]",
770
- "alias": "",
771
- "options": [
772
- [
773
- "i",
774
- "image <image>",
775
- "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
776
- ],
777
- [
778
- "r",
779
- "remote [remoteName]",
780
- "remote name (name is optional, leave empty when id is specified)"
781
- ],
782
- [
783
- "",
784
- "all-versions",
785
- "enter all components versions into the graph, not only latest"
786
- ],
787
- [
788
- "",
789
- "layout <name>",
790
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
791
- ],
792
- [
793
- "j",
794
- "json",
795
- "json format"
796
- ]
797
- ],
798
- "description": "generate an image file with the workspace components' dependencies graph",
799
- "extendedDescription": "",
800
- "group": "discover",
801
- "private": false,
802
- "remoteOp": true
803
- },
804
779
  {
805
780
  "name": "scope <sub-command>",
806
781
  "alias": "",
@@ -921,6 +896,103 @@
921
896
  }
922
897
  ]
923
898
  },
899
+ {
900
+ "name": "version-history <sub-command>",
901
+ "alias": "vh",
902
+ "options": [],
903
+ "description": "manage the version-history of components",
904
+ "extendedDescription": "",
905
+ "group": "info",
906
+ "private": false,
907
+ "commands": [
908
+ {
909
+ "name": "graph <component-id>",
910
+ "alias": "",
911
+ "options": [
912
+ [
913
+ "s",
914
+ "short-hash",
915
+ "show only 9 chars of the hash"
916
+ ],
917
+ [
918
+ "m",
919
+ "mark <string>",
920
+ "paint the given node-ids in the graph in red color, for multiple, separate by commas"
921
+ ],
922
+ [
923
+ "",
924
+ "png",
925
+ "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
926
+ ],
927
+ [
928
+ "l",
929
+ "layout <name>",
930
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
931
+ ]
932
+ ],
933
+ "description": "generate a graph of the version history of a component and save as an SVG file",
934
+ "extendedDescription": "",
935
+ "group": "info",
936
+ "private": false
937
+ },
938
+ {
939
+ "name": "show <component-id>",
940
+ "alias": "vh",
941
+ "options": [
942
+ [
943
+ "s",
944
+ "short-hash",
945
+ "show only 9 chars of the hash"
946
+ ],
947
+ [
948
+ "j",
949
+ "json",
950
+ "json format"
951
+ ]
952
+ ],
953
+ "description": "show the version-history of a component",
954
+ "extendedDescription": "",
955
+ "group": "info",
956
+ "private": false
957
+ },
958
+ {
959
+ "name": "build <component-pattern>",
960
+ "alias": "",
961
+ "options": [
962
+ [
963
+ "",
964
+ "from-snap <snap>",
965
+ "build the version history from a specific snap. the pattern must be a single component-id"
966
+ ],
967
+ [
968
+ "",
969
+ "from-all-lanes",
970
+ "build the version history from the heads of all lanes that include this component"
971
+ ],
972
+ [
973
+ "",
974
+ "delete-existing",
975
+ "delete the existing version history before building it"
976
+ ],
977
+ [
978
+ "",
979
+ "remote <scope>",
980
+ "make the change on the remote scope"
981
+ ]
982
+ ],
983
+ "description": "rebuild the version history of a component. helpful when it got corrupted for some reason",
984
+ "extendedDescription": "",
985
+ "group": "info",
986
+ "private": false,
987
+ "arguments": [
988
+ {
989
+ "name": "component-pattern",
990
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
991
+ }
992
+ ]
993
+ }
994
+ ]
995
+ },
924
996
  {
925
997
  "name": "eject-conf <pattern>",
926
998
  "alias": "",
@@ -4708,7 +4780,7 @@
4708
4780
  ]
4709
4781
  ],
4710
4782
  "description": "update dependencies for components and tag/snap the results",
4711
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the update.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4783
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the update.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n versionToSnap?: string; // specific hash to snap\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4712
4784
  "group": "development",
4713
4785
  "private": true
4714
4786
  },