@teambit/harmony.content.cli-reference 1.95.48 → 1.95.51
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.
- package/cli-reference.json +133 -23
- package/cli-reference.mdx +47 -6
- package/dist/cli-reference.json +133 -23
- package/dist/cli-reference.mdx.js +200 -8
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.51.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1659151732866.js → preview-1659756525406.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.48.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -223,26 +223,6 @@
|
|
|
223
223
|
"group": "info",
|
|
224
224
|
"private": false
|
|
225
225
|
},
|
|
226
|
-
{
|
|
227
|
-
"name": "dependencies <component-name>",
|
|
228
|
-
"alias": "",
|
|
229
|
-
"options": [
|
|
230
|
-
[
|
|
231
|
-
"t",
|
|
232
|
-
"tree",
|
|
233
|
-
"render dependencies as a tree, similar to \"npm ls\""
|
|
234
|
-
],
|
|
235
|
-
[
|
|
236
|
-
"d",
|
|
237
|
-
"debug",
|
|
238
|
-
"show the immediate dependencies and how their version was determined"
|
|
239
|
-
]
|
|
240
|
-
],
|
|
241
|
-
"description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
|
|
242
|
-
"extendedDescription": "",
|
|
243
|
-
"group": "info",
|
|
244
|
-
"private": false
|
|
245
|
-
},
|
|
246
226
|
{
|
|
247
227
|
"name": "_log <path> <args>",
|
|
248
228
|
"alias": "",
|
|
@@ -1425,6 +1405,83 @@
|
|
|
1425
1405
|
}
|
|
1426
1406
|
]
|
|
1427
1407
|
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "dependencies <sub-command>",
|
|
1410
|
+
"alias": "deps",
|
|
1411
|
+
"options": [],
|
|
1412
|
+
"description": "manage dependencies",
|
|
1413
|
+
"extendedDescription": "",
|
|
1414
|
+
"group": "info",
|
|
1415
|
+
"private": false,
|
|
1416
|
+
"commands": [
|
|
1417
|
+
{
|
|
1418
|
+
"name": "get <component-name>",
|
|
1419
|
+
"alias": "",
|
|
1420
|
+
"options": [
|
|
1421
|
+
[
|
|
1422
|
+
"t",
|
|
1423
|
+
"tree",
|
|
1424
|
+
"EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
|
|
1425
|
+
]
|
|
1426
|
+
],
|
|
1427
|
+
"description": "show direct and indirect dependencies of the given component",
|
|
1428
|
+
"extendedDescription": "",
|
|
1429
|
+
"group": "info",
|
|
1430
|
+
"private": false,
|
|
1431
|
+
"arguments": [
|
|
1432
|
+
{
|
|
1433
|
+
"name": "component-name",
|
|
1434
|
+
"description": "component name or component id"
|
|
1435
|
+
}
|
|
1436
|
+
]
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"name": "debug <component-name>",
|
|
1440
|
+
"alias": "",
|
|
1441
|
+
"options": [],
|
|
1442
|
+
"description": "show the immediate dependencies and how their versions were determined",
|
|
1443
|
+
"extendedDescription": "",
|
|
1444
|
+
"group": "info",
|
|
1445
|
+
"private": false,
|
|
1446
|
+
"arguments": [
|
|
1447
|
+
{
|
|
1448
|
+
"name": "component-name",
|
|
1449
|
+
"description": "component name or component id"
|
|
1450
|
+
}
|
|
1451
|
+
]
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "set <component-pattern> <package>",
|
|
1455
|
+
"alias": "",
|
|
1456
|
+
"options": [
|
|
1457
|
+
[
|
|
1458
|
+
"d",
|
|
1459
|
+
"dev",
|
|
1460
|
+
"add to the devDependencies"
|
|
1461
|
+
],
|
|
1462
|
+
[
|
|
1463
|
+
"p",
|
|
1464
|
+
"peer",
|
|
1465
|
+
"add to the peerDependencies"
|
|
1466
|
+
]
|
|
1467
|
+
],
|
|
1468
|
+
"description": "set a dependency to component(s)",
|
|
1469
|
+
"extendedDescription": "",
|
|
1470
|
+
"group": "info",
|
|
1471
|
+
"private": false,
|
|
1472
|
+
"arguments": [
|
|
1473
|
+
{
|
|
1474
|
+
"name": "component-pattern",
|
|
1475
|
+
"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"
|
|
1476
|
+
},
|
|
1477
|
+
{
|
|
1478
|
+
"name": "package",
|
|
1479
|
+
"description": "package name with version, e.g. \"lodash@1.0.0\""
|
|
1480
|
+
}
|
|
1481
|
+
]
|
|
1482
|
+
}
|
|
1483
|
+
]
|
|
1484
|
+
},
|
|
1428
1485
|
{
|
|
1429
1486
|
"name": "list [remote-scope]",
|
|
1430
1487
|
"alias": "ls",
|
|
@@ -1800,7 +1857,7 @@
|
|
|
1800
1857
|
"private": false
|
|
1801
1858
|
},
|
|
1802
1859
|
{
|
|
1803
|
-
"name": "publish <
|
|
1860
|
+
"name": "publish <component-pattern>",
|
|
1804
1861
|
"alias": "",
|
|
1805
1862
|
"options": [
|
|
1806
1863
|
[
|
|
@@ -1822,7 +1879,13 @@
|
|
|
1822
1879
|
"description": "publish components to npm (npm publish)",
|
|
1823
1880
|
"extendedDescription": "",
|
|
1824
1881
|
"group": "collaborate",
|
|
1825
|
-
"private": true
|
|
1882
|
+
"private": true,
|
|
1883
|
+
"arguments": [
|
|
1884
|
+
{
|
|
1885
|
+
"name": "component-pattern",
|
|
1886
|
+
"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"
|
|
1887
|
+
}
|
|
1888
|
+
]
|
|
1826
1889
|
},
|
|
1827
1890
|
{
|
|
1828
1891
|
"name": "refactor <sub-command>",
|
|
@@ -2272,6 +2335,11 @@
|
|
|
2272
2335
|
"",
|
|
2273
2336
|
"skip-watch",
|
|
2274
2337
|
"avoid running the watch process that compiles components in the background"
|
|
2338
|
+
],
|
|
2339
|
+
[
|
|
2340
|
+
"",
|
|
2341
|
+
"ssr",
|
|
2342
|
+
"run app in server side rendering mode."
|
|
2275
2343
|
]
|
|
2276
2344
|
],
|
|
2277
2345
|
"description": "run an app (independent of bit's dev server)",
|
|
@@ -2323,6 +2391,42 @@
|
|
|
2323
2391
|
"extendedDescription": "",
|
|
2324
2392
|
"group": "apps",
|
|
2325
2393
|
"private": false
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"name": "run <app-name>",
|
|
2397
|
+
"alias": "c",
|
|
2398
|
+
"options": [
|
|
2399
|
+
[
|
|
2400
|
+
"d",
|
|
2401
|
+
"dev",
|
|
2402
|
+
"start the application in dev mode."
|
|
2403
|
+
],
|
|
2404
|
+
[
|
|
2405
|
+
"v",
|
|
2406
|
+
"verbose",
|
|
2407
|
+
"showing verbose output for inspection and prints stack trace"
|
|
2408
|
+
],
|
|
2409
|
+
[
|
|
2410
|
+
"",
|
|
2411
|
+
"skip-watch",
|
|
2412
|
+
"avoid running the watch process that compiles components in the background"
|
|
2413
|
+
],
|
|
2414
|
+
[
|
|
2415
|
+
"",
|
|
2416
|
+
"ssr",
|
|
2417
|
+
"run app in server side rendering mode."
|
|
2418
|
+
]
|
|
2419
|
+
],
|
|
2420
|
+
"description": "run an app (independent of bit's dev server)",
|
|
2421
|
+
"extendedDescription": "",
|
|
2422
|
+
"group": "apps",
|
|
2423
|
+
"private": false,
|
|
2424
|
+
"arguments": [
|
|
2425
|
+
{
|
|
2426
|
+
"name": "app-name",
|
|
2427
|
+
"description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
|
|
2428
|
+
}
|
|
2429
|
+
]
|
|
2326
2430
|
}
|
|
2327
2431
|
]
|
|
2328
2432
|
},
|
|
@@ -2477,7 +2581,13 @@
|
|
|
2477
2581
|
{
|
|
2478
2582
|
"name": "set <pattern> <aspect-id> [config]",
|
|
2479
2583
|
"alias": "",
|
|
2480
|
-
"options": [
|
|
2584
|
+
"options": [
|
|
2585
|
+
[
|
|
2586
|
+
"m",
|
|
2587
|
+
"merge",
|
|
2588
|
+
"merge with an existing config if exits. (by default, it replaces the config)"
|
|
2589
|
+
]
|
|
2590
|
+
],
|
|
2481
2591
|
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|
|
2482
2592
|
"extendedDescription": "",
|
|
2483
2593
|
"group": "development",
|
package/cli-reference.mdx
CHANGED
|
@@ -39,6 +39,19 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
|
|
|
39
39
|
| ---------- | :--------------: | ---------------------------------------- |
|
|
40
40
|
| `--json` | `-j` | return the component data in json format |
|
|
41
41
|
|
|
42
|
+
### app run
|
|
43
|
+
|
|
44
|
+
**Usage**: `app run <app-name>`
|
|
45
|
+
|
|
46
|
+
**Description**: run an app (independent of bit's dev server)
|
|
47
|
+
|
|
48
|
+
| **Option** | **Option alias** | **Description** |
|
|
49
|
+
| -------------- | :--------------: | -------------------------------------------------------------------------- |
|
|
50
|
+
| `--dev` | `-d` | start the application in dev mode. |
|
|
51
|
+
| `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
|
|
52
|
+
| `--skip-watch` | | avoid running the watch process that compiles components in the background |
|
|
53
|
+
| `--ssr` | | run app in server side rendering mode. |
|
|
54
|
+
|
|
42
55
|
---
|
|
43
56
|
|
|
44
57
|
## artifacts
|
|
@@ -94,6 +107,10 @@ and a package.tgz file generated by pkg aspect.
|
|
|
94
107
|
|
|
95
108
|
**Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
|
|
96
109
|
|
|
110
|
+
| **Option** | **Option alias** | **Description** |
|
|
111
|
+
| ---------- | :--------------: | ---------------------------------------------------------------------------- |
|
|
112
|
+
| `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces the config) |
|
|
113
|
+
|
|
97
114
|
### aspect unset
|
|
98
115
|
|
|
99
116
|
**Usage**: `aspect unset <pattern> <aspect-id>`
|
|
@@ -356,15 +373,38 @@ https://bit.dev/docs/config/bit-config
|
|
|
356
373
|
|
|
357
374
|
## dependencies
|
|
358
375
|
|
|
376
|
+
**Alias**: `deps`
|
|
359
377
|
**Workspace only**: yes
|
|
360
|
-
**Description**:
|
|
378
|
+
**Description**: manage dependencies
|
|
379
|
+
|
|
380
|
+
`bit dependencies <sub-command>`
|
|
381
|
+
|
|
382
|
+
### dependencies get
|
|
383
|
+
|
|
384
|
+
**Usage**: `dependencies get <component-name>`
|
|
385
|
+
|
|
386
|
+
**Description**: show direct and indirect dependencies of the given component
|
|
387
|
+
|
|
388
|
+
| **Option** | **Option alias** | **Description** |
|
|
389
|
+
| ---------- | :--------------: | ---------------------------------------------------------------- |
|
|
390
|
+
| `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
|
|
391
|
+
|
|
392
|
+
### dependencies debug
|
|
393
|
+
|
|
394
|
+
**Usage**: `dependencies debug <component-name>`
|
|
395
|
+
|
|
396
|
+
**Description**: show the immediate dependencies and how their versions were determined
|
|
397
|
+
|
|
398
|
+
### dependencies set
|
|
399
|
+
|
|
400
|
+
**Usage**: `dependencies set <component-pattern> <package>`
|
|
361
401
|
|
|
362
|
-
|
|
402
|
+
**Description**: set a dependency to component(s)
|
|
363
403
|
|
|
364
|
-
| **Option** | **Option alias** | **Description**
|
|
365
|
-
| ---------- | :--------------: |
|
|
366
|
-
| `--
|
|
367
|
-
| `--
|
|
404
|
+
| **Option** | **Option alias** | **Description** |
|
|
405
|
+
| ---------- | :--------------: | --------------------------- |
|
|
406
|
+
| `--dev` | `-d` | add to the devDependencies |
|
|
407
|
+
| `--peer` | `-p` | add to the peerDependencies |
|
|
368
408
|
|
|
369
409
|
---
|
|
370
410
|
|
|
@@ -979,6 +1019,7 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
979
1019
|
| `--dev` | `-d` | start the application in dev mode. |
|
|
980
1020
|
| `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
|
|
981
1021
|
| `--skip-watch` | | avoid running the watch process that compiles components in the background |
|
|
1022
|
+
| `--ssr` | | run app in server side rendering mode. |
|
|
982
1023
|
|
|
983
1024
|
---
|
|
984
1025
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -223,26 +223,6 @@
|
|
|
223
223
|
"group": "info",
|
|
224
224
|
"private": false
|
|
225
225
|
},
|
|
226
|
-
{
|
|
227
|
-
"name": "dependencies <component-name>",
|
|
228
|
-
"alias": "",
|
|
229
|
-
"options": [
|
|
230
|
-
[
|
|
231
|
-
"t",
|
|
232
|
-
"tree",
|
|
233
|
-
"render dependencies as a tree, similar to \"npm ls\""
|
|
234
|
-
],
|
|
235
|
-
[
|
|
236
|
-
"d",
|
|
237
|
-
"debug",
|
|
238
|
-
"show the immediate dependencies and how their version was determined"
|
|
239
|
-
]
|
|
240
|
-
],
|
|
241
|
-
"description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
|
|
242
|
-
"extendedDescription": "",
|
|
243
|
-
"group": "info",
|
|
244
|
-
"private": false
|
|
245
|
-
},
|
|
246
226
|
{
|
|
247
227
|
"name": "_log <path> <args>",
|
|
248
228
|
"alias": "",
|
|
@@ -1425,6 +1405,83 @@
|
|
|
1425
1405
|
}
|
|
1426
1406
|
]
|
|
1427
1407
|
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "dependencies <sub-command>",
|
|
1410
|
+
"alias": "deps",
|
|
1411
|
+
"options": [],
|
|
1412
|
+
"description": "manage dependencies",
|
|
1413
|
+
"extendedDescription": "",
|
|
1414
|
+
"group": "info",
|
|
1415
|
+
"private": false,
|
|
1416
|
+
"commands": [
|
|
1417
|
+
{
|
|
1418
|
+
"name": "get <component-name>",
|
|
1419
|
+
"alias": "",
|
|
1420
|
+
"options": [
|
|
1421
|
+
[
|
|
1422
|
+
"t",
|
|
1423
|
+
"tree",
|
|
1424
|
+
"EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
|
|
1425
|
+
]
|
|
1426
|
+
],
|
|
1427
|
+
"description": "show direct and indirect dependencies of the given component",
|
|
1428
|
+
"extendedDescription": "",
|
|
1429
|
+
"group": "info",
|
|
1430
|
+
"private": false,
|
|
1431
|
+
"arguments": [
|
|
1432
|
+
{
|
|
1433
|
+
"name": "component-name",
|
|
1434
|
+
"description": "component name or component id"
|
|
1435
|
+
}
|
|
1436
|
+
]
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"name": "debug <component-name>",
|
|
1440
|
+
"alias": "",
|
|
1441
|
+
"options": [],
|
|
1442
|
+
"description": "show the immediate dependencies and how their versions were determined",
|
|
1443
|
+
"extendedDescription": "",
|
|
1444
|
+
"group": "info",
|
|
1445
|
+
"private": false,
|
|
1446
|
+
"arguments": [
|
|
1447
|
+
{
|
|
1448
|
+
"name": "component-name",
|
|
1449
|
+
"description": "component name or component id"
|
|
1450
|
+
}
|
|
1451
|
+
]
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "set <component-pattern> <package>",
|
|
1455
|
+
"alias": "",
|
|
1456
|
+
"options": [
|
|
1457
|
+
[
|
|
1458
|
+
"d",
|
|
1459
|
+
"dev",
|
|
1460
|
+
"add to the devDependencies"
|
|
1461
|
+
],
|
|
1462
|
+
[
|
|
1463
|
+
"p",
|
|
1464
|
+
"peer",
|
|
1465
|
+
"add to the peerDependencies"
|
|
1466
|
+
]
|
|
1467
|
+
],
|
|
1468
|
+
"description": "set a dependency to component(s)",
|
|
1469
|
+
"extendedDescription": "",
|
|
1470
|
+
"group": "info",
|
|
1471
|
+
"private": false,
|
|
1472
|
+
"arguments": [
|
|
1473
|
+
{
|
|
1474
|
+
"name": "component-pattern",
|
|
1475
|
+
"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"
|
|
1476
|
+
},
|
|
1477
|
+
{
|
|
1478
|
+
"name": "package",
|
|
1479
|
+
"description": "package name with version, e.g. \"lodash@1.0.0\""
|
|
1480
|
+
}
|
|
1481
|
+
]
|
|
1482
|
+
}
|
|
1483
|
+
]
|
|
1484
|
+
},
|
|
1428
1485
|
{
|
|
1429
1486
|
"name": "list [remote-scope]",
|
|
1430
1487
|
"alias": "ls",
|
|
@@ -1800,7 +1857,7 @@
|
|
|
1800
1857
|
"private": false
|
|
1801
1858
|
},
|
|
1802
1859
|
{
|
|
1803
|
-
"name": "publish <
|
|
1860
|
+
"name": "publish <component-pattern>",
|
|
1804
1861
|
"alias": "",
|
|
1805
1862
|
"options": [
|
|
1806
1863
|
[
|
|
@@ -1822,7 +1879,13 @@
|
|
|
1822
1879
|
"description": "publish components to npm (npm publish)",
|
|
1823
1880
|
"extendedDescription": "",
|
|
1824
1881
|
"group": "collaborate",
|
|
1825
|
-
"private": true
|
|
1882
|
+
"private": true,
|
|
1883
|
+
"arguments": [
|
|
1884
|
+
{
|
|
1885
|
+
"name": "component-pattern",
|
|
1886
|
+
"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"
|
|
1887
|
+
}
|
|
1888
|
+
]
|
|
1826
1889
|
},
|
|
1827
1890
|
{
|
|
1828
1891
|
"name": "refactor <sub-command>",
|
|
@@ -2272,6 +2335,11 @@
|
|
|
2272
2335
|
"",
|
|
2273
2336
|
"skip-watch",
|
|
2274
2337
|
"avoid running the watch process that compiles components in the background"
|
|
2338
|
+
],
|
|
2339
|
+
[
|
|
2340
|
+
"",
|
|
2341
|
+
"ssr",
|
|
2342
|
+
"run app in server side rendering mode."
|
|
2275
2343
|
]
|
|
2276
2344
|
],
|
|
2277
2345
|
"description": "run an app (independent of bit's dev server)",
|
|
@@ -2323,6 +2391,42 @@
|
|
|
2323
2391
|
"extendedDescription": "",
|
|
2324
2392
|
"group": "apps",
|
|
2325
2393
|
"private": false
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"name": "run <app-name>",
|
|
2397
|
+
"alias": "c",
|
|
2398
|
+
"options": [
|
|
2399
|
+
[
|
|
2400
|
+
"d",
|
|
2401
|
+
"dev",
|
|
2402
|
+
"start the application in dev mode."
|
|
2403
|
+
],
|
|
2404
|
+
[
|
|
2405
|
+
"v",
|
|
2406
|
+
"verbose",
|
|
2407
|
+
"showing verbose output for inspection and prints stack trace"
|
|
2408
|
+
],
|
|
2409
|
+
[
|
|
2410
|
+
"",
|
|
2411
|
+
"skip-watch",
|
|
2412
|
+
"avoid running the watch process that compiles components in the background"
|
|
2413
|
+
],
|
|
2414
|
+
[
|
|
2415
|
+
"",
|
|
2416
|
+
"ssr",
|
|
2417
|
+
"run app in server side rendering mode."
|
|
2418
|
+
]
|
|
2419
|
+
],
|
|
2420
|
+
"description": "run an app (independent of bit's dev server)",
|
|
2421
|
+
"extendedDescription": "",
|
|
2422
|
+
"group": "apps",
|
|
2423
|
+
"private": false,
|
|
2424
|
+
"arguments": [
|
|
2425
|
+
{
|
|
2426
|
+
"name": "app-name",
|
|
2427
|
+
"description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
|
|
2428
|
+
}
|
|
2429
|
+
]
|
|
2326
2430
|
}
|
|
2327
2431
|
]
|
|
2328
2432
|
},
|
|
@@ -2477,7 +2581,13 @@
|
|
|
2477
2581
|
{
|
|
2478
2582
|
"name": "set <pattern> <aspect-id> [config]",
|
|
2479
2583
|
"alias": "",
|
|
2480
|
-
"options": [
|
|
2584
|
+
"options": [
|
|
2585
|
+
[
|
|
2586
|
+
"m",
|
|
2587
|
+
"merge",
|
|
2588
|
+
"merge with an existing config if exits. (by default, it replaces the config)"
|
|
2589
|
+
]
|
|
2590
|
+
],
|
|
2481
2591
|
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|
|
2482
2592
|
"extendedDescription": "",
|
|
2483
2593
|
"group": "development",
|