@teambit/harmony.content.cli-reference 2.0.553 → 2.0.555

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,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.66'
2
+ description: 'Bit command synopses. Bit version: 1.9.68'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -535,11 +535,6 @@
535
535
  "name": "graph [id]",
536
536
  "alias": "",
537
537
  "options": [
538
- [
539
- "i",
540
- "image <image>",
541
- "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
542
- ],
543
538
  [
544
539
  "r",
545
540
  "remote [remoteName]",
@@ -547,13 +542,23 @@
547
542
  ],
548
543
  [
549
544
  "",
550
- "all-versions",
551
- "enter all components versions into the graph, not only latest"
545
+ "layout <name>",
546
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
552
547
  ],
553
548
  [
554
549
  "",
555
- "layout <name>",
556
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
550
+ "png",
551
+ "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
552
+ ],
553
+ [
554
+ "",
555
+ "cycles",
556
+ "generate a graph of cycles only"
557
+ ],
558
+ [
559
+ "",
560
+ "include-local-only",
561
+ "include only the components in the workspace (or local scope)"
557
562
  ],
558
563
  [
559
564
  "j",
@@ -561,7 +566,7 @@
561
566
  "json format"
562
567
  ]
563
568
  ],
564
- "description": "generate an image file with the workspace components' dependencies graph",
569
+ "description": "generate an SVG image file with the components' dependencies graph",
565
570
  "extendedDescription": "",
566
571
  "group": "discover",
567
572
  "private": false,
package/cli-reference.mdx CHANGED
@@ -926,16 +926,17 @@ bit export => export all staged snaps/tags of components to their remote scope.
926
926
 
927
927
  ## graph
928
928
 
929
- **Description**: generate an image file with the workspace components' dependencies graph
929
+ **Description**: generate an SVG image file with the components' dependencies graph
930
930
 
931
931
  `bit graph [id]`
932
932
 
933
933
  | **Option** | **Option alias** | **Description** |
934
934
  | ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
935
- | `--image <image>` | `-i` | image path and format. use one of the following extensions: [gif, png, svg, pdf] |
936
935
  | `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
937
- | `--all-versions` | | enter all components versions into the graph, not only latest |
938
936
  | `--layout <name>` | | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
937
+ | `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
938
+ | `--cycles` | | generate a graph of cycles only |
939
+ | `--include-local-only` | | include only the components in the workspace (or local scope) |
939
940
  | `--json` | `-j` | json format |
940
941
 
941
942
  ---
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.66'
2
+ description: 'Bit command synopses. Bit version: 1.9.68'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -535,11 +535,6 @@
535
535
  "name": "graph [id]",
536
536
  "alias": "",
537
537
  "options": [
538
- [
539
- "i",
540
- "image <image>",
541
- "image path and format. use one of the following extensions: [gif, png, svg, pdf]"
542
- ],
543
538
  [
544
539
  "r",
545
540
  "remote [remoteName]",
@@ -547,13 +542,23 @@
547
542
  ],
548
543
  [
549
544
  "",
550
- "all-versions",
551
- "enter all components versions into the graph, not only latest"
545
+ "layout <name>",
546
+ "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
552
547
  ],
553
548
  [
554
549
  "",
555
- "layout <name>",
556
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
550
+ "png",
551
+ "save the graph as a png file instead of svg. requires \"graphviz\" to be installed"
552
+ ],
553
+ [
554
+ "",
555
+ "cycles",
556
+ "generate a graph of cycles only"
557
+ ],
558
+ [
559
+ "",
560
+ "include-local-only",
561
+ "include only the components in the workspace (or local scope)"
557
562
  ],
558
563
  [
559
564
  "j",
@@ -561,7 +566,7 @@
561
566
  "json format"
562
567
  ]
563
568
  ],
564
- "description": "generate an image file with the workspace components' dependencies graph",
569
+ "description": "generate an SVG image file with the components' dependencies graph",
565
570
  "extendedDescription": "",
566
571
  "group": "discover",
567
572
  "private": false,
@@ -4524,7 +4524,7 @@ function MDXContent(_ref) {
4524
4524
  "align": null
4525
4525
  }, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "graph"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4526
4526
  parentName: "p"
4527
- }, "Description"), ": generate an image file with the workspace components' dependencies graph"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4527
+ }, "Description"), ": generate an SVG image file with the components' dependencies graph"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4528
4528
  parentName: "p"
4529
4529
  }, "bit graph [id]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4530
