@teambit/harmony.content.cli-reference 2.0.1261 → 2.0.1263

package/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 2.2.51'
+description: 'Bit command synopses. Bit version: 2.2.53'
 labels: ['cli', 'mdx', 'docs']
 ---

package/cli-reference.json

@@ -1494,6 +1494,43 @@
             "description": "the Ripple CI job ID to stop (optional — auto-detects from current lane)"
           }
         ]
+      },
+      {
+        "name": "simulate",
+        "alias": "",
+        "options": [
+          [
+            "",
+            "lane <lane>",
+            "lane ID to simulate, e.g. \"scope/lane-name\" (default: detected from .bitmap)"
+          ],
+          [
+            "",
+            "scopes <scopes>",
+            "comma-separated scopes to search for dependents in (default: the lane scope)"
+          ],
+          [
+            "",
+            "owners <owners>",
+            "comma-separated owners (organizations) to search for dependents in"
+          ],
+          [
+            "",
+            "exclude-scopes <scopes>",
+            "comma-separated scopes to exclude from the dependents search"
+          ],
+          [
+            "j",
+            "json",
+            "return the output as JSON"
+          ]
+        ],
+        "description": "start a Ripple CI simulation for a lane to reveal which dependents break (auto-detects current lane)",
+        "extendedDescription": "a simulation builds the dependents of the lane components against the lane heads on bit.cloud,\nwithout merging or publishing anything. it's the way to get dependent coverage for a change before the lane is merged.\nthe simulation runs against the lane as it exists on bit.cloud, so export the lane first.\nsimulations are heavy jobs and are billed as such. run them at review time, not on every change.\ndependents are searched in the lane's own scope by default. widen or narrow the search with --scopes, --owners and\n--exclude-scopes.\nfollow the job with \"bit ripple log\". once it finishes, \"bit ripple errors\" shows what broke. both take the job id\nprinted when the simulation starts.",
+        "group": "ungrouped",
+        "private": false,
+        "remoteOp": true,
+        "skipWorkspace": true
       }
     ]
   },
@@ -4611,6 +4648,28 @@
           }
         ]
       },
+      {
+        "name": "updates [lane-name]",
+        "alias": "",
+        "options": [
+          [
+            "",
+            "undo",
+            "remove the cascaded dependents from the lane, on the remote and locally"
+          ],
+          [
+            "j",
+            "json",
+            "return the results in json format"
+          ]
+        ],
+        "description": "show the dependents Ripple CI cascaded onto a lane, default to the current lane",
+        "extendedDescription": "after a lane is exported, Ripple CI may snap the dependents of the lane components against the new\nheads and add them to the lane as hidden \"update\" entries. they are part of the lane graph (Ripple CI builds them, merge\nrefreshes them) but stay hidden from the workspace (\"bit status\", .bitmap).\nthe entries are read from the remote lane. the local lane object is used only when the remote is unavailable.\nuse --undo to remove them from the lane, on the remote and locally, e.g. when the cascade is not wanted.",
+        "group": "collaborate",
+        "private": false,
+        "remoteOp": true,
+        "skipWorkspace": true
+      },
       {
         "name": "merge <lane> [pattern]",
         "alias": "",

package/cli-reference.mdx

@@ -1598,6 +1598,22 @@ if you want to fork the lane from a certain point in history, use "lane checkout
 | `--restore-deleted-components`   |                  | restore components that were deleted after this history point |
 | `--json`                         |       `-j`       | return the revert result in json format                       |
 
+### lane updates
+
+**Usage**: `lane updates [lane-name]`
+
+**Description**: show the dependents Ripple CI cascaded onto a lane, default to the current lane  
+after a lane is exported, Ripple CI may snap the dependents of the lane components against the new  
+heads and add them to the lane as hidden "update" entries. they are part of the lane graph (Ripple CI builds them, merge  
+refreshes them) but stay hidden from the workspace ("bit status", .bitmap).  
+the entries are read from the remote lane. the local lane object is used only when the remote is unavailable.  
+use --undo to remove them from the lane, on the remote and locally, e.g. when the cascade is not wanted.
+
+| **Option** | **Option alias** | **Description**                                                         |
+| ---------- | :--------------: | ----------------------------------------------------------------------- |
+| `--undo`   |                  | remove the cascaded dependents from the lane, on the remote and locally |
+| `--json`   |       `-j`       | return the results in json format                                       |
+
 ### lane merge
 
 **Usage**: `lane merge <lane> [pattern]`
@@ -2333,6 +2349,28 @@ view, retry, and manage Ripple CI jobs that build your components in the cloud a
 | `--lane <lane>` |                  | lane ID to find the latest job for (default: detected from .bitmap) |
 | `--json`        |       `-j`       | return the output as JSON                                           |
 
+### ripple simulate
+
+**Usage**: `ripple simulate`
+
+**Description**: start a Ripple CI simulation for a lane to reveal which dependents break (auto-detects current lane)  
+a simulation builds the dependents of the lane components against the lane heads on bit.cloud,  
+without merging or publishing anything. it's the way to get dependent coverage for a change before the lane is merged.  
+the simulation runs against the lane as it exists on bit.cloud, so export the lane first.  
+simulations are heavy jobs and are billed as such. run them at review time, not on every change.  
+dependents are searched in the lane's own scope by default. widen or narrow the search with --scopes, --owners and  
+--exclude-scopes.  
+follow the job with "bit ripple log". once it finishes, "bit ripple errors" shows what broke. both take the job id  
+printed when the simulation starts.
+
+| **Option**                  | **Option alias** | **Description**                                                              |
+| --------------------------- | :--------------: | ---------------------------------------------------------------------------- |
+| `--lane <lane>`             |                  | lane ID to simulate, e.g. "scope/lane-name" (default: detected from .bitmap) |
+| `--scopes <scopes>`         |                  | comma-separated scopes to search for dependents in (default: the lane scope) |
+| `--owners <owners>`         |                  | comma-separated owners (organizations) to search for dependents in           |
+| `--exclude-scopes <scopes>` |                  | comma-separated scopes to exclude from the dependents search                 |
+| `--json`                    |       `-j`       | return the output as JSON                                                    |
+
 ---
 
 ## run

package/dist/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 2.2.51'
+description: 'Bit command synopses. Bit version: 2.2.53'
 labels: ['cli', 'mdx', 'docs']
 ---

package/dist/cli-reference.json

@@ -1494,6 +1494,43 @@
                         "description": "the Ripple CI job ID to stop (optional — auto-detects from current lane)"
                     }
                 ]
