@teambit/harmony.content.cli-reference 2.0.574 → 2.0.576

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.87'
2
+ description: 'Bit command synopses. Bit version: 1.9.89'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -951,6 +951,11 @@
951
951
  "l",
952
952
  "layout <name>",
953
953
  "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
954
+ ],
955
+ [
956
+ "",
957
+ "limit <number>",
958
+ "limit the number of nodes in the graph (starting from the heads)"
954
959
  ]
955
960
  ],
956
961
  "description": "generate a graph of the version history of a component and save as an SVG file",
@@ -2466,7 +2471,7 @@
2466
2471
  ]
2467
2472
  ],
2468
2473
  "description": "mark components as deleted on the remote",
2469
- "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" command.\nthis command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.\n",
2474
+ "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" command.\nthis command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.\nunless the '--hard' flag is used (not recommended!), in which case, the component will be deleted from the remote scope immediately.\n",
2470
2475
  "group": "collaborate",
2471
2476
  "private": false,
2472
2477
  "remoteOp": true,
package/cli-reference.mdx CHANGED
@@ -484,7 +484,8 @@ for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
484
484
 
485
485
  **Description**: mark components as deleted on the remote
486
486
  to remove components from your local workspace only, use "bit remove" command.
487
- this command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.
487
+ this command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.
488
+ unless the '--hard' flag is used (not recommended!), in which case, the component will be deleted from the remote scope immediately.
488
489
 
489
490
  `bit delete <component-pattern>`
490
491
 
@@ -2330,12 +2331,13 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
2330
2331
 
2331
2332
  **Description**: generate a graph of the version history of a component and save as an SVG file
2332
2333
 
2333
- | **Option** | **Option alias** | **Description** |
2334
- | ----------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
2335
- | `--short-hash` | `-s` | show only 9 chars of the hash |
2336
- | `--mark <string>` | `-m` | paint the given node-ids in the graph in red color, for multiple, separate by commas |
2337
- | `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
2338
- | `--layout <name>` | `-l` | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
2334
+ | **Option** | **Option alias** | **Description** |
2335
+ | ------------------ | :--------------: | ------------------------------------------------------------------------------------------------------ |
2336
+ | `--short-hash` | `-s` | show only 9 chars of the hash |
2337
+ | `--mark <string>` | `-m` | paint the given node-ids in the graph in red color, for multiple, separate by commas |
2338
+ | `--png` | | save the graph as a png file instead of svg. requires "graphviz" to be installed |
2339
+ | `--layout <name>` | `-l` | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
2340
+ | `--limit <number>` | | limit the number of nodes in the graph (starting from the heads) |
2339
2341
 
2340
2342
  ### version-history show
2341
2343
 
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.87'
2
+ description: 'Bit command synopses. Bit version: 1.9.89'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -951,6 +951,11 @@
951
951
  "l",
952
952
  "layout <name>",
953
953
  "GraphVis layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
954
+ ],
955
+ [
956
+ "",
957
+ "limit <number>",
958
+ "limit the number of nodes in the graph (starting from the heads)"
954
959
  ]
955
960
  ],
956
961
  "description": "generate a graph of the version history of a component and save as an SVG file",
@@ -2466,7 +2471,7 @@
2466
2471
  ]
2467
2472
  ],
2468
2473
  "description": "mark components as deleted on the remote",
2469
- "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" command.\nthis command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.\n",
2474
+ "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" command.\nthis command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.\nunless the '--hard' flag is used (not recommended!), in which case, the component will be deleted from the remote scope immediately.\n",
2470
2475
  "group": "collaborate",
2471
2476
  "private": false,
2472
2477
  "remoteOp": true,
@@ -2439,7 +2439,9 @@ function MDXContent(_ref) {
2439
2439
  parentName: "p"
2440
2440
  }), "\n", "to remove components from your local workspace only, use \"bit remove\" command.", (0, _react2.mdx)("br", {
2441
2441
  parentName: "p"
2442
- }), "\n", "this command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2442
+ }), "\n", "this command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.", (0, _react2.mdx)("br", {
2443
+ parentName: "p"
2444
+ }), "\n", "unless the '--hard' flag is used (not recommended!), in which case, the component will be deleted from the remote scope immediately."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2443
2445
  parentName: "p"
2444
2446
  }, "bit delete <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2445
2447
  parentName: "table"
@@ -12318,7 +12320,20 @@ function MDXContent(_ref) {
12318
12320
  }, "-l")), (0, _react2.mdx)("td", {
12319
12321
  parentName: "tr",
12320
12322
  "align": null
12321
- }, "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", {
12323
+ }, "GraphVis layout. default to \"dot\". options are ", "[circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]")), (0, _react2.mdx)("tr", {
12324
+ parentName: "tbody"
12325
+ }, (0, _react2.mdx)("td", {
12326
+ parentName: "tr",
12327
+ "align": null
12328
+ }, (0, _react2.mdx)("inlineCode", {
12329
+ parentName: "td"
12330
+ }, "--limit <number>")), (0, _react2.mdx)("td", {
12331
+ parentName: "tr",
12332
+ "align": "center"
12333
+ }), (0, _react2.mdx)("td", {
12334
+ parentName: "tr",
12335
+ "align": null
12336
+ }, "limit the number of nodes in the graph (starting from the heads)")))), (0, _react2.mdx)("h3", null, "version-history show"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
12322
12337
  parentName: "p"
12323
12338
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
12324
12339
  parentName: "p"