4530
  parentName: "table"
@@ -4554,56 +4554,67 @@ function MDXContent(_ref) {
4554
4554
  "align": null
4555
4555
  }, (0, _react2.mdx)("inlineCode", {
4556
4556
  parentName: "td"
4557
- }, "--image <image>")), (0, _react2.mdx)("td", {
4557
+ }, "--remote [remoteName]")), (0, _react2.mdx)("td", {
4558
4558
  parentName: "tr",
4559
4559
  "align": "center"
4560
4560
  }, (0, _react2.mdx)("inlineCode", {
4561
4561
  parentName: "td"
4562
- }, "-i")), (0, _react2.mdx)("td", {
4562
+ }, "-r")), (0, _react2.mdx)("td", {
4563
4563
  parentName: "tr",
4564
4564
  "align": null
4565
- }, "image path and format. use one of the following extensions: ", "[gif, png, svg, pdf]")), (0, _react2.mdx)("tr", {
4565
+ }, "remote name (name is optional, leave empty when id is specified)")), (0, _react2.mdx)("tr", {
4566
4566
  parentName: "tbody"
4567
4567
  }, (0, _react2.mdx)("td", {
4568
4568
  parentName: "tr",
4569
4569
  "align": null
4570
4570
  }, (0, _react2.mdx)("inlineCode", {
4571
4571
  parentName: "td"
4572
- }, "--remote [remoteName]")), (0, _react2.mdx)("td", {
4572
+ }, "--layout <name>")), (0, _react2.mdx)("td", {
4573
4573
  parentName: "tr",
4574
4574
  "align": "center"
4575
+ }), (0, _react2.mdx)("td", {
4576
+ parentName: "tr",
4577
+ "align": null
4578
+ }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")), (0, _react2.mdx)("tr", {
4579
+ parentName: "tbody"
4580
+ }, (0, _react2.mdx)("td", {
4581
+ parentName: "tr",
4582
+ "align": null
4575
4583
  }, (0, _react2.mdx)("inlineCode", {
4576
4584
  parentName: "td"
4577
- }, "-r")), (0, _react2.mdx)("td", {
4585
+ }, "--png")), (0, _react2.mdx)("td", {
4586
+ parentName: "tr",
4587
+ "align": "center"
4588
+ }), (0, _react2.mdx)("td", {
4578
4589
  parentName: "tr",
4579
4590
  "align": null
4580
- }, "remote name (name is optional, leave empty when id is specified)")), (0, _react2.mdx)("tr", {
4591
+ }, "save the graph as a png file instead of svg. requires \"graphviz\" to be installed")), (0, _react2.mdx)("tr", {
4581
4592
  parentName: "tbody"
4582
4593
  }, (0, _react2.mdx)("td", {
4583
4594
  parentName: "tr",
4584
4595
  "align": null
4585
4596
  }, (0, _react2.mdx)("inlineCode", {
4586
4597
  parentName: "td"
4587
- }, "--all-versions")), (0, _react2.mdx)("td", {
4598
+ }, "--cycles")), (0, _react2.mdx)("td", {
4588
4599
  parentName: "tr",
4589
4600
  "align": "center"
4590
4601
  }), (0, _react2.mdx)("td", {
4591
4602
  parentName: "tr",
4592
4603
  "align": null
4593
- }, "enter all components versions into the graph, not only latest")), (0, _react2.mdx)("tr", {
4604
+ }, "generate a graph of cycles only")), (0, _react2.mdx)("tr", {
4594
4605
  parentName: "tbody"
4595
4606
  }, (0, _react2.mdx)("td", {
4596
4607
  parentName: "tr",
4597
4608
  "align": null
4598
4609
  }, (0, _react2.mdx)("inlineCode", {
4599
4610
  parentName: "td"
4600
- }, "--layout <name>")), (0, _react2.mdx)("td", {
4611
+ }, "--include-local-only")), (0, _react2.mdx)("td", {
4601
4612
  parentName: "tr",
4602
4613
  "align": "center"
4603
4614
  }), (0, _react2.mdx)("td", {
4604
4615
  parentName: "tr",
4605
4616
  "align": null
4606
- }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")), (0, _react2.mdx)("tr", {
4617
+ }, "include only the components in the workspace (or local scope)")), (0, _react2.mdx)("tr", {
4607
4618
  parentName: "tbody"
4608
4619
  }, (0, _react2.mdx)("td", {
4609
4620
  parentName: "tr",