+            },
+            {
+                "name": "simulate",
+                "alias": "",
+                "options": [
+                    [
+                        "",
+                        "lane <lane>",
+                        "lane ID to simulate, e.g. \"scope/lane-name\" (default: detected from .bitmap)"
+                    ],
+                    [
+                        "",
+                        "scopes <scopes>",
+                        "comma-separated scopes to search for dependents in (default: the lane scope)"
+                    ],
+                    [
+                        "",
+                        "owners <owners>",
+                        "comma-separated owners (organizations) to search for dependents in"
+                    ],
+                    [
+                        "",
+                        "exclude-scopes <scopes>",
+                        "comma-separated scopes to exclude from the dependents search"
+                    ],
+                    [
+                        "j",
+                        "json",
+                        "return the output as JSON"
+                    ]
+                ],
+                "description": "start a Ripple CI simulation for a lane to reveal which dependents break (auto-detects current lane)",
+                "extendedDescription": "a simulation builds the dependents of the lane components against the lane heads on bit.cloud,\nwithout merging or publishing anything. it's the way to get dependent coverage for a change before the lane is merged.\nthe simulation runs against the lane as it exists on bit.cloud, so export the lane first.\nsimulations are heavy jobs and are billed as such. run them at review time, not on every change.\ndependents are searched in the lane's own scope by default. widen or narrow the search with --scopes, --owners and\n--exclude-scopes.\nfollow the job with \"bit ripple log\". once it finishes, \"bit ripple errors\" shows what broke. both take the job id\nprinted when the simulation starts.",
+                "group": "ungrouped",
+                "private": false,
+                "remoteOp": true,
+                "skipWorkspace": true
             }
         ]
     },
@@ -4611,6 +4648,28 @@
                     }
                 ]
             },
+            {
+                "name": "updates [lane-name]",
+                "alias": "",
+                "options": [
+                    [
+                        "",
+                        "undo",
+                        "remove the cascaded dependents from the lane, on the remote and locally"
+                    ],
+                    [
+                        "j",
+                        "json",
+                        "return the results in json format"
+                    ]
+                ],
+                "description": "show the dependents Ripple CI cascaded onto a lane, default to the current lane",
+                "extendedDescription": "after a lane is exported, Ripple CI may snap the dependents of the lane components against the new\nheads and add them to the lane as hidden \"update\" entries. they are part of the lane graph (Ripple CI builds them, merge\nrefreshes them) but stay hidden from the workspace (\"bit status\", .bitmap).\nthe entries are read from the remote lane. the local lane object is used only when the remote is unavailable.\nuse --undo to remove them from the lane, on the remote and locally, e.g. when the cascade is not wanted.",
+                "group": "collaborate",
+                "private": false,
+                "remoteOp": true,
+                "skipWorkspace": true
+            },
             {
                 "name": "merge <lane> [pattern]",
                 "alias": "",