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

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.101'
2
+ description: 'Bit command synopses. Bit version: 1.6.103'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -909,16 +909,6 @@
909
909
  "name": "graph <component-id>",
910
910
  "alias": "",
911
911
  "options": [
912
- [
913
- "p",
914
- "graph-path <image>",
915
- "image path and format. use one of the following extensions: [gif, png, svg]. default to png in the os tmp dir"
916
- ],
917
- [
918
- "l",
919
- "layout <name>",
920
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
921
- ],
922
912
  [
923
913
  "s",
924
914
  "short-hash",
@@ -928,9 +918,19 @@
928
918
  "m",
929
919
  "mark <string>",
930
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
931
  ]
932
932
  ],
933
- "description": "generate a graph of the version history of a component. GraphVis must be installed",
933
+ "description": "generate a graph of the version history of a component and save as an SVG file",
934
934
  "extendedDescription": "",
935
935
  "group": "info",
936
936
  "private": false
@@ -4322,6 +4322,11 @@
4322
4322
  "name": "login",
4323
4323
  "alias": "",
4324
4324
  "options": [
4325
+ [
4326
+ "",
4327
+ "skip-config-update",
4328
+ "skip writing to the .npmrc file"
4329
+ ],
4325
4330
  [
4326
4331
  "d",
4327
4332
  "cloud-domain <domain>",
@@ -4780,7 +4785,7 @@
4780
4785
  ]
4781
4786
  ],
4782
4787
  "description": "update dependencies for components and tag/snap the results",
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}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4788
+ "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",
4784
4789
  "group": "development",
4785
4790
  "private": true
4786
4791
  },
package/cli-reference.mdx CHANGED
@@ -1355,6 +1355,7 @@ also, checkout the workspace components according to the restored lane state
1355
1355
 
1356
1356
  | **Option** | **Option alias** | **Description** |
1357
1357
  | --------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
1358
+ | `--skip-config-update` | | skip writing to the .npmrc file |
1358
1359
  | `--cloud-domain <domain>` | `-d` | login cloud domain (default bit.cloud) |
