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

package/cli-reference.docs.mdx

@@ -1,5 +1,5 @@
 ---
-description: 'Bit command synopses. Bit version: 1.6.101'
+description: 'Bit command synopses. Bit version: 1.6.102'
 labels: ['cli', 'mdx', 'docs']
 ---
       

package/cli-reference.json

@@ -909,16 +909,6 @@
         "name": "graph <component-id>",
         "alias": "",
         "options": [
-          [
-            "p",
-            "graph-path <image>",
-            "image path and format. use one of the following extensions: [gif, png, svg]. default to png in the os tmp dir"
-          ],
-          [
-            "l",
-            "layout <name>",
-            "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
-          ],
           [
             "s",
             "short-hash",
@@ -928,9 +918,19 @@
             "m",
             "mark <string>",
             "paint the given node-ids in the graph in red color, for multiple, separate by commas"
+          ],
+          [
+            "",
+            "png",
+            "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
+          ],
+          [
+            "l",
+            "layout <name>",
+            "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
           ]
         ],
-        "description": "generate a graph of the version history of a component. GraphVis must be installed",
+        "description": "generate a graph of the version history of a component and save as an SVG file",
         "extendedDescription": "",
         "group": "info",
         "private": false
@@ -4780,7 +4780,7 @@
       ]
     ],
     "description": "update dependencies for components and tag/snap the results",
-    "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",
+    "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",
     "group": "development",
     "private": true
   },

package/cli-reference.mdx

@@ -2125,14 +2125,14 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 
 **Usage**: `version-history graph <component-id>`
 
-**Description**: generate a graph of the version history of a component. GraphVis must be installed
-
-| **Option**             | **Option alias** | **Description**                                                                                               |
-| ---------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------- |
-| `--graph-path <image>` |       `-p`       | image path and format. use one of the following extensions: [gif, png, svg]. default to png in the os tmp dir |
-| `--layout <name>`      |       `-l`       | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]        |
-| `--short-hash`         |       `-s`       | show only 9 chars of the hash                                                                                 |
-| `--mark <string>`      |       `-m`       | paint the given node-ids in the graph in red color, for multiple, separate by commas                          |
+**Description**: generate a graph of the version history of a component and save as an SVG file
+
+| **Option**        | **Option alias** | **Description**                                                                                        |
+| ----------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
+| `--short-hash`    |       `-s`       | show only 9 chars of the hash                                                                          |
+| `--mark <string>` |       `-m`       | paint the given node-ids in the graph in red color, for multiple, separate by commas                   |
+| `--png`           |                  | save the graph as a png file instead of svg. requires "graphviz" to be installed                       |
+| `--layout <name>` |       `-l`       | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
 
 ### version-history show
 

package/dist/cli-reference.docs.mdx

@@ -1,5 +1,5 @@
 ---
-description: 'Bit command synopses. Bit version: 1.6.101'
+description: 'Bit command synopses. Bit version: 1.6.102'
 labels: ['cli', 'mdx', 'docs']
 ---
       

package/dist/cli-reference.json

@@ -909,16 +909,6 @@
                 "name": "graph <component-id>",
                 "alias": "",
                 "options": [
-                    [
-                        "p",
-                        "graph-path <image>",
-                        "image path and format. use one of the following extensions: [gif, png, svg]. default to png in the os tmp dir"
-                    ],
-                    [
-                        "l",
-                        "layout <name>",
-                        "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
-                    ],
                     [
                         "s",
                         "short-hash",
@@ -928,9 +918,19 @@
                         "m",
                         "mark <string>",
                         "paint the given node-ids in the graph in red color, for multiple, separate by commas"
+                    ],
+                    [
+                        "",
+                        "png",
+                        "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
+                    ],
+                    [
+                        "l",
+                        "layout <name>",
+                        "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
                     ]
                 ],
-                "description": "generate a graph of the version history of a component. GraphVis must be installed",
+                "description": "generate a graph of the version history of a component and save as an SVG file",
                 "extendedDescription": "",
                 "group": "info",
                 "private": false
@@ -4780,7 +4780,7 @@
             ]
         ],
         "description": "update dependencies for components and tag/snap the results",
-        "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",
+        "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",
         "group": "development",
         "private": true
     },

package/dist/cli-reference.mdx.js

@@ -11017,7 +11017,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "version-history graph <component-id>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": generate a graph of the version history of a component. GraphVis must be installed"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "Description"), ": generate a graph of the version history of a component and save as an SVG file"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -11045,60 +11045,58 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--graph-path <image>")), (0, _react2.mdx)("td", {
+  }, "--short-hash")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "-p")), (0, _react2.mdx)("td", {
+  }, "-s")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "image path and format. use one of the following extensions: ", "[gif, png, svg]", ". default to png in the os tmp dir")), (0, _react2.mdx)("tr", {
+  }, "show only 9 chars of the hash")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--layout <name>")), (0, _react2.mdx)("td", {
+  }, "--mark <string>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "-l")), (0, _react2.mdx)("td", {
+  }, "-m")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")), (0, _react2.mdx)("tr", {
+  }, "paint the given node-ids in the graph in red color, for multiple, separate by commas")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--short-hash")), (0, _react2.mdx)("td", {
+  }, "--png")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-s")), (0, _react2.mdx)("td", {
+  }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "show only 9 chars of the hash")), (0, _react2.mdx)("tr", {
+  }, "save the graph as a png file instead of svg. requires \"graphviz\" to be installed")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--mark <string>")), (0, _react2.mdx)("td", {
+  }, "--layout <name>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "-m")), (0, _react2.mdx)("td", {
+  }, "-l")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "paint the given node-ids in the graph in red color, for multiple, separate by commas")))), (0, _react2.mdx)("h3", null, "version-history show"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")))), (0, _react2.mdx)("h3", null, "version-history show"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"