@teambit/harmony.content.cli-reference 1.95.206 → 1.95.208

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: 0.2.29'
2
+ description: 'Bit command synopses. Bit version: 0.2.30'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -367,6 +367,11 @@
367
367
  "g",
368
368
  "graph",
369
369
  "generate graph image (arrows color: {\"parent\":\"green\",\"unrelated\":\"red\",\"squashed\":\"blue\"})"
370
+ ],
371
+ [
372
+ "",
373
+ "mark <string>",
374
+ "relevant for --graph only. paint the given node-ids in the graph in red color, for multiple, separate by commas"
370
375
  ]
371
376
  ],
372
377
  "description": "cat version-history object by component-id",
@@ -481,8 +486,8 @@
481
486
  "options": [
482
487
  [
483
488
  "d",
484
- "hub-domain-login <url>",
485
- "hub domain login url (default https://bit.cloud)"
489
+ "cloud-domain <domain>",
490
+ "login cloud domain (default bit.cloud)"
486
491
  ],
487
492
  [
488
493
  "p",
@@ -1273,29 +1278,110 @@
1273
1278
  ]
1274
1279
  },
1275
1280
  {
1276
- "name": "watch",
1277
- "alias": "",
1278
- "options": [
1279
- [
1280
- "v",
1281
- "verbose",
1282
- "show all watch events and compiler verbose output"
1283
- ],
1284
- [
1285
- "",
1286
- "skip-pre-compilation",
1287
- "skip compilation step before starting to watch"
1288
- ],
1289
- [
1290
- "t",
1291
- "check-types [string]",
1292
- "EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project"
1293
- ]
1294
- ],
1295
- "description": "automatically recompile modified components (on save)",
1296
- "extendedDescription": "by default, the watcher doesn't use polling, to keep the CPU idle.\nin some rare cases, this could result in missing file events. to fix it, try to prefix this command with CHOKIDAR_USEPOLLING=true\nalternatively, restarting the computer could also help.",
1281
+ "name": "ws-config <sub-command>",
1282
+ "alias": "workspace-config",
1283
+ "options": [],
1284
+ "description": "manage workspace config files",
1285
+ "extendedDescription": "",
1297
1286
  "group": "development",
1298
- "private": false
1287
+ "private": false,
1288
+ "commands": [
1289
+ {
1290
+ "name": "write",
1291
+ "alias": "",
1292
+ "options": [
1293
+ [
1294
+ "c",
1295
+ "clean",
1296
+ "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
1297
+ ],
1298
+ [
1299
+ "w",
1300
+ "writers <writers>",
1301
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
1302
+ ],
1303
+ [
1304
+ "s",
1305
+ "silent",
1306
+ "do not prompt for confirmation"
1307
+ ],
1308
+ [
1309
+ "",
1310
+ "no-dedupe",
1311
+ "write configs inside each one of the component's dir, avoid deduping"
1312
+ ],
1313
+ [
1314
+ "",
1315
+ "dry-run",
1316
+ "show the paths that configs will be written per env"
1317
+ ],
1318
+ [
1319
+ "",
1320
+ "dry-run-with-content",
1321
+ "use with --json flag. show the config content and the paths that will be written per env"
1322
+ ],
1323
+ [
1324
+ "v",
1325
+ "verbose",
1326
+ "showing verbose output for writing"
1327
+ ],
1328
+ [
1329
+ "j",
1330
+ "json",
1331
+ "json format"
1332
+ ]
1333
+ ],
1334
+ "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
1335
+ "extendedDescription": "",
1336
+ "group": "development",
1337
+ "private": false
1338
+ },
1339
+ {
1340
+ "name": "clean",
1341
+ "alias": "",
1342
+ "options": [
1343
+ [
1344
+ "s",
1345
+ "silent",
1346
+ "do not prompt for confirmation"
1347
+ ],
1348
+ [
1349
+ "w",
1350
+ "writers <writers>",
1351
+ "only clean config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
1352
+ ],
1353
+ [
1354
+ "",
1355
+ "dry-run",
1356
+ "show the paths of configs that will be cleaned"
1357
+ ],
1358
+ [
1359
+ "j",
1360
+ "json",
1361
+ "json format"
1362
+ ]
1363
+ ],
1364
+ "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
1365
+ "extendedDescription": "",
1366
+ "group": "development",
1367
+ "private": false
1368
+ },
1369
+ {
1370
+ "name": "list",
1371
+ "alias": "",
1372
+ "options": [
1373
+ [
1374
+ "j",
1375
+ "json",
1376
+ "json format"
1377
+ ]
1378
+ ],
1379
+ "description": "EXPERIMENTAL. list config writers",
1380
+ "extendedDescription": "",
1381
+ "group": "development",
1382
+ "private": false
1383
+ }
1384
+ ]
1299
1385
  },