1359
1360
  | `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
1360
1361
  | `--no-browser` | | do not open a browser for authentication |
@@ -2125,14 +2126,14 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
2125
2126
 
2126
2127
  **Usage**: `version-history graph <component-id>`
2127
2128
 
2128
- **Description**: generate a graph of the version history of a component. GraphVis must be installed
2129
+ **Description**: generate a graph of the version history of a component and save as an SVG file
2129
2130
 
2130
- | **Option** | **Option alias** | **Description** |
2131
- | ---------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------- |
2132
- | `--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 |
2133
- | `--layout <name>` | `-l` | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
2134
- | `--short-hash` | `-s` | show only 9 chars of the hash |
2135
- | `--mark <string>` | `-m` | paint the given node-ids in the graph in red color, for multiple, separate by commas |
2131
+ | **Option** | **Option alias** | **Description** |
2132
+ | ----------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
2133
+ | `--short-hash` | `-s` | show only 9 chars of the hash |
2134
+ | `--mark <string>` | `-m` | paint the given node-ids in the graph in red color, for multiple, separate by commas |
2135
+ | `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
2136
+ | `--layout <name>` | `-l` | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
2136
2137
 
2137
2138
  ### version-history show
2138
2139
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.101'
2
+ description: 'Bit command synopses. Bit version: 1.6.103'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -909,16 +909,6 @@
909
909
  "name": "graph <component-id>",
910
910
  "alias": "",
911
911
  "options": [
912
- [
913
- "p",
914
- "graph-path <image>",
915
- "image path and format. use one of the following extensions: [gif, png, svg]. default to png in the os tmp dir"
916
- ],
917
- [
918
- "l",
919
- "layout <name>",
920
- "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
921
- ],
922
912
  [
923
913
  "s",
924
914
  "short-hash",
@@ -928,9 +918,19 @@
928
918
  "m",
929
919
  "mark <string>",
930
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
931
  ]
932
932
  ],
933
- "description": "generate a graph of the version history of a component. GraphVis must be installed",
933
+ "description": "generate a graph of the version history of a component and save as an SVG file",
934
934
  "extendedDescription": "",
935
935
  "group": "info",
936
936
  "private": false
@@ -4322,6 +4322,11 @@
4322
4322
  "name": "login",
4323
4323
  "alias": "",
4324
4324
  "options": [
4325
+ [
4326
+ "",
4327
+ "skip-config-update",
4328
+ "skip writing to the .npmrc file"
4329
+ ],
4325
4330
  [
4326
4331
  "d",
4327
4332
  "cloud-domain <domain>",
@@ -4780,7 +4785,7 @@
4780
4785
  ]
4781
4786
  ],
4782
4787
  "description": "update dependencies for components and tag/snap the results",
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}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
4788
+ "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",
4784
4789
  "group": "development",
4785
4790
  "private": true
4786
4791
  },
@@ -7182,6 +7182,19 @@ function MDXContent(_ref) {
7182
7182
  "align": null
7183
7183
  }, (0, _react2.mdx)("inlineCode", {
7184
7184
  parentName: "td"
7185
+ }, "--skip-config-update")), (0, _react2.mdx)("td", {
7186
+ parentName: "tr",
7187
+ "align": "center"
7188
+ }), (0, _react2.mdx)("td", {
7189
+ parentName: "tr",
7190
+ "align": null
7191
+ }, "skip writing to the .npmrc file")), (0, _react2.mdx)("tr", {
7192
+ parentName: "tbody"
7193
+ }, (0, _react2.mdx)("td", {
7194
+ parentName: "tr",
7195
+ "align": null
7196
+ }, (0, _react2.mdx)("inlineCode", {
7197
+ parentName: "td"
7185
7198
  }, "--cloud-domain <domain>")), (0, _react2.mdx)("td", {
7186
7199
  parentName: "tr",
7187
7200
  "align": "center"
@@ -11017,7 +11030,7 @@ function MDXContent(_ref) {
11017
11030
  parentName: "p"
11018
11031
  }, "version-history graph <component-id>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
11019
11032
  parentName: "p"
11020
- }, "Description"), ": generate a graph of the version history of a component. GraphVis must be installed"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
11033
+ }, "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", {
11021
11034
  parentName: "table"
11022
11035
  }, (0, _react2.mdx)("tr", {
11023
11036
  parentName: "thead"
@@ -11045,60 +11058,58 @@ function MDXContent(_ref) {
11045
11058
  "align": null
11046
11059
  }, (0, _react2.mdx)("inlineCode", {
11047
11060
  parentName: "td"
11048
- }, "--graph-path <image>")), (0, _react2.mdx)("td", {
11061
+ }, "--short-hash")), (0, _react2.mdx)("td", {
11049
11062
  parentName: "tr",
11050
11063
  "align": "center"
11051
11064
  }, (0, _react2.mdx)("inlineCode", {
11052
11065
  parentName: "td"
11053
- }, "-p")), (0, _react2.mdx)("td", {
11066
+ }, "-s")), (0, _react2.mdx)("td", {
11054
11067
  parentName: "tr",
11055
11068
  "align": null
11056
- }, "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", {
11069
+ }, "show only 9 chars of the hash")), (0, _react2.mdx)("tr", {
11057
11070
  parentName: "tbody"
11058
11071
  }, (0, _react2.mdx)("td", {
11059
11072
  parentName: "tr",
11060
11073
  "align": null
11061
11074
  }, (0, _react2.mdx)("inlineCode", {
11062
11075
  parentName: "td"
11063
- }, "--layout <name>")), (0, _react2.mdx)("td", {
11076
+ }, "--mark <string>")), (0, _react2.mdx)("td", {
11064
11077
  parentName: "tr",
11065
11078
  "align": "center"
11066
11079
  }, (0, _react2.mdx)("inlineCode", {
11067
11080
  parentName: "td"
11068
- }, "-l")), (0, _react2.mdx)("td", {
11081
+ }, "-m")), (0, _react2.mdx)("td", {
11069
11082
  parentName: "tr",
11070
11083
  "align": null
11071
- }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")), (0, _react2.mdx)("tr", {
11084
+ }, "paint the given node-ids in the graph in red color, for multiple, separate by commas")), (0, _react2.mdx)("tr", {
11072
11085
  parentName: "tbody"
11073
11086
  }, (0, _react2.mdx)("td", {
11074
11087
  parentName: "tr",
11075
11088
  "align": null
11076
11089
  }, (0, _react2.mdx)("inlineCode", {
11077
11090
  parentName: "td"
11078
- }, "--short-hash")), (0, _react2.mdx)("td", {
11091
+ }, "--png")), (0, _react2.mdx)("td", {
11079
11092
  parentName: "tr",
11080
11093
  "align": "center"
11081
- }, (0, _react2.mdx)("inlineCode", {
11082
- parentName: "td"
11083
- }, "-s")), (0, _react2.mdx)("td", {
11094
+ }), (0, _react2.mdx)("td", {
11084
11095
  parentName: "tr",
11085
11096
  "align": null
11086
- }, "show only 9 chars of the hash")), (0, _react2.mdx)("tr", {
11097
+ }, "save the graph as a png file instead of svg. requires \"graphviz\" to be installed")), (0, _react2.mdx)("tr", {
11087
11098
  parentName: "tbody"
11088
11099
  }, (0, _react2.mdx)("td", {
11089
11100
  parentName: "tr",
11090
11101
  "align": null
11091
11102
  }, (0, _react2.mdx)("inlineCode", {
11092
11103
  parentName: "td"
11093
- }, "--mark <string>")), (0, _react2.mdx)("td", {
11104
+ }, "--layout <name>")), (0, _react2.mdx)("td", {
11094
11105
  parentName: "tr",
11095
11106
  "align": "center"
11096
11107
  }, (0, _react2.mdx)("inlineCode", {
11097
11108
  parentName: "td"
11098
- }, "-m")), (0, _react2.mdx)("td", {
11109
+ }, "-l")), (0, _react2.mdx)("td", {
11099
11110
  parentName: "tr",
11100
11111
  "align": null
11101
- }, "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", {
11112
+ }, "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", {
11102
11113
  parentName: "p"
11103
11114
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
11104
11115
  parentName: "p"