@teambit/harmony.content.cli-reference 2.0.971 → 2.0.973

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.13.108'
2
+ description: 'Bit command synopses. Bit version: 1.13.110'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1059,6 +1059,298 @@
1059
1059
  }
1060
1060
  ]
1061
1061
  },
1062
+ {
1063
+ "name": "login",
1064
+ "alias": "",
1065
+ "options": [
1066
+ [
1067
+ "",
1068
+ "skip-config-update",
1069
+ "skip writing to the .npmrc file"
1070
+ ],
1071
+ [
1072
+ "",
1073
+ "refresh-token",
1074
+ "force refresh token even when logged in"
1075
+ ],
1076
+ [
1077
+ "d",
1078
+ "cloud-domain <domain>",
1079
+ "login cloud domain (default bit.cloud)"
1080
+ ],
1081
+ [
1082
+ "",
1083
+ "default-cloud-domain",
1084
+ "login to default cloud domain (bit.cloud)"
1085
+ ],
1086
+ [
1087
+ "p",
1088
+ "port <port>",
1089
+ "port number to open for localhost server (default 8085)"
1090
+ ],
1091
+ [
1092
+ "",
1093
+ "no-browser",
1094
+ "do not open a browser for authentication"
1095
+ ],
1096
+ [
1097
+ "",
1098
+ "machine-name <name>",
1099
+ "specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token)"
1100
+ ],
1101
+ [
1102
+ "",
1103
+ "suppress-browser-launch",
1104
+ "DEPRECATE. use --no-browser instead"
1105
+ ]
1106
+ ],
1107
+ "description": "authenticate with Bit Cloud for component publishing and collaboration",
1108
+ "extendedDescription": "opens browser to authenticate with Bit Cloud (bit.cloud) and obtain access token for publishing components.\nautomatically updates .npmrc file with registry configuration and authentication token for seamless package publishing.\nsupports custom cloud domains, CI/machine authentication, and manual token refresh options.",
1109
+ "group": "auth",
1110
+ "private": false,
1111
+ "remoteOp": true,
1112
+ "skipWorkspace": true
1113
+ },
1114
+ {
1115
+ "name": "logout",
1116
+ "alias": "",
1117
+ "options": [],
1118
+ "description": "sign out of Bit Cloud and clear authentication tokens",
1119
+ "extendedDescription": "removes stored authentication tokens and signs out of Bit Cloud.\nclears local credentials while preserving .npmrc configurations.\nuse this to switch between accounts or when authentication tokens expire.",
1120
+ "group": "auth",
1121
+ "private": false,
1122
+ "skipWorkspace": true
1123
+ },
1124
+ {
1125
+ "name": "whoami",
1126
+ "alias": "",
1127
+ "options": [],
1128
+ "description": "display the currently authenticated Bit Cloud user",
1129
+ "extendedDescription": "shows the username of the currently logged in Bit Cloud account.\nverifies authentication status with the cloud service and displays the active username.\nuseful for confirming authentication before publishing or when switching between accounts.",
1130
+ "group": "auth",
1131
+ "private": false,
1132
+ "skipWorkspace": true
1133
+ },
1134
+ {
1135
+ "name": "npmrc [sub-command]",
1136
+ "alias": "",
1137
+ "options": [],
1138
+ "description": "configure .npmrc file with Bit Cloud registry and authentication settings",
1139
+ "extendedDescription": "manages .npmrc configuration for seamless package installation from Bit Cloud registries.\nautomatically configures scoped registries and authentication tokens for your workspace components.\nprovides sub-commands for generating, updating, and managing npm registry configurations.",
1140
+ "group": "auth",
1141
+ "private": false,
1142
+ "skipWorkspace": true,
1143
+ "commands": [
1144
+ {
1145
+ "name": "generate",
1146
+ "alias": "",
1147
+ "options": [
1148
+ [
1149
+ "",
1150
+ "dry-run",
1151
+ "show the .npmrc file content that will be written"
1152
+ ],
1153
+ [
1154
+ "f",
1155
+ "force",
1156
+ "force update the .npmrc file even if there are conflicts"
1157
+ ]
1158
+ ],
1159
+ "description": "update npmrc file with scope, registry, and token information from bit.cloud",
1160
+ "extendedDescription": "",
1161
+ "group": "auth",
1162
+ "private": false,
1163
+ "skipWorkspace": false
1164
+ }
1165
+ ]
1166
+ },
1167
+ {
1168
+ "name": "ripple <sub-command>",
1169
+ "alias": "",
1170
+ "options": [],
1171
+ "description": "manage Ripple CI jobs on bit.cloud",
1172
+ "extendedDescription": "view, retry, and manage Ripple CI jobs that build your components in the cloud after export.",
1173
+ "group": "collaborate",
1174
+ "private": false,
1175
+ "remoteOp": true,
1176
+ "skipWorkspace": true,
1177
+ "commands": [
1178
+ {
1179
+ "name": "list",
1180
+ "alias": "",
1181
+ "options": [
1182
+ [
1183
+ "",
1184
+ "all",
1185
+ "show jobs from all owners, not just the workspace owner"
1186
+ ],
1187
+ [
1188
+ "o",
1189
+ "owner <owner>",
1190
+ "filter by organization (default: detected from workspace defaultScope)"
1191
+ ],
1192
+ [
1193
+ "s",
1194
+ "scope <scope>",
1195
+ "filter by scope (e.g. \"teambit.cloud\")"
1196
+ ],
1197
+ [
1198
+ "",
1199
+ "lane <lane>",
1200
+ "filter by lane ID (e.g. \"scope/lane-name\")"
1201
+ ],
1202
+ [
1203
+ "u",
1204
+ "user <user>",
1205
+ "filter by username"
1206
+ ],
1207
+ [
1208
+ "",
1209
+ "status <status>",
1210
+ "filter by status (e.g. SUCCESS, FAILURE, RUNNING)"
1211
+ ],
1212
+ [
1213
+ "l",
1214
+ "limit <limit>",
1215
+ "max number of jobs to show (default: 20)"
1216
+ ],
1217
+ [
1218
+ "j",
1219
+ "json",
1220
+ "return the output as JSON"
1221
+ ]
1222
+ ],
1223
+ "description": "list recent Ripple CI jobs (filtered by workspace owner by default)",
1224
+ "extendedDescription": "",
1225
+ "group": "ungrouped",
1226
+ "private": false,
1227
+ "remoteOp": true,
1228
+ "skipWorkspace": true
1229
+ },
1230
+ {
1231
+ "name": "log [job-id]",
1232
+ "alias": "",
1233
+ "options": [
1234
+ [
1235
+ "",
1236
+ "lane <lane>",
1237
+ "lane ID to find the latest job for (default: detected from .bitmap)"
1238
+ ],
1239
+ [
1240
+ "c",
1241
+ "component <component>",
1242
+ "show build tasks for a specific component (full component ID)"
1243
+ ],
1244
+ [
1245
+ "j",
1246
+ "json",
1247
+ "return the output as JSON"
1248
+ ]
1249
+ ],
1250
+ "description": "show job details and component build task summaries (auto-detects current lane when no job-id given)",
1251
+ "extendedDescription": "",
1252
+ "group": "ungrouped",
1253
+ "private": false,
1254
+ "remoteOp": true,
1255
+ "skipWorkspace": true,
1256
+ "arguments": [
1257
+ {
1258
+ "name": "job-id",
1259
+ "description": "the Ripple CI job ID (optional — auto-detects from current lane)"
1260
+ }
1261
+ ]
1262
+ },
1263
+ {
1264
+ "name": "errors [job-id]",
1265
+ "alias": "",
1266
+ "options": [
1267
+ [
1268
+ "",
1269
+ "lane <lane>",
1270
+ "lane ID to find the latest failed job for (default: detected from .bitmap)"
1271
+ ],
1272
+ [
1273
+ "",
1274
+ "log",
1275
+ "show full build log for failed containers (not just the error summary)"
1276
+ ],
1277
+ [
1278
+ "j",
1279
+ "json",
1280
+ "return the output as JSON"
1281
+ ]
1282
+ ],
1283
+ "description": "show build errors for a Ripple CI job (auto-detects current lane when no job-id given)",
1284
+ "extendedDescription": "",
1285
+ "group": "ungrouped",
1286
+ "private": false,
1287
+ "remoteOp": true,
1288
+ "skipWorkspace": true,
1289
+ "arguments": [
1290
+ {
1291
+ "name": "job-id",
1292
+ "description": "the Ripple CI job ID (optional — auto-detects from current lane)"
1293
+ }
1294
+ ]
1295
+ },
1296
+ {
1297
+ "name": "retry [job-id]",
1298
+ "alias": "",
1299
+ "options": [
1300
+ [
1301
+ "",
1302
+ "lane <lane>",
1303
+ "lane ID to find the latest job for (default: detected from .bitmap)"
1304
+ ],
1305
+ [
1306
+ "j",
1307
+ "json",
1308
+ "return the output as JSON"
1309
+ ]
1310
+ ],
1311
+ "description": "retry a failed Ripple CI job (auto-detects current lane when no job-id given)",
1312
+ "extendedDescription": "",
1313
+ "group": "ungrouped",
1314
+ "private": false,
1315
+ "remoteOp": true,
1316
+ "skipWorkspace": true,
1317
+ "arguments": [
1318
+ {
1319
+ "name": "job-id",
1320
+ "description": "the Ripple CI job ID to retry (optional — auto-detects from current lane)"
1321
+ }
1322
+ ]
1323
+ },
1324
+ {
1325
+ "name": "stop [job-id]",
1326
+ "alias": "",
1327
+ "options": [
1328
+ [
1329
+ "",
1330
+ "lane <lane>",
1331
+ "lane ID to find the latest job for (default: detected from .bitmap)"
1332
+ ],
1333
+ [
1334
+ "j",
1335
+ "json",
1336
+ "return the output as JSON"
1337
+ ]
1338
+ ],
1339
+ "description": "stop a running Ripple CI job (auto-detects current lane when no job-id given)",
1340
+ "extendedDescription": "",
1341
+ "group": "ungrouped",
1342
+ "private": false,
1343
+ "remoteOp": true,
1344
+ "skipWorkspace": true,
1345
+ "arguments": [
1346
+ {
1347
+ "name": "job-id",
1348
+ "description": "the Ripple CI job ID to stop (optional — auto-detects from current lane)"
1349
+ }
1350
+ ]
1351
+ }
1352
+ ]
1353
+ },
1062
1354
  {
1063
1355
  "name": "list [remote-scope]",
1064
1356
  "alias": "ls",
@@ -4284,6 +4576,11 @@
4284
4576
  "",
4285
4577
  "quick",
4286
4578
  "show only new and modified components based on file changes. much faster, but does not detect dependency or config changes"
4579
+ ],
4580
+ [
4581
+ "",
4582
+ "expand",
4583
+ "expand all collapsed sections (e.g. auto-tag pending components)"
4287
4584
  ]