1300
1386
  {
1301
1387
  "name": "add [path...]",
@@ -1490,6 +1576,31 @@
1490
1576
  }
1491
1577
  ]
1492
1578
  },
1579
+ {
1580
+ "name": "watch",
1581
+ "alias": "",
1582
+ "options": [
1583
+ [
1584
+ "v",
1585
+ "verbose",
1586
+ "show all watch events and compiler verbose output"
1587
+ ],
1588
+ [
1589
+ "",
1590
+ "skip-pre-compilation",
1591
+ "skip compilation step before starting to watch"
1592
+ ],
1593
+ [
1594
+ "t",
1595
+ "check-types [string]",
1596
+ "EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project"
1597
+ ]
1598
+ ],
1599
+ "description": "automatically recompile modified components (on save)",
1600
+ "extendedDescription": "by default, the watcher doesn't use polling, to keep the CPU idle.\nin some rare cases, this could result in missing file events. to fix it, try to prefix this command with CHOKIDAR_USEPOLLING=true\nalternatively, restarting the computer could also help.",
1601
+ "group": "development",
1602
+ "private": false
1603
+ },
1493
1604
  {
1494
1605
  "name": "build [component-pattern]",
1495
1606
  "alias": "",
@@ -2053,16 +2164,6 @@
2053
2164
  "name": "remove <component-pattern>",
2054
2165
  "alias": "rm",
2055
2166
  "options": [
2056
- [
2057
- "",
2058
- "delete",
2059
- "mark the component as deleted. after tag/snap and export the remote will be updated"
2060
- ],
2061
- [
2062
- "",
2063
- "hard",
2064
- "remove a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. prefer --delete"
2065
- ],
2066
2167
  [
2067
2168
  "t",
2068
2169
  "track",
@@ -2073,6 +2174,44 @@
2073
2174
  "keep-files",
2074
2175
  "keep component files (just untrack the component)"
2075
2176
  ],
2177
+ [
2178
+ "f",
2179
+ "force",
2180
+ "removes the component from the scope, even if used as a dependency. WARNING: you will need to fix the components that depend on this component"
2181
+ ],
2182
+ [
2183
+ "s",
2184
+ "silent",
2185
+ "skip confirmation"
2186
+ ]
2187
+ ],
2188
+ "description": "remove component(s) from the local workspace",
2189
+ "extendedDescription": "to mark components as deleted on the remote scope, use \"bit delete\".",
2190
+ "group": "collaborate",
2191
+ "private": false,
2192
+ "remoteOp": true,
2193
+ "skipWorkspace": true,
2194
+ "arguments": [
2195
+ {
2196
+ "name": "component-pattern",
2197
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
2198
+ }
2199
+ ]
2200
+ },
2201
+ {
2202
+ "name": "delete <component-pattern>",
2203
+ "alias": "",
2204
+ "options": [
2205
+ [
2206
+ "",
2207
+ "lane",
2208
+ "when on a lane, delete the component from this lane only. avoid merging it to main or other lanes"
2209
+ ],
2210
+ [
2211
+ "",
2212
+ "update-main",
2213
+ "EXPERIMENTAL. delete component/s on the main lane after merging this lane into main"
2214
+ ],
2076
2215
  [
2077
2216
  "f",
2078
2217
  "force",
@@ -2082,10 +2221,15 @@
2082
2221
  "s",
2083
2222
  "silent",
2084
2223
  "skip confirmation"
2224
+ ],
2225
+ [
2226
+ "",
2227
+ "hard",
2228
+ "NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents."
2085
2229
  ]
2086
2230
  ],
2087
- "description": "remove component(s) from the workspace, or a remote scope (with a flag)",
2088
- "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\n\nto remove components from a lane, use \"bit lane remove-comp\".\n",
2231
+ "description": "mark components as deleted on the remote",
2232
+ "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",
2089
2233
  "group": "collaborate",
2090
2234
  "private": false,
2091
2235
  "remoteOp": true,
@@ -3265,8 +3409,8 @@
3265
3409
  "EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main"
3266
3410
  ]
