@teambit/harmony.content.cli-reference 2.0.1063 → 2.0.1065
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.docs.mdx +1 -1
- package/cli-reference.json +84 -1
- package/cli-reference.mdx +44 -4
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +84 -1
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1780066402004.js → preview-1780507494169.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -899,6 +899,11 @@
|
|
|
899
899
|
"j",
|
|
900
900
|
"json",
|
|
901
901
|
"json format"
|
|
902
|
+
],
|
|
903
|
+
[
|
|
904
|
+
"",
|
|
905
|
+
"with-stats",
|
|
906
|
+
"include total cache size, orphan count, and stale aspect-version count (walks the full cache)"
|
|
902
907
|
]
|
|
903
908
|
],
|
|
904
909
|
"description": "list the capsules generated for this workspace",
|
|
@@ -980,6 +985,51 @@
|
|
|
980
985
|
"extendedDescription": "with no args, only workspace's capsules are deleted",
|
|
981
986
|
"group": "advanced",
|
|
982
987
|
"private": false
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"name": "prune",
|
|
991
|
+
"alias": "",
|
|
992
|
+
"options": [
|
|
993
|
+
[
|
|
994
|
+
"",
|
|
995
|
+
"older-than <days>",
|
|
996
|
+
"age threshold in days for aspect-version/scope capsule pruning (default 30)"
|
|
997
|
+
],
|
|
998
|
+
[
|
|
999
|
+
"",
|
|
1000
|
+
"keep-workspace-caps",
|
|
1001
|
+
"skip workspace capsule deletion"
|
|
1002
|
+
],
|
|
1003
|
+
[
|
|
1004
|
+
"",
|
|
1005
|
+
"no-orphans",
|
|
1006
|
+
"don't delete capsules whose origin path no longer exists"
|
|
1007
|
+
],
|
|
1008
|
+
[
|
|
1009
|
+
"",
|
|
1010
|
+
"size-target <gb>",
|
|
1011
|
+
"after standard pruning, LRU-evict aspect-versions until total drops below this size (forces --with-sizes)"
|
|
1012
|
+
],
|
|
1013
|
+
[
|
|
1014
|
+
"",
|
|
1015
|
+
"dry-run",
|
|
1016
|
+
"preview what would be removed without deleting"
|
|
1017
|
+
],
|
|
1018
|
+
[
|
|
1019
|
+
"",
|
|
1020
|
+
"with-sizes",
|
|
1021
|
+
"compute byte sizes for the report (walks the full cache; slow on large caches). default: off — sizes shown as 0 but the prune itself is instant."
|
|
1022
|
+
],
|
|
1023
|
+
[
|
|
1024
|
+
"j",
|
|
1025
|
+
"json",
|
|
1026
|
+
"json format"
|
|
1027
|
+
]
|
|
1028
|
+
],
|
|
1029
|
+
"description": "evict stale capsules from the global cache",
|
|
1030
|
+
"extendedDescription": "workspace capsules are deleted unconditionally; aspect-version and scope capsules are deleted when their last-used marker is older than --older-than (default 30 days).\nuse --dry-run first to preview what would be removed.",
|
|
1031
|
+
"group": "advanced",
|
|
1032
|
+
"private": false
|
|
983
1033
|
}
|
|
984
1034
|
]
|
|
985
1035
|
},
|
|
@@ -1031,7 +1081,7 @@
|
|
|
1031
1081
|
]
|
|
1032
1082
|
],
|
|
1033
1083
|
"description": "test and validate component patterns",
|
|
1034
|
-
"extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/** AND $env:teambit.react/react'.\n",
|
|
1084
|
+
"extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, internal, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/** AND $env:teambit.react/react'.\n",
|
|
1035
1085
|
"group": "info-analysis",
|
|
1036
1086
|
"private": false,
|
|
1037
1087
|
"remoteOp": true,
|
|
@@ -6014,6 +6064,39 @@
|
|
|
6014
6064
|
}
|
|
6015
6065
|
]
|
|
6016
6066
|
},
|
|
6067
|
+
{
|
|
6068
|
+
"name": "internalize [component-pattern]",
|
|
6069
|
+
"alias": "",
|
|
6070
|
+
"options": [
|
|
6071
|
+
[
|
|
6072
|
+
"r",
|
|
6073
|
+
"revert",
|
|
6074
|
+
"remove the internal mark from the matching components"
|
|
6075
|
+
],
|
|
6076
|
+
[
|
|
6077
|
+
"l",
|
|
6078
|
+
"list",
|
|
6079
|
+
"list the components currently marked as internal"
|
|
6080
|
+
],
|
|
6081
|
+
[
|
|
6082
|
+
"j",
|
|
6083
|
+
"json",
|
|
6084
|
+
"return the output as json (the internal components with --list, otherwise the affected component-ids)"
|
|
6085
|
+
]
|
|
6086
|
+
],
|
|
6087
|
+
"description": "mark components as internal to hide them by default in the UI",
|
|
6088
|
+
"extendedDescription": "marks components as internal locally, then after snap/tag and export they become internal in the remote scope.\nunlike \"bit local-only\", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).\nuse --revert to remove the internal mark, or --list to show the components currently marked as internal.",
|
|
6089
|
+
"group": "collaborate",
|
|
6090
|
+
"private": false,
|
|
6091
|
+
"remoteOp": true,
|
|
6092
|
+
"skipWorkspace": true,
|
|
6093
|
+
"arguments": [
|
|
6094
|
+
{
|
|
6095
|
+
"name": "component-pattern",
|
|
6096
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
|
|
6097
|
+
}
|
|
6098
|
+
]
|
|
6099
|
+
},
|
|
6017
6100
|
{
|
|
6018
6101
|
"name": "generate-preview [component-pattern]",
|
|
6019
6102
|
"alias": "",
|
package/cli-reference.mdx
CHANGED
|
@@ -265,9 +265,10 @@ ensures components work independently before publishing, similar to how they'll
|
|
|
265
265
|
|
|
266
266
|
**Description**: list the capsules generated for this workspace
|
|
267
267
|
|
|
268
|
-
| **Option**
|
|
269
|
-
|
|
|
270
|
-
| `--json`
|
|
268
|
+
| **Option** | **Option alias** | **Description** |
|
|
269
|
+
| -------------- | :--------------: | --------------------------------------------------------------------------------------------- |
|
|
270
|
+
| `--json` | `-j` | json format |
|
|
271
|
+
| `--with-stats` | | include total cache size, orphan count, and stale aspect-version count (walks the full cache) |
|
|
271
272
|
|
|
272
273
|
### capsule create
|
|
273
274
|
|
|
@@ -299,6 +300,24 @@ with no args, only workspace's capsules are deleted
|
|
|
299
300
|
| `--scope-aspects` | | delete scope-aspects capsules |
|
|
300
301
|
| `--all` | `-a` | delete all capsules for all workspaces and scopes |
|
|
301
302
|
|
|
303
|
+
### capsule prune
|
|
304
|
+
|
|
305
|
+
**Usage**: `capsule prune`
|
|
306
|
+
|
|
307
|
+
**Description**: evict stale capsules from the global cache
|
|
308
|
+
workspace capsules are deleted unconditionally; aspect-version and scope capsules are deleted when their last-used marker is older than --older-than (default 30 days).
|
|
309
|
+
use --dry-run first to preview what would be removed.
|
|
310
|
+
|
|
311
|
+
| **Option** | **Option alias** | **Description** |
|
|
312
|
+
| ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
313
|
+
| `--older-than <days>` | | age threshold in days for aspect-version/scope capsule pruning (default 30) |
|
|
314
|
+
| `--keep-workspace-caps` | | skip workspace capsule deletion |
|
|
315
|
+
| `--no-orphans` | | don't delete capsules whose origin path no longer exists |
|
|
316
|
+
| `--size-target <gb>` | | after standard pruning, LRU-evict aspect-versions until total drops below this size (forces --with-sizes) |
|
|
317
|
+
| `--dry-run` | | preview what would be removed without deleting |
|
|
318
|
+
| `--with-sizes` | | compute byte sizes for the report (walks the full cache; slow on large caches). default: off — sizes shown as 0 but the prune itself is instant. |
|
|
319
|
+
| `--json` | `-j` | json format |
|
|
320
|
+
|
|
302
321
|
| **Option** | **Option alias** | **Description** |
|
|
303
322
|
| ---------- | :--------------: | --------------- |
|
|
304
323
|
| `--json` | `-j` | json format |
|
|
@@ -1252,6 +1271,27 @@ automatically imports components, compiles components, links to node_modules, an
|
|
|
1252
1271
|
|
|
1253
1272
|
---
|
|
1254
1273
|
|
|
1274
|
+
## internalize
|
|
1275
|
+
|
|
1276
|
+
**Description**: mark components as internal to hide them by default in the UI
|
|
1277
|
+
marks components as internal locally, then after snap/tag and export they become internal in the remote scope.
|
|
1278
|
+
unlike "bit local-only", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).
|
|
1279
|
+
use --revert to remove the internal mark, or --list to show the components currently marked as internal.
|
|
1280
|
+
|
|
1281
|
+
`bit internalize [component-pattern]`
|
|
1282
|
+
|
|
1283
|
+
| **Arg** | **Description** |
|
|
1284
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1285
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1286
|
+
|
|
1287
|
+
| **Option** | **Option alias** | **Description** |
|
|
1288
|
+
| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
|
|
1289
|
+
| `--revert` | `-r` | remove the internal mark from the matching components |
|
|
1290
|
+
| `--list` | `-l` | list the components currently marked as internal |
|
|
1291
|
+
| `--json` | `-j` | return the output as json (the internal components with --list, otherwise the affected component-ids) |
|
|
1292
|
+
|
|
1293
|
+
---
|
|
1294
|
+
|
|
1255
1295
|
## lane
|
|
1256
1296
|
|
|
1257
1297
|
**Alias**: `l`
|
|
@@ -1991,7 +2031,7 @@ to exclude, use '!'. e.g. 'ui/**, !ui/button'
|
|
|
1991
2031
|
the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).
|
|
1992
2032
|
|
|
1993
2033
|
to filter by a state or attribute, prefix the pattern with "$". e.g. '$deprecated', '$modified'.
|
|
1994
|
-
list of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].
|
|
2034
|
+
list of supported states: [new, modified, deprecated, deleted, internal, snappedOnMain, softTagged, codeModified, localOnly].
|
|
1995
2035
|
to filter by multi-params state/attribute, separate the params with ":", e.g. '$env:teambit.react/react'.
|
|
1996
2036
|
list of supported multi-params states: [env].
|
|
1997
2037
|
to match a state and another criteria, use " AND " keyword. e.g. '$modified AND teambit.workspace/\*\* AND $env:teambit.react/react'.
|
package/dist/cli-reference.json
CHANGED
|
@@ -899,6 +899,11 @@
|
|
|
899
899
|
"j",
|
|
900
900
|
"json",
|
|
901
901
|
"json format"
|
|
902
|
+
],
|
|
903
|
+
[
|
|
904
|
+
"",
|
|
905
|
+
"with-stats",
|
|
906
|
+
"include total cache size, orphan count, and stale aspect-version count (walks the full cache)"
|
|
902
907
|
]
|
|
903
908
|
],
|
|
904
909
|
"description": "list the capsules generated for this workspace",
|
|
@@ -980,6 +985,51 @@
|
|
|
980
985
|
"extendedDescription": "with no args, only workspace's capsules are deleted",
|
|
981
986
|
"group": "advanced",
|
|
982
987
|
"private": false
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"name": "prune",
|
|
991
|
+
"alias": "",
|
|
992
|
+
"options": [
|
|
993
|
+
[
|
|
994
|
+
"",
|
|
995
|
+
"older-than <days>",
|
|
996
|
+
"age threshold in days for aspect-version/scope capsule pruning (default 30)"
|
|
997
|
+
],
|
|
998
|
+
[
|
|
999
|
+
"",
|
|
1000
|
+
"keep-workspace-caps",
|
|
1001
|
+
"skip workspace capsule deletion"
|
|
1002
|
+
],
|
|
1003
|
+
[
|
|
1004
|
+
"",
|
|
1005
|
+
"no-orphans",
|
|
1006
|
+
"don't delete capsules whose origin path no longer exists"
|
|
1007
|
+
],
|
|
1008
|
+
[
|
|
1009
|
+
"",
|
|
1010
|
+
"size-target <gb>",
|
|
1011
|
+
"after standard pruning, LRU-evict aspect-versions until total drops below this size (forces --with-sizes)"
|
|
1012
|
+
],
|
|
1013
|
+
[
|
|
1014
|
+
"",
|
|
1015
|
+
"dry-run",
|
|
1016
|
+
"preview what would be removed without deleting"
|
|
1017
|
+
],
|
|
1018
|
+
[
|
|
1019
|
+
"",
|
|
1020
|
+
"with-sizes",
|
|
1021
|
+
"compute byte sizes for the report (walks the full cache; slow on large caches). default: off — sizes shown as 0 but the prune itself is instant."
|
|
1022
|
+
],
|
|
1023
|
+
[
|
|
1024
|
+
"j",
|
|
1025
|
+
"json",
|
|
1026
|
+
"json format"
|
|
1027
|
+
]
|
|
1028
|
+
],
|
|
1029
|
+
"description": "evict stale capsules from the global cache",
|
|
1030
|
+
"extendedDescription": "workspace capsules are deleted unconditionally; aspect-version and scope capsules are deleted when their last-used marker is older than --older-than (default 30 days).\nuse --dry-run first to preview what would be removed.",
|
|
1031
|
+
"group": "advanced",
|
|
1032
|
+
"private": false
|
|
983
1033
|
}
|
|
984
1034
|
]
|
|
985
1035
|
},
|
|
@@ -1031,7 +1081,7 @@
|
|
|
1031
1081
|
]
|
|
1032
1082
|
],
|
|
1033
1083
|
"description": "test and validate component patterns",
|
|
1034
|
-
"extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/** AND $env:teambit.react/react'.\n",
|
|
1084
|
+
"extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, internal, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/** AND $env:teambit.react/react'.\n",
|
|
1035
1085
|
"group": "info-analysis",
|
|
1036
1086
|
"private": false,
|
|
1037
1087
|
"remoteOp": true,
|
|
@@ -6014,6 +6064,39 @@
|
|
|
6014
6064
|
}
|
|
6015
6065
|
]
|
|
6016
6066
|
},
|
|
6067
|
+
{
|
|
6068
|
+
"name": "internalize [component-pattern]",
|
|
6069
|
+
"alias": "",
|
|
6070
|
+
"options": [
|
|
6071
|
+
[
|
|
6072
|
+
"r",
|
|
6073
|
+
"revert",
|
|
6074
|
+
"remove the internal mark from the matching components"
|
|
6075
|
+
],
|
|
6076
|
+
[
|
|
6077
|
+
"l",
|
|
6078
|
+
"list",
|
|
6079
|
+
"list the components currently marked as internal"
|
|
6080
|
+
],
|
|
6081
|
+
[
|
|
6082
|
+
"j",
|
|
6083
|
+
"json",
|
|
6084
|
+
"return the output as json (the internal components with --list, otherwise the affected component-ids)"
|
|
6085
|
+
]
|
|
6086
|
+
],
|
|
6087
|
+
"description": "mark components as internal to hide them by default in the UI",
|
|
6088
|
+
"extendedDescription": "marks components as internal locally, then after snap/tag and export they become internal in the remote scope.\nunlike \"bit local-only\", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).\nuse --revert to remove the internal mark, or --list to show the components currently marked as internal.",
|
|
6089
|
+
"group": "collaborate",
|
|
6090
|
+
"private": false,
|
|
6091
|
+
"remoteOp": true,
|
|
6092
|
+
"skipWorkspace": true,
|
|
6093
|
+
"arguments": [
|
|
6094
|
+
{
|
|
6095
|
+
"name": "component-pattern",
|
|
6096
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
|
|
6097
|
+
}
|
|
6098
|
+
]
|
|
6099
|
+
},
|
|
6017
6100
|
{
|
|
6018
6101
|
"name": "generate-preview [component-pattern]",
|
|
6019
6102
|
"alias": "",
|