4288
4585
  ],
4289
4586
  "description": "show workspace component status and issues",
@@ -5151,111 +5448,6 @@
5151
5448
  }
5152
5449
  ]
5153
5450
  },
5154
- {
5155
- "name": "login",
5156
- "alias": "",
5157
- "options": [
5158
- [
5159
- "",
5160
- "skip-config-update",
5161
- "skip writing to the .npmrc file"
5162
- ],
5163
- [
5164
- "",
5165
- "refresh-token",
5166
- "force refresh token even when logged in"
5167
- ],
5168
- [
5169
- "d",
5170
- "cloud-domain <domain>",
5171
- "login cloud domain (default bit.cloud)"
5172
- ],
5173
- [
5174
- "",
5175
- "default-cloud-domain",
5176
- "login to default cloud domain (bit.cloud)"
5177
- ],
5178
- [
5179
- "p",
5180
- "port <port>",
5181
- "port number to open for localhost server (default 8085)"
5182
- ],
5183
- [
5184
- "",
5185
- "no-browser",
5186
- "do not open a browser for authentication"
5187
- ],
5188
- [
5189
- "",
5190
- "machine-name <name>",
5191
- "specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token)"
5192
- ],
5193
- [
5194
- "",
5195
- "suppress-browser-launch",
5196
- "DEPRECATE. use --no-browser instead"
5197
- ]
5198
- ],
5199
- "description": "authenticate with Bit Cloud for component publishing and collaboration",
5200
- "extendedDescription": "opens browser to authenticate with Bit Cloud (bit.cloud) and obtain access token for publishing components.\nautomatically updates .npmrc file with registry configuration and authentication token for seamless package publishing.\nsupports custom cloud domains, CI/machine authentication, and manual token refresh options.",
5201
- "group": "auth",
5202
- "private": false,
5203
- "remoteOp": true,
5204
- "skipWorkspace": true
5205
- },
5206
- {
5207
- "name": "logout",
5208
- "alias": "",
5209
- "options": [],
5210
- "description": "sign out of Bit Cloud and clear authentication tokens",
5211
- "extendedDescription": "removes stored authentication tokens and signs out of Bit Cloud.\nclears local credentials while preserving .npmrc configurations.\nuse this to switch between accounts or when authentication tokens expire.",
5212
- "group": "auth",
5213
- "private": false,
5214
- "skipWorkspace": true
5215
- },
5216
- {
5217
- "name": "whoami",
5218
- "alias": "",
5219
- "options": [],
5220
- "description": "display the currently authenticated Bit Cloud user",
5221
- "extendedDescription": "shows the username of the currently logged in Bit Cloud account.\nverifies authentication status with the cloud service and displays the active username.\nuseful for confirming authentication before publishing or when switching between accounts.",
5222
- "group": "auth",
5223
- "private": false,
5224
- "skipWorkspace": true
5225
- },
5226
- {
5227
- "name": "npmrc [sub-command]",
5228
- "alias": "",
5229
- "options": [],
5230
- "description": "configure .npmrc file with Bit Cloud registry and authentication settings",
5231
- "extendedDescription": "manages .npmrc configuration for seamless package installation from Bit Cloud registries.\nautomatically configures scoped registries and authentication tokens for your workspace components.\nprovides sub-commands for generating, updating, and managing npm registry configurations.",
5232
- "group": "auth",
5233
- "private": false,
5234
- "skipWorkspace": true,
5235
- "commands": [
5236
- {
5237
- "name": "generate",
5238
- "alias": "",
5239
- "options": [
5240
- [
5241
- "",
5242
- "dry-run",
5243
- "show the .npmrc file content that will be written"
5244
- ],
5245
- [
5246
- "f",
5247
- "force",
5248
- "force update the .npmrc file even if there are conflicts"
5249
- ]
5250
- ],
5251
- "description": "update npmrc file with scope, registry, and token information from bit.cloud",
5252
- "extendedDescription": "",
5253
- "group": "auth",
5254
- "private": false,
5255
- "skipWorkspace": false
5256
- }
5257
- ]
5258
- },
5259
5451
  {
5260
5452
  "name": "clear-cache",
5261
5453
  "alias": "cc",
package/cli-reference.mdx CHANGED
@@ -2134,6 +2134,94 @@ useful for reverting file changes without changing the component's version histo
2134
2134
 
2135
2135
  ---
2136
2136
 
2137
+ ## ripple
2138
+
2139
+ **Description**: manage Ripple CI jobs on bit.cloud
2140
+ view, retry, and manage Ripple CI jobs that build your components in the cloud after export.
2141
+
2142
+ `bit ripple <sub-command>`
2143
+
2144
+ ### ripple list
2145
+
2146
+ **Usage**: `ripple list`
2147
+
2148
+ **Description**: list recent Ripple CI jobs (filtered by workspace owner by default)
2149
+
2150
+ | **Option** | **Option alias** | **Description** |
2151
+ | ------------------- | :--------------: | ---------------------------------------------------------------------- |
2152
+ | `--all` | | show jobs from all owners, not just the workspace owner |
2153
+ | `--owner <owner>` | `-o` | filter by organization (default: detected from workspace defaultScope) |
2154
+ | `--scope <scope>` | `-s` | filter by scope (e.g. "teambit.cloud") |
2155
+ | `--lane <lane>` | | filter by lane ID (e.g. "scope/lane-name") |
2156
+ | `--user <user>` | `-u` | filter by username |
2157
+ | `--status <status>` | | filter by status (e.g. SUCCESS, FAILURE, RUNNING) |
2158
+ | `--limit <limit>` | `-l` | max number of jobs to show (default: 20) |
2159
+ | `--json` | `-j` | return the output as JSON |
2160
+
2161
+ ### ripple log
2162
+
2163
+ **Usage**: `ripple log [job-id]`
2164
+
2165
+ **Description**: show job details and component build task summaries (auto-detects current lane when no job-id given)
2166
+
2167
+ | **Arg** | **Description** |
2168
+ | -------- | :--------------------------------------------------------------: |
2169
+ | `job-id` | the Ripple CI job ID (optional — auto-detects from current lane) |
2170
+
2171
+ | **Option** | **Option alias** | **Description** |
2172
+ | ------------------------- | :--------------: | ------------------------------------------------------------------- |
2173
+ | `--lane <lane>` | | lane ID to find the latest job for (default: detected from .bitmap) |
2174
+ | `--component <component>` | `-c` | show build tasks for a specific component (full component ID) |
2175
+ | `--json` | `-j` | return the output as JSON |
2176
+
2177
+ ### ripple errors
2178
+
2179
+ **Usage**: `ripple errors [job-id]`
2180
+
2181
+ **Description**: show build errors for a Ripple CI job (auto-detects current lane when no job-id given)
2182
+
2183
+ | **Arg** | **Description** |
2184
+ | -------- | :--------------------------------------------------------------: |
2185
+ | `job-id` | the Ripple CI job ID (optional — auto-detects from current lane) |
2186
+
2187
+ | **Option** | **Option alias** | **Description** |
2188
+ | --------------- | :--------------: | -------------------------------------------------------------------------- |
2189
+ | `--lane <lane>` | | lane ID to find the latest failed job for (default: detected from .bitmap) |
2190
+ | `--log` | | show full build log for failed containers (not just the error summary) |
2191
+ | `--json` | `-j` | return the output as JSON |
2192
+
2193
+ ### ripple retry
2194
+
2195
+ **Usage**: `ripple retry [job-id]`
2196
+
2197
+ **Description**: retry a failed Ripple CI job (auto-detects current lane when no job-id given)
2198
+
2199
+ | **Arg** | **Description** |
2200
+ | -------- | :-----------------------------------------------------------------------: |
2201
+ | `job-id` | the Ripple CI job ID to retry (optional — auto-detects from current lane) |
2202
+
2203
+ | **Option** | **Option alias** | **Description** |
2204
+ | --------------- | :--------------: | ------------------------------------------------------------------- |
2205
+ | `--lane <lane>` | | lane ID to find the latest job for (default: detected from .bitmap) |
2206
+ | `--json` | `-j` | return the output as JSON |
2207
+
2208
+ ### ripple stop
2209
+
2210
+ **Usage**: `ripple stop [job-id]`
2211
+
2212
+ **Description**: stop a running Ripple CI job (auto-detects current lane when no job-id given)
2213
+
2214
+ | **Arg** | **Description** |
2215
+ | -------- | :----------------------------------------------------------------------: |
2216
+ | `job-id` | the Ripple CI job ID to stop (optional — auto-detects from current lane) |
2217
+
2218
+ | **Option** | **Option alias** | **Description** |
2219
+ | --------------- | :--------------: | ------------------------------------------------------------------- |
2220
+ | `--lane <lane>` | | lane ID to find the latest job for (default: detected from .bitmap) |
2221
+ | `--json` | `-j` | return the output as JSON |
2222
+
2223
+ ---
2224
+
2137
2225
  ## run
2138
2226
 
2139
2227
  **Alias**: `c`
@@ -2453,6 +2541,7 @@ for maximum speed (skips aspect loading entirely), use "bit mini-status".
2453
2541
  | `--fail-on-error` | | exit with code 1 only when tag/snap blocker issues are found (not warnings) |
2454
2542
  | `--ignore-circular-dependencies` | `-c` | do not check for circular dependencies to get the results quicker |
2455
2543
  | `--quick` | | show only new and modified components based on file changes. much faster, but does not detect dependency or config changes |
2544
+ | `--expand` | | expand all collapsed sections (e.g. auto-tag pending components) |
2456
2545
 
2457
2546
  ---
2458
2547
 
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.108'
2
+ description: 'Bit command synopses. Bit version: 1.13.110'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---