3267
3411
  ],
3268
- "description": "remove components when on a lane",
3269
- "extendedDescription": "in case the components are part of the lane and the lane is exported, it marks the components as\nremoved from the lane, and then after snap+export, the remote-lane gets updated as well.\nupon lane-merge, these removed components are skipped and any changes for removed components won't be merged to main.\n\nin case the components are not yet part of the lane or the lane is new, it simply removes the components from the workspace",
3412
+ "description": "DEPRECATED. remove components when on a lane",
3413
+ "extendedDescription": "",
3270
3414
  "group": "collaborate",
3271
3415
  "private": false,
3272
3416
  "arguments": [
@@ -4510,111 +4654,5 @@
4510
4654
  "extendedDescription": "",
4511
4655
  "group": "development",
4512
4656
  "private": false
4513
- },
4514
- {
4515
- "name": "ws-config <sub-command>",
4516
- "alias": "workspace-config",
4517
- "options": [],
4518
- "description": "manage workspace config files",
4519
- "extendedDescription": "",
4520
- "group": "development",
4521
- "private": false,
4522
- "commands": [
4523
- {
4524
- "name": "write",
4525
- "alias": "",
4526
- "options": [
4527
- [
4528
- "c",
4529
- "clean",
4530
- "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
4531
- ],
4532
- [
4533
- "w",
4534
- "writers <writers>",
4535
- "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4536
- ],
4537
- [
4538
- "s",
4539
- "silent",
4540
- "do not prompt for confirmation"
4541
- ],
4542
- [
4543
- "",
4544
- "no-dedupe",
4545
- "write configs inside each one of the component's dir, avoid deduping"
4546
- ],
4547
- [
4548
- "",
4549
- "dry-run",
4550
- "show the paths that configs will be written per env"
4551
- ],
4552
- [
4553
- "",
4554
- "dry-run-with-content",
4555
- "use with --json flag. show the config content and the paths that will be written per env"
4556
- ],
4557
- [
4558
- "v",
4559
- "verbose",
4560
- "showing verbose output for writing"
4561
- ],
4562
- [
4563
- "j",
4564
- "json",
4565
- "json format"
4566
- ]
4567
- ],
4568
- "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
4569
- "extendedDescription": "",
4570
- "group": "development",
4571
- "private": false
4572
- },
4573
- {
4574
- "name": "clean",
4575
- "alias": "",
4576
- "options": [
4577
- [
4578
- "s",
4579
- "silent",
4580
- "do not prompt for confirmation"
4581
- ],
4582
- [
4583
- "w",
4584
- "writers <writers>",
4585
- "only clean config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4586
- ],
4587
- [
4588
- "",
4589
- "dry-run",
4590
- "show the paths of configs that will be cleaned"
4591
- ],
4592
- [
4593
- "j",
4594
- "json",
4595
- "json format"
4596
- ]
4597
- ],
4598
- "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
4599
- "extendedDescription": "",
4600
- "group": "development",
4601
- "private": false
4602
- },
4603
- {
4604
- "name": "list",
4605
- "alias": "",
4606
- "options": [
4607
- [
4608
- "j",
4609
- "json",
4610
- "json format"
4611
- ]
4612
- ],
4613
- "description": "EXPERIMENTAL. list config writers",
4614
- "extendedDescription": "",
4615
- "group": "development",
4616
- "private": false
4617
- }
4618
- ]
4619
4657
  }
4620
4658
  ]
package/cli-reference.mdx CHANGED
@@ -423,6 +423,28 @@ https://bit.dev/docs/config/bit-config
423
423
 
424
424
  ---
425
425
 
426
+ ## delete
427
+
428
+ **Description**: mark components as deleted on the remote
429
+ to remove components from your local workspace only, use "bit remove" command.
430
+ 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.
431
+
432
+ `bit delete <component-pattern>`
433
+
434
+ | **Arg** | **Description** |
435
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
436
+ | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
437
+
438
+ | **Option** | **Option alias** | **Description** |
439
+ | --------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
440
+ | `--lane` | | when on a lane, delete the component from this lane only. avoid merging it to main or other lanes |
441
+ | `--update-main` | | EXPERIMENTAL. delete component/s on the main lane after merging this lane into main |
442
+ | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
443
+ | `--silent` | `-s` | skip confirmation |
444
+ | `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. |
445
+
446
+ ---
447
+
426
448
  ## dependents
427
449
 
428
450
  **Description**: show dependents of the given component
@@ -1094,12 +1116,7 @@ bit lane diff from to => diff between "from" lane and "to" lane.
1094
1116
 
1095
1117
  **Usage**: `lane remove-comp <component-pattern>`
1096
1118
 
1097
- **Description**: remove components when on a lane
1098
- in case the components are part of the lane and the lane is exported, it marks the components as
1099
- removed from the lane, and then after snap+export, the remote-lane gets updated as well.
1100
- upon lane-merge, these removed components are skipped and any changes for removed components won't be merged to main.
1101
-
1102
- in case the components are not yet part of the lane or the lane is new, it simply removes the components from the workspace
1119
+ **Description**: DEPRECATED. remove components when on a lane
1103
1120
 
1104
1121
  | **Arg** | **Description** |
1105
1122
  | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
@@ -1267,7 +1284,7 @@ also, checkout the workspace components according to the restored lane state
1267
1284
 
1268
1285
  | **Option** | **Option alias** | **Description** |
1269
1286
  | --------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
1270
- | `--hub-domain-login <url>` | `-d` | hub domain login url (default https://bit.cloud) |
1287
+ | `--cloud-domain <domain>` | `-d` | login cloud domain (default bit.cloud) |
1271
1288
  | `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
1272
1289
  | `--suppress-browser-launch` | | do not open a browser for authentication |
1273
1290
  | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
@@ -1453,13 +1470,8 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1453
1470
  ## remove
1454
1471
 
1455
1472
  **Alias**: `rm`
1456
- **Description**: remove component(s) from the workspace, or a remote scope (with a flag)
1457
- to remove components from your local workspace only, use "bit remove" (with no flags).
1458
-
1459
- to remove a component from the remote scope, use "bit remove --delete", to mark the components as deleted.
1460
- once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.
1461
-
1462
- to remove components from a lane, use "bit lane remove-comp".
1473
+ **Description**: remove component(s) from the local workspace
1474
+ to mark components as deleted on the remote scope, use "bit delete".
1463
1475
 
1464
1476
  `bit remove <component-pattern>`
1465
1477
 
@@ -1467,14 +1479,12 @@ to remove components from a lane, use "bit lane remove-comp".
1467
1479
  | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1468
1480
  | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1469
1481
 
1470
- | **Option** | **Option alias** | **Description** |
1471
- | -------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------- |
1472
- | `--delete` | | mark the component as deleted. after tag/snap and export the remote will be updated |
1473
- | `--hard` | | remove a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. prefer --delete |
1474
- | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
1475
- | `--keep-files` | | keep component files (just untrack the component) |
1476
- | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
1477
- | `--silent` | `-s` | skip confirmation |
1482
+ | **Option** | **Option alias** | **Description** |
1483
+ | -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
1484
+ | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
1485
+ | `--keep-files` | | keep component files (just untrack the component) |
1486
+ | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: you will need to fix the components that depend on this component |
1487
+ | `--silent` | `-s` | skip confirmation |
1478
1488
 
1479
1489
  ---
1480
1490
 
@@ -1,2 +1,2 @@
1
- import React from 'react';
2
- export declare const BasicCliReference: () => React.JSX.Element;
1
+ /// <reference types="react" />
2
+ export declare const BasicCliReference: () => JSX.Element;
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 0.2.29'
2
+ description: 'Bit command synopses. Bit version: 0.2.30'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5