@teambit/harmony.content.cli-reference 2.0.765 → 2.0.767

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.
@@ -15,7 +15,7 @@
15
15
  "description": "EXPERIMENTAL. enters bit cli program and generates commands list",
16
16
  "extendedDescription": "",
17
17
  "group": "system",
18
- "private": false,
18
+ "private": true,
19
19
  "commands": [
20
20
  {
21
21
  "name": "generate",
@@ -54,8 +54,8 @@
54
54
  "show internal commands"
55
55
  ]
56
56
  ],
57
- "description": "shows help",
58
- "extendedDescription": "",
57
+ "description": "display available commands and usage information",
58
+ "extendedDescription": "shows a categorized list of all available Bit commands with brief descriptions. use `bit <command> --help` for detailed help on specific commands.",
59
59
  "group": "system",
60
60
  "private": false
61
61
  },
@@ -69,7 +69,7 @@
69
69
  "return the version in json format"
70
70
  ]
71
71
  ],
72
- "description": "shows bit version",
72
+ "description": "display the installed Bit version",
73
73
  "extendedDescription": "",
74
74
  "group": "system",
75
75
  "private": false
@@ -78,8 +78,8 @@
78
78
  "name": "config",
79
79
  "alias": "",
80
80
  "options": [],
81
- "description": "config management",
82
- "extendedDescription": "https://bit.dev/reference/config/bit-config",
81
+ "description": "manage Bit configuration settings",
82
+ "extendedDescription": "view and modify Bit configuration at different levels: global, workspace, or scope.\nconfigurations control various aspects of Bit including user settings, registries, and feature flags.\nuse environment variables prefixed with BIT_CONFIG_ for temporary overrides.\nhttps://bit.dev/reference/config/bit-config",
83
83
  "group": "system",
84
84
  "private": false,
85
85
  "commands": [
@@ -165,8 +165,8 @@
165
165
  "json format"
166
166
  ]
167
167
  ],
168
- "description": "list all globals",
169
- "extendedDescription": "",
168
+ "description": "display global directories and paths used by Bit",
169
+ "extendedDescription": "shows all global directories including cache, logs, and config locations used by Bit across your system.\nuseful for debugging and understanding where Bit stores data.",
170
170
  "group": "system",
171
171
  "private": false
172
172
  },
@@ -174,8 +174,8 @@
174
174
  "name": "system <sub-command>",
175
175
  "alias": "",
176
176
  "options": [],
177
- "description": "system operations",
178
- "extendedDescription": "",
177
+ "description": "access system-level operations and debugging tools",
178
+ "extendedDescription": "provides commands for system-level operations including viewing and tailing debug logs.\nuseful for troubleshooting issues and monitoring Bit's internal operations in real-time.",
179
179
  "group": "system",
180
180
  "private": false,
181
181
  "commands": [
@@ -209,8 +209,8 @@
209
209
  "see globally configured remotes"
210
210
  ]
211
211
  ],
212
- "description": "manage set of tracked bit scope(s)",
213
- "extendedDescription": "",
212
+ "description": "manage remote scopes for self-hosted environments",
213
+ "extendedDescription": "configure connections to self-hosted remote scopes via HTTP or file protocol.\nnote: this command is only needed for self-hosted scopes. when using bit.cloud, remote scopes are automatically configured.\nremotes are bare scopes that store exported components and enable collaboration across teams.",
214
214
  "group": "collaborate",
215
215
  "private": false,
216
216
  "commands": [
@@ -306,8 +306,8 @@
306
306
  "legacy-only. compare current file system component to its latest tagged version [default=latest]"
307
307
  ]
308
308
  ],
309
- "description": "display the component's essential information",
310
- "extendedDescription": "",
309
+ "description": "display component metadata, dependencies, and configuration",
310
+ "extendedDescription": "shows detailed information about a component including its version, dependencies, environment, and other metadata.\nnote: to see file changes made in a specific version, use `bit diff <component> <version> --parent`.",
311
311
  "group": "info-analysis",
312
312
  "private": false,
313
313
  "arguments": [
@@ -321,8 +321,8 @@
321
321
  "name": "envs",
322
322
  "alias": "env",
323
323
  "options": [],
324
- "description": "list all components maintained by the workspace and their corresponding envs",
325
- "extendedDescription": "",
324
+ "description": "show components and their assigned environments",
325
+ "extendedDescription": "displays a table showing each workspace component and its corresponding environment.\nenvironments control how components are built, tested, linted, and deployed.",
326
326
  "group": "component-config",
327
327
  "private": false,
328
328
  "commands": [
@@ -503,8 +503,8 @@
503
503
  "name of the ui root to use, e.g. \"teambit.scope/scope\" or \"teambit.workspace/workspace\""
504
504
  ]
505
505
  ],
506
- "description": "run the ui/development server",
507
- "extendedDescription": "",
506
+ "description": "launch the Bit development server",
507
+ "extendedDescription": "starts the local development server providing a UI to browse, preview, and interact with components.\nworks in both workspaces and scopes. opens automatically in your browser at http://localhost:3000 (or specified port).\nincludes hot module reloading for development.",
508
508
  "group": "run-serve",
509
509
  "private": false,
510
510
  "arguments": [
@@ -563,8 +563,8 @@
563
563
  "json format"
564
564
  ]
565
565
  ],
566
- "description": "generate an SVG image file with the components' dependencies graph",
567
- "extendedDescription": "",
566
+ "description": "visualize component dependencies as a graph image",
567
+ "extendedDescription": "generates an SVG (or PNG) image showing component dependency relationships.\nblack arrows represent runtime dependencies, red arrows show dev or peer dependencies.\nby default shows only workspace components; use --include-dependencies for full dependency tree.",
568
568
  "group": "info-analysis",
569
569
  "private": false,
570
570
  "remoteOp": true
@@ -573,8 +573,8 @@
573
573
  "name": "scope <sub-command>",
574
574
  "alias": "",
575
575
  "options": [],
576
- "description": "manage the scope-name for components",
577
- "extendedDescription": "",
576
+ "description": "manage component scope names and assignments",
577
+ "extendedDescription": "configure scope assignments for components including setting default scopes and renaming existing scopes.\nscopes determine where components are stored and published, forming the first part of component IDs.\nessential for organizing components and managing component namespaces across teams.",
578
578
  "group": "component-config",
579
579
  "private": false,
580
580
  "commands": [
@@ -787,8 +787,8 @@
787
787
  "override file if exist"
788
788
  ]
789
789
  ],
790
- "description": "eject components configuration (create a `component.json` file)",
791
- "extendedDescription": "note this can be reversed at any time by snapping/tagging changes and deleting the component.json file \nyou can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
790
+ "description": "create component.json configuration files for components",
791
+ "extendedDescription": "generates component.json files containing component-specific configuration that overrides workspace defaults.\nuseful for customizing individual component settings. alternatively, use commands like \"bit env set\", \"bit deps set\", or \"bit aspect set\".\ncan be reversed by deleting the component.json file and snapping/tagging the changes.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit eject-conf \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
792
792
  "group": "component-config",
793
793
  "private": false
794
794
  },
@@ -802,8 +802,8 @@
802
802
  "json format"
803
803
  ]
804
804
  ],
805
- "description": "manage capsules",
806
- "extendedDescription": "a capsule is a directory containing the component code, isolated from the workspace.\nnormally, capsules are created during the build process, the component files are copied and the packages are installed\nvia the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for\nother users after publishing/exporting them.",
805
+ "description": "manage isolated component environments",
806
+ "extendedDescription": "capsules are temporary isolated directories containing component code and dependencies.\nautomatically created during build processes to compile and test components in isolation.\nensures components work independently before publishing, similar to how they'll be consumed.",
807
807
  "group": "advanced",
808
808
  "private": false,
809
809
  "commands": [
@@ -941,7 +941,7 @@
941
941
  "return the output as JSON"
942
942
  ]
943
943
  ],
944
- "description": "list the component ids matching the given pattern",
944
+ "description": "test and validate component patterns",
945
945
  "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",
946
946
  "group": "info-analysis",
947
947
  "private": false,
@@ -972,8 +972,8 @@
972
972
  "name": "local-only <sub-command>",
973
973
  "alias": "",
974
974
  "options": [],
975
- "description": "manage local-only components, which reside only in the workspace and are not snapped/tagged",
976
- "extendedDescription": "",
975
+ "description": "manage components that exist only in the workspace",
976
+ "extendedDescription": "controls components that are excluded from versioning (snap/tag) and exporting operations.\nlocal-only components are useful for workspace-specific tools, configs, or temporary components.\nthese components remain in the workspace but won't be shared or versioned.",
977
977
  "group": "component-config",
978
978
  "private": false,
979
979
  "commands": [
@@ -1058,8 +1058,8 @@
1058
1058
  "filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '*/ui')"
1059
1059
  ]
1060
1060
  ],
1061
- "description": "list components on a workspace or a remote scope (with flag).",
1062
- "extendedDescription": "",
1061
+ "description": "display components in workspace or remote scope",
1062
+ "extendedDescription": "shows components in the current workspace by default, or from a specified remote scope.\nsupports filtering by scope, namespace, and various display options.\nuse --outdated to highlight components that have newer versions available.",
1063
1063
  "group": "info-analysis",
1064
1064
  "private": false,
1065
1065
  "remoteOp": true,
@@ -1069,8 +1069,8 @@
1069
1069
  "name": "ws-config <sub-command>",
1070
1070
  "alias": "workspace-config",
1071
1071
  "options": [],
1072
- "description": "manage workspace config files",
1073
- "extendedDescription": "",
1072
+ "description": "generate IDE configuration files",
1073
+ "extendedDescription": "writes configuration files (tsconfig.json, eslintrc.js, etc.) to your workspace for better IDE support.\nautomatically generates configs based on your components' environments and settings.\nuseful for enabling proper IntelliSense, linting, and type-checking in your IDE.",
1074
1074
  "group": "workspace-tools",
1075
1075
  "private": false,
1076
1076
  "commands": [
@@ -1186,8 +1186,8 @@
1186
1186
  "enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
1187
1187
  ]
1188
1188
  ],
1189
- "description": "deprecate a component",
1190
- "extendedDescription": "",
1189
+ "description": "mark a component as deprecated to discourage its use",
1190
+ "extendedDescription": "marks a component as deprecated locally, then after snap/tag and export it becomes deprecated in the remote scope.\noptionally specify a replacement component or deprecate only specific version ranges.\ndeprecated components remain available but display warnings when installed or imported.",
1191
1191
  "group": "collaborate",
1192
1192
  "private": false,
1193
1193
  "remoteOp": true,
@@ -1203,8 +1203,8 @@
1203
1203
  "name": "undeprecate <id>",
1204
1204
  "alias": "",
1205
1205
  "options": [],
1206
- "description": "undeprecate a deprecated component (local/remote)",
1207
- "extendedDescription": "",
1206
+ "description": "remove the deprecation status from a component",
1207
+ "extendedDescription": "reverses the deprecation of a component, removing warnings and allowing normal use again.",
1208
1208
  "group": "collaborate",
1209
1209
  "private": false,
1210
1210
  "remoteOp": true,
@@ -1214,8 +1214,8 @@
1214
1214
  "name": "git <sub-command>",
1215
1215
  "alias": "",
1216
1216
  "options": [],
1217
- "description": "perform git operations",
1218
- "extendedDescription": "",
1217
+ "description": "Git utilities for Bit repositories",
1218
+ "extendedDescription": "provides specialized Git utilities for handling Bit-specific files and conflicts.\nincludes tools for setting up merge drivers for bitmap files and resolving conflicts during Git merges.\nessential for properly handling Bit's internal files when working with Git repositories.",
1219
1219
  "group": "workspace-tools",
1220
1220
  "private": false,
1221
1221
  "commands": [
@@ -1285,8 +1285,8 @@
1285
1285
  "output as json format"
1286
1286
  ]
1287
1287
  ],
1288
- "description": "track one or more directories as new components",
1289
- "extendedDescription": "Learn the recommended workflow for tracking directories as components, in the link below.",
1288
+ "description": "track existing directory contents as new components in the workspace",
1289
+ "extendedDescription": "Registers one or more directories as Bit components without changing your files. Each provided path becomes a component root tracked by Bit.",
1290
1290
  "group": "component-development",
1291
1291
  "private": false
1292
1292
  },
@@ -1330,8 +1330,8 @@
1330
1330
  "replace existing files at the target location"
1331
1331
  ]
1332
1332
  ],
1333
- "description": "create a new component (source files and config) using a template.",
1334
- "extendedDescription": "",
1333
+ "description": "scaffold new component(s) from a template (sources, config, and env)",
1334
+ "extendedDescription": "Generates one or more components from a chosen template with ready-to-use source files, configuration, and environment. Use it to quickly scaffold consistent components across your workspace. Run 'bit templates' to discover available templates.",
1335
1335
  "group": "component-development",
1336
1336
  "private": false,
1337
1337
  "arguments": [
@@ -1383,8 +1383,8 @@
1383
1383
  "return templates in json format"
1384
1384
  ]
1385
1385
  ],
1386
- "description": "list available templates for \"bit create\" and \"bit new\"",
1387
- "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
1386
+ "description": "list available templates for creating components and workspaces",
1387
+ "extendedDescription": "Lists available templates. Inside a workspace it shows component templates for 'bit create'; outside a workspace it shows workspace templates for 'bit new'.",
1388
1388
  "group": "component-development",
1389
1389
  "private": false
1390
1390
  },
@@ -1438,8 +1438,8 @@
1438
1438
  "create the new workspace in current directory (default is to create a new directory, inside the current dir)"
1439
1439
  ]
1440
1440
  ],
1441
- "description": "create a new workspace from a template",
1442
- "extendedDescription": "",
1441
+ "description": "create a new Bit workspace from a template",
1442
+ "extendedDescription": "initializes a new Bit workspace with pre-configured settings, environments, and optionally starter components.\ntemplates provide different setups for React, Angular, Node.js, or custom development workflows.\ninstalls dependencies and configures the workspace for immediate development.",
1443
1443
  "group": "workspace-setup",
1444
1444
  "private": false,
1445
1445
  "arguments": [
@@ -1493,8 +1493,8 @@
1493
1493
  "trigger recompilation of the specified component regardless of what changed. helpful when this comp-id must be a bundle"
1494
1494
  ]
1495
1495
  ],
1496
- "description": "automatically recompile modified components (on save)",
1497
- "extendedDescription": "by default, the watcher doesn't use polling, to keep the CPU idle.\nif this doesn't work well for you, run \"bit config set watch_use_polling true\" to use polling.",
1496
+ "description": "watch and compile components on file changes",
1497
+ "extendedDescription": "monitors component files for changes and automatically recompiles them using their environment's configured compiler.\nenables immediate feedback during development by keeping components compiled as you work.\nby default uses file system events (not polling) to minimize CPU usage - enable polling with \"bit config set watch_use_polling true\" if needed.",
1498
1498
  "group": "component-development",
1499
1499
  "private": false
1500
1500
  },
@@ -1583,8 +1583,8 @@
1583
1583
  "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
1584
1584
  ]
1585
1585
  ],
1586
- "description": "run set of tasks for build.",
1587
- "extendedDescription": "by default, only new and modified components are built.\nthe build takes place in an isolated directories on the filesystem (called \"capsules\"). the component files are copied to these directories\nand the package-manager installs the dependencies in the capsules root. once done, the build pipeline is running.\nbecause this process can take a while on a large workspace, some flags are available to shorten the process. See the example section for more info.\n ",
1586
+ "description": "run build pipeline tasks in isolated environments",
1587
+ "extendedDescription": "executes the complete build pipeline including compilation, testing, linting, and other tasks defined by component environments.\nthe build takes place in isolated directories called \"capsules\" where component files are copied and dependencies are installed via the package manager.\nby default processes only new and modified components - use --unmodified to build all components.\nbecause this process can take a while on large workspaces, various flags are available to optimize the process - see examples for debugging workflows.",
1588
1588
  "group": "component-development",
1589
1589
  "private": false,
1590
1590
  "arguments": [
@@ -1629,8 +1629,8 @@
1629
1629
  "download the files to the specified dir"
1630
1630
  ]
1631
1631
  ],
1632
- "description": "list and download component artifacts",
1633
- "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
1632
+ "description": "view and download build artifacts",
1633
+ "extendedDescription": "displays artifacts created during the build pipeline in isolated capsules during tag or snap operations.\nartifacts include compiled files, test reports, package files, and other build outputs generated by various tasks.\nuse --out-dir to download artifacts locally for inspection or deployment purposes.",
1634
1634
  "group": "testing",
1635
1635
  "private": false,
1636
1636
  "arguments": [
@@ -1675,8 +1675,8 @@
1675
1675
  "the arguments passing to the app. for example, --args=\"--a=1 --b\". don't forget to use quotes to wrap the value to escape special characters."
1676
1676
  ]
1677
1677
  ],
1678
- "description": "locally run an app component (independent of bit's dev server)",
1679
- "extendedDescription": "",
1678
+ "description": "start an application component locally",
1679
+ "extendedDescription": "runs application components in their own development server, separate from the \"bit start\" UI.\napps are components that create deployable applications (React apps, Node.js servers, etc.).\nwhen no app name is specified, automatically detects and runs the app if only one exists in the workspace.",
1680
1680
  "group": "run-serve",
1681
1681
  "private": false,
1682
1682
  "arguments": [
@@ -1690,8 +1690,8 @@
1690
1690
  "name": "app [sub-command]",
1691
1691
  "alias": "apps",
1692
1692
  "options": [],
1693
- "description": "Manages apps",
1694
- "extendedDescription": "",
1693
+ "description": "manage application components",
1694
+ "extendedDescription": "applications are components that create deployable, runnable applications like React apps or Node.js servers.\nlist available apps in the workspace and inspect their configurations.\nuse \"bit run\" to start an application locally.",
1695
1695
  "group": "run-serve",
1696
1696
  "private": false,
1697
1697
  "commands": [
@@ -1745,8 +1745,8 @@
1745
1745
  "the arguments passing to the app. for example, --args=\"--a=1 --b\". don't forget to use quotes to wrap the value to escape special characters."
1746
1746
  ]
1747
1747
  ],
1748
- "description": "locally run an app component (independent of bit's dev server)",
1749
- "extendedDescription": "",
1748
+ "description": "start an application component locally",
1749
+ "extendedDescription": "runs application components in their own development server, separate from the \"bit start\" UI.\napps are components that create deployable applications (React apps, Node.js servers, etc.).\nwhen no app name is specified, automatically detects and runs the app if only one exists in the workspace.",
1750
1750
  "group": "run-serve",
1751
1751
  "private": false,
1752
1752
  "arguments": [
@@ -1788,8 +1788,8 @@
1788
1788
  "EXPERIMENTAL. generate d.ts files for typescript components (hurts performance)"
1789
1789
  ]
1790
1790
  ],
1791
- "description": "compile components in the workspace",
1792
- "extendedDescription": "",
1791
+ "description": "transpile component source files",
1792
+ "extendedDescription": "compiles TypeScript, JSX, and other source files into JavaScript using the compiler configured by each component's environment.\noutputs compiled files to node_modules/component-package-name/dist for consumption by other components.\nautomatically triggered by \"bit watch\", \"bit start\", or IDE extensions, but can be run manually for debugging.",
1793
1793
  "group": "component-development",
1794
1794
  "private": false,
1795
1795
  "arguments": [
@@ -1874,8 +1874,8 @@
1874
1874
  "dependencies are not written to node_modules. Only the lockfile is updated"
1875
1875
  ]
1876
1876
  ],
1877
- "description": "installs workspace dependencies",
1878
- "extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
1877
+ "description": "install workspace dependencies",
1878
+ "extendedDescription": "installs workspace dependencies and prepares the workspace for development.\nwhen packages are specified, adds them to workspace.jsonc policy and installs. when no packages specified, installs existing dependencies.\nautomatically imports components, compiles components, links to node_modules, and writes config files.",
1879
1879
  "group": "dependencies",
1880
1880
  "private": false,
1881
1881
  "arguments": [
@@ -1889,10 +1889,16 @@
1889
1889
  "name": "uninstall [packages...]",
1890
1890
  "alias": "un",
1891
1891
  "options": [],
1892
- "description": "uninstall dependencies",
1893
- "extendedDescription": "",
1892
+ "description": "remove dependencies from workspace",
1893
+ "extendedDescription": "removes specified packages from workspace.jsonc dependency policy and runs install to update node_modules.",
1894
1894
  "group": "dependencies",
1895
- "private": false
1895
+ "private": false,
1896
+ "arguments": [
1897
+ {
1898
+ "name": "packages...",
1899
+ "description": "list of package names to remove from workspace dependencies"
1900
+ }
1901
+ ]
1896
1902
  },
1897
1903
  {
1898
1904
  "name": "update [package-patterns...]",
@@ -1924,8 +1930,8 @@
1924
1930
  "update to the newest version respecting semver"
1925
1931
  ]
1926
1932
  ],
1927
- "description": "update dependencies. By default, dependencies are updated to the highest semver compatible versions.",
1928
- "extendedDescription": "",
1933
+ "description": "update workspace dependencies to newer versions",
1934
+ "extendedDescription": "updates dependencies in workspace.jsonc to newer versions and runs install to apply changes.\nby default, updates to highest semver-compatible versions. use --major, --minor, or --patch for specific version types.\nsupports glob patterns to update specific packages. prompts for confirmation unless --yes is specified.",
1929
1935
  "group": "dependencies",
1930
1936
  "private": false,
1931
1937
  "arguments": [
@@ -1975,8 +1981,8 @@
1975
1981
  "show only a summary of component links instead of listing all components"
1976
1982
  ]
1977
1983
  ],
1978
- "description": "create links in the node_modules directory, to core aspects and to components in the workspace",
1979
- "extendedDescription": "",
1984
+ "description": "create links between components and node_modules",
1985
+ "extendedDescription": "creates links in node_modules for workspace components and core aspects, enabling import resolution.\nautomatically links all workspace components and Bit's core aspects to their respective package names.\nuseful for development when components need to reference each other or when debugging linking issues.",
1980
1986
  "group": "dependencies",
1981
1987
  "private": false,
1982
1988
  "arguments": [
@@ -1990,8 +1996,8 @@
1990
1996
  "name": "move <current-component-dir> <new-component-dir>",
1991
1997
  "alias": "mv",
1992
1998
  "options": [],
1993
- "description": "move a component to a different filesystem path",
1994
- "extendedDescription": "(note: this does NOT affect the component's name or scope, just its location in the workspace)",
1999
+ "description": "relocate a component to a different directory",
2000
+ "extendedDescription": "moves component files to a new location within the workspace and updates the .bitmap tracking.\nonly changes the filesystem location - does not affect the component's name, scope, or ID.\nuseful for reorganizing workspace structure or following new directory conventions.",
1995
2001
  "group": "component-development",
1996
2002
  "private": false,
1997
2003
  "arguments": [
@@ -2125,8 +2131,8 @@
2125
2131
  "when using wildcards on a lane, only import components that exist on the lane (never from main)"
2126
2132
  ]
2127
2133
  ],
2128
- "description": "import components from their remote scopes to the local workspace",
2129
- "extendedDescription": "",
2134
+ "description": "bring components from remote scopes into your workspace",
2135
+ "extendedDescription": "brings component source files from remote scopes into your workspace and installs their dependencies as packages.\nsupports pattern matching for bulk imports, merge strategies for handling conflicts, and various optimization options.\nwithout arguments, fetches all workspace components' latest versions from their remote scopes.",
2130
2136
  "group": "collaborate",
2131
2137
  "private": false,
2132
2138
  "remoteOp": true,
@@ -2197,8 +2203,8 @@
2197
2203
  "skip confirmation"
2198
2204
  ]
2199
2205
  ],
2200
- "description": "remove component(s) from the local workspace",
2201
- "extendedDescription": "to mark components as deleted on the remote scope, use \"bit delete\".",
2206
+ "description": "untrack components from the workspace",
2207
+ "extendedDescription": "removes components from the local workspace only - stops tracking them in .bitmap and deletes their files by default.\ndoes not affect remote scopes - to delete components from remotes, use \"bit delete\" instead.\nuse --keep-files to preserve component files while only removing the tracking.",
2202
2208
  "group": "component-development",
2203
2209
  "private": false,
2204
2210
  "remoteOp": true,
@@ -2256,8 +2262,8 @@
2256
2262
  "comma-separated list of snap hashes to mark as deleted (e.g. --snaps \"hash1,hash2,hash3\")"
2257
2263
  ]
2258
2264
  ],
2259
- "description": "mark components as deleted on the remote",
2260
- "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.\nunless the '--hard' flag is used (not recommended!), in which case, the component will be deleted from the remote scope immediately.\n",
2265
+ "description": "soft-delete components from remote scopes",
2266
+ "extendedDescription": "marks components as deleted so they won't be visible on remote scopes after export.\ncomponents remain recoverable using \"bit recover\" unless --hard is used (permanent deletion, not recommended).\nto remove components from your local workspace only, use \"bit remove\" instead.",
2261
2267
  "group": "collaborate",
2262
2268
  "private": false,
2263
2269
  "remoteOp": true,
@@ -2284,8 +2290,8 @@
2284
2290
  "do not write config files (such as eslint, tsconfig, prettier, etc...)"
2285
2291
  ]
2286
2292
  ],
2287
- "description": "recover component(s) soft-deleted from the workspace, or a remote scope",
2288
- "extendedDescription": "",
2293
+ "description": "restore soft-deleted components",
2294
+ "extendedDescription": "reverses the soft-deletion of components marked with \"bit delete\", restoring them to their previous state. works for both local and remote soft-deleted components.",
2289
2295
  "group": "collaborate",
2290
2296
  "private": false
2291
2297
  },
@@ -2340,7 +2346,7 @@
2340
2346
  ]
2341
2347
  ],
2342
2348
  "description": "switch between component versions or remove local changes",
2343
- "extendedDescription": "\n`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout head~x [component-pattern]` => go backward x generations from the head and checkout to that version\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
2349
+ "extendedDescription": "checkout components to specified versions or remove local changes. most commonly used as 'bit checkout head' to get latest versions.\nthe `<to>` argument accepts these values:\n- head: checkout to last snap/tag (most common usage)\n- specific version: checkout to exact version (e.g. 'bit checkout 1.0.5 component-name')\n- head~x: go back x generations from head (e.g. 'head~2' for two versions back)\n- latest: checkout to latest semver tag\n- reset: remove local modifications and restore original files (also restores deleted component directories)\nwhen on lanes, 'checkout head' only affects lane components. to update main components, run 'bit lane merge main'.",
2344
2350
  "group": "version-control",
2345
2351
  "private": false,
2346
2352
  "arguments": [
@@ -2369,8 +2375,8 @@
2369
2375
  "do not install packages of the imported components"
2370
2376
  ]
2371
2377
  ],
2372
- "description": "replace the current component files by the specified version, leave the version intact",
2373
- "extendedDescription": "",
2378
+ "description": "replace component files with specified version while preserving current version",
2379
+ "extendedDescription": "replaces component source files with files from the specified version but keeps the current component version.\nuseful for reverting file changes without changing the component's version history. different from checkout which changes the version.",
2374
2380
  "group": "version-control",
2375
2381
  "private": false,
2376
2382
  "arguments": [
@@ -2409,8 +2415,8 @@
2409
2415
  "keep the component files in the workspace intact"
2410
2416
  ]
2411
2417
  ],
2412
- "description": "remove component from the workspace and install it instead as a regular npm package.",
2413
- "extendedDescription": "By default the component files will be removed from the workspace",
2418
+ "description": "remove component from workspace and install it as npm package",
2419
+ "extendedDescription": "converts workspace components to external npm packages by removing them from .bitmap and installing via package manager.\nby default removes component files from workspace. use --keep-files to preserve source code while converting to package dependency.\nuseful for components that no longer need active development in current workspace.",
2414
2420
  "group": "dependencies",
2415
2421
  "private": false,
2416
2422
  "arguments": [
@@ -2490,8 +2496,8 @@
2490
2496
  "show output in json format"
2491
2497
  ]
2492
2498
  ],
2493
- "description": "export components from the workspace to remote scopes",
2494
- "extendedDescription": "bit export => export all staged snaps/tags of components to their remote scope. if checked out to a lane, export the lane as well\n `bit export [pattern...]` => export components included by the pattern to their remote scope (we recommend not using a pattern in\n most scenarios so that all changes are exported simultaneously)\n you can use a pattern for multiple ids, such as bit export \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
2499
+ "description": "upload components to remote scopes",
2500
+ "extendedDescription": "uploads staged versions (snaps/tags) to remote scopes, making them available for consumption by other workspaces.\nwithout arguments, exports all staged components. when on a lane, exports the lane as well.\nexporting is the final step after development and versioning to share components with your team.",
2495
2501
  "group": "collaborate",
2496
2502
  "private": false,
2497
2503
  "remoteOp": true,
@@ -2506,8 +2512,8 @@
2506
2512
  "name": "deps <sub-command>",
2507
2513
  "alias": "dependencies",
2508
2514
  "options": [],
2509
- "description": "manage dependencies",
2510
- "extendedDescription": "",
2515
+ "description": "manage component dependencies",
2516
+ "extendedDescription": "configure and analyze component dependencies with sub-commands for setting, removing, and inspecting dependency relationships.",
2511
2517
  "group": "dependencies",
2512
2518
  "private": false,
2513
2519
  "commands": [
@@ -2703,7 +2709,7 @@
2703
2709
  ]
2704
2710
  ],
2705
2711
  "description": "find components that use the specified dependency",
2706
- "extendedDescription": "",
2712
+ "extendedDescription": "searches workspace components to find which ones depend on the specified package or component.\nuseful for understanding dependency usage before removing packages or when refactoring components.\nsupports both exact version matching and package name patterns.",
2707
2713
  "group": "dependencies",
2708
2714
  "private": false,
2709
2715
  "arguments": [
@@ -2742,7 +2748,7 @@
2742
2748
  ]
2743
2749
  ],
2744
2750
  "description": "find components that use the specified dependency",
2745
- "extendedDescription": "",
2751
+ "extendedDescription": "searches workspace components to find which ones depend on the specified package or component.\nuseful for understanding dependency usage before removing packages or when refactoring components.\nsupports both exact version matching and package name patterns.",
2746
2752
  "group": "dependencies",
2747
2753
  "private": false,
2748
2754
  "arguments": [
@@ -2756,8 +2762,8 @@
2756
2762
  "name": "set-peer <component-id> <range>",
2757
2763
  "alias": "",
2758
2764
  "options": [],
2759
- "description": "set a component as always peer",
2760
- "extendedDescription": "",
2765
+ "description": "configure component to always be installed as peer dependency",
2766
+ "extendedDescription": "marks a component to always be treated as a peer dependency when used by other components.\nuseful for shared libraries that should be provided by the consuming application.\nthe specified version range will be used when adding this component as a peer dependency.",
2761
2767
  "group": "dependencies",
2762
2768
  "private": false,
2763
2769
  "arguments": [
@@ -2767,7 +2773,7 @@
2767
2773
  },
2768
2774
  {
2769
2775
  "name": "range",
2770
- "description": "the default range to use for the componnent, when added to peerDependencies"
2776
+ "description": "the default range to use for the component, when added to peerDependencies"
2771
2777
  }
2772
2778
  ]
2773
2779
  },
@@ -2775,8 +2781,8 @@
2775
2781
  "name": "unset-peer <component-id>",
2776
2782
  "alias": "",
2777
2783
  "options": [],
2778
- "description": "unset a component as always peer",
2779
- "extendedDescription": "",
2784
+ "description": "remove always-peer configuration from component",
2785
+ "extendedDescription": "removes the always-peer marking from a component, allowing it to be installed as a regular dependency.\nreverses the effect of 'bit set-peer' command. the component will be treated normally in dependency resolution.",
2780
2786
  "group": "dependencies",
2781
2787
  "private": false,
2782
2788
  "arguments": [
@@ -2796,8 +2802,8 @@
2796
2802
  "return the dependents in JSON format"
2797
2803
  ]
2798
2804
  ],
2799
- "description": "show dependents of the given component",
2800
- "extendedDescription": "",
2805
+ "description": "show components that depend on the specified component",
2806
+ "extendedDescription": "displays components from both workspace and scope that depend on the specified component.\nuseful for understanding impact before making changes to a component or when planning refactoring.\nshows both direct and transitive dependents organized by their origin (workspace vs scope).",
2801
2807
  "group": "dependencies",
2802
2808
  "private": false,
2803
2809
  "arguments": [
@@ -2952,8 +2958,8 @@
2952
2958
  "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
2953
2959
  ]
2954
2960
  ],
2955
- "description": "create an immutable and exportable component snapshot, tagged with a release version.",
2956
- "extendedDescription": "if no patterns are provided, it will tag all new and modified components.\nif patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
2961
+ "description": "create immutable component snapshots with semantic version tags",
2962
+ "extendedDescription": "creates tagged versions using semantic versioning (semver) for component releases. tags are immutable and exportable.\nby default tags all new and modified components. supports version specification per pattern using \"@\" (e.g. foo@1.0.0, bar@minor).\nuse for official releases. for development versions, use 'bit snap' instead.",
2957
2963
  "group": "version-control",
2958
2964
  "private": false,
2959
2965
  "remoteOp": true,
@@ -3050,8 +3056,8 @@
3050
3056
  "UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head"
3051
3057
  ]
3052
3058
  ],
3053
- "description": "create an immutable and exportable component snapshot (non-release version)",
3054
- "extendedDescription": "",
3059
+ "description": "create immutable component snapshots for development versions",
3060
+ "extendedDescription": "creates snapshots with hash-based versions for development and testing. snapshots are immutable and exportable.\nby default snaps only new and modified components. use for development iterations before creating semantic version tags.\nsnapshots maintain component history and enable collaboration without formal releases.",
3055
3061
  "group": "version-control",
3056
3062
  "private": false,
3057
3063
  "arguments": [
@@ -3091,8 +3097,8 @@
3091
3097
  "reset only components that were never exported"
3092
3098
  ]
3093
3099
  ],
3094
- "description": "revert tagged or snapped versions for component(s)",
3095
- "extendedDescription": "https://bit.dev/components/tags#undoing-a-tag",
3100
+ "description": "revert local tags and snaps to previous versions",
3101
+ "extendedDescription": "removes local component versions (tags/snaps) that haven't been exported yet.\nby default reverts all local versions. use --head to revert only the latest version.\nuseful for undoing mistakes before exporting. exported versions cannot be reset.",
3096
3102
  "group": "version-control",
3097
3103
  "private": false,
3098
3104
  "arguments": [
@@ -3166,8 +3172,8 @@
3166
3172
  "return the results in json format"
3167
3173
  ]
3168
3174
  ],
3169
- "description": "test components in the workspace. by default only runs tests for new and modified components",
3170
- "extendedDescription": "",
3175
+ "description": "run component tests",
3176
+ "extendedDescription": "executes tests using the testing framework configured by each component's environment (Jest, Mocha, etc.).\nby default only runs tests for new and modified components. use --unmodified to test all components.\nsupports watch mode, coverage reporting, and debug mode for development workflows.",
3171
3177
  "group": "testing",
3172
3178
  "private": false,
3173
3179
  "arguments": [
@@ -3197,8 +3203,8 @@
3197
3203
  "show tables instead of plain text for dependencies diff"
3198
3204
  ]
3199
3205
  ],
3200
- "description": "show the diff between the components' current source files and config, and their latest snapshot or tag",
3201
- "extendedDescription": "",
3206
+ "description": "compare component changes between versions or against the current workspace",
3207
+ "extendedDescription": "shows a detailed diff of component files, dependencies, and configuration changes. \nby default, compares workspace changes against the latest version. specify versions to compare historical changes.\nsupports pattern matching to filter components and various output formats for better readability.",
3202
3208
  "group": "info-analysis",
3203
3209
  "private": false,
3204
3210
  "arguments": [
@@ -3302,8 +3308,8 @@
3302
3308
  "override the default message for the auto snap"
3303
3309
  ]
3304
3310
  ],
3305
- "description": "merge changes of the remote head into local - auto-snaps all merged components",
3306
- "extendedDescription": "merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local\nand creates snaps for merged components that have diverged, on the lane.\nif no ids are specified, all pending-merge components will be merged. (run \"bit status\" to list them).\noptionally use '--abort' to revert the last merge. to revert a lane merge, use \"bit lane merge-abort\" command.",
3311
+ "description": "merge diverged component history when local and remote have different versions",
3312
+ "extendedDescription": "resolves diverged component history when both local and remote have created different snaps/tags from the same base version.\nif no component pattern is specified, all pending-merge components will be merged (run 'bit status' to list them).\n'bit status' will show diverged components and suggest either merging or resetting local changes.\npreferred approach: use 'bit reset' to remove local versions, then 'bit checkout head' to get remote versions.\nfor lane-to-lane merging, use 'bit lane merge' instead.",
3307
3313
  "group": "version-control",
3308
3314
  "private": false,
3309
3315
  "arguments": [
@@ -3343,8 +3349,8 @@
3343
3349
  "list only lanes that haven't been merged"
3344
3350
  ]
3345
3351
  ],
3346
- "description": "manage lanes - if no sub-command is used, runs \"bit lane list\"",
3347
- "extendedDescription": "",
3352
+ "description": "manage lanes for parallel development",
3353
+ "extendedDescription": "lanes allow isolated development of features without affecting main branch components.\ncreate, switch between, and merge lanes to coordinate parallel work across teams.\nwithout a sub-command, lists all available lanes.",
3348
3354
  "group": "collaborate",
3349
3355
  "private": false,
3350
3356
  "remoteOp": true,
@@ -4128,8 +4134,8 @@
4128
4134
  "do not check for circular dependencies to get the results quicker"
4129
4135
  ]
4130
4136
  ],
4131
- "description": "present the current status of components in the workspace, including indication of detected issues",
4132
- "extendedDescription": "",
4137
+ "description": "show workspace component status and issues",
4138
+ "extendedDescription": "displays the current state of all workspace components including new, modified, staged, and problematic components.\nidentifies blocking issues that prevent tagging/snapping and provides warnings with --warnings flag.\nessential for understanding workspace health before versioning components.",
4133
4139
  "group": "info-analysis",
4134
4140
  "private": false
4135
4141
  },
@@ -4168,8 +4174,8 @@
4168
4174
  "name": "ci <sub-command>",
4169
4175
  "alias": "",
4170
4176
  "options": [],
4171
- "description": "CI commands",
4172
- "extendedDescription": "",
4177
+ "description": "continuous integration commands for automated workflows",
4178
+ "extendedDescription": "provides commands designed for use in CI/CD pipelines with Git workflows to automate component development tasks like verification, pull request handling, and deployment preparation.",
4173
4179
  "group": "collaborate",
4174
4180
  "private": false,
4175
4181
  "commands": [
@@ -4319,8 +4325,8 @@
4319
4325
  "For non-Bit workspaces that only consume Bit component packages. Enables only \"schema\", \"show\", and \"remote_search\" tools"
4320
4326
  ]
4321
4327
  ],
4322
- "description": "Start the Bit CLI Model Context Protocol (MCP) server for programmatic and remote access to Bit commands.",
4323
- "extendedDescription": "",
4328
+ "description": "start Model Context Protocol server for AI assistants",
4329
+ "extendedDescription": "enables AI assistants and other tools to interact with Bit via the Model Context Protocol.\nprovides a standardized interface for AI agents to execute Bit commands and access component information.\nallows writing custom instructions and rules to guide AI agents in their interactions with Bit.",
4324
4330
  "group": "advanced",
4325
4331
  "private": false,
4326
4332
  "commands": [
@@ -4458,8 +4464,8 @@
4458
4464
  "relevant for --archive. exclude .bit or .git/bit from the archive file"
4459
4465
  ]
4460
4466
  ],
4461
- "description": "diagnose a bit workspace",
4462
- "extendedDescription": "",
4467
+ "description": "diagnose and troubleshoot workspace issues",
4468
+ "extendedDescription": "runs comprehensive health checks on your workspace to detect and report configuration problems, \nmissing dependencies, corrupted data, and other issues that may affect workspace functionality.\ncan generate diagnostic reports and workspace archives for debugging and support purposes.",
4463
4469
  "group": "system",
4464
4470
  "private": false
4465
4471
  },
@@ -4548,8 +4554,8 @@
4548
4554
  "skip interactive mode for Git repositories"
4549
4555
  ]
4550
4556
  ],
4551
- "description": "create or reinitialize an empty workspace",
4552
- "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
4557
+ "description": "initialize a Bit workspace in an existing project",
4558
+ "extendedDescription": "creates Bit configuration files in an existing project directory to start tracking components.\nif already a workspace, validates and repairs Bit files as needed.\nsupports various reset options to recover from corrupted state or restart from scratch.",
4553
4559
  "group": "workspace-setup",
4554
4560
  "private": false,
4555
4561
  "skipWorkspace": true
@@ -4558,10 +4564,10 @@
4558
4564
  "name": "version-history <sub-command>",
4559
4565
  "alias": "vh",
4560
4566
  "options": [],
4561
- "description": "manage the version-history of components",
4562
- "extendedDescription": "",
4567
+ "description": "manage component version history data structures",
4568
+ "extendedDescription": "tools for building and maintaining the internal version history data that tracks component evolution and relationships.\nincludes commands to rebuild corrupted version history, generate visual graphs, and inspect version relationships.\nmainly used for debugging and repair purposes when version history data becomes corrupted.",
4563
4569
  "group": "version-control",
4564
- "private": false,
4570
+ "private": true,
4565
4571
  "commands": [
4566
4572
  {
4567
4573
  "name": "graph <component-id>",
@@ -4595,8 +4601,8 @@
4595
4601
  ],
4596
4602
  "description": "generate a graph of the version history of a component and save as an SVG file",
4597
4603
  "extendedDescription": "",
4598
- "group": "info-analysis",
4599
- "private": false
4604
+ "group": "version-control",
4605
+ "private": true
4600
4606
  },
4601
4607
  {
4602
4608
  "name": "show <component-id>",
@@ -4615,8 +4621,8 @@
4615
4621
  ],
4616
4622
  "description": "show the version-history of a component",
4617
4623
  "extendedDescription": "",
4618
- "group": "info-analysis",
4619
- "private": false
4624
+ "group": "version-control",
4625
+ "private": true
4620
4626
  },
4621
4627
  {
4622
4628
  "name": "build <component-pattern>",
@@ -4645,8 +4651,8 @@
4645
4651
  ],
4646
4652
  "description": "rebuild the version history of a component. helpful when it got corrupted for some reason",
4647
4653
  "extendedDescription": "",
4648
- "group": "info-analysis",
4649
- "private": false,
4654
+ "group": "version-control",
4655
+ "private": true,
4650
4656
  "arguments": [
4651
4657
  {
4652
4658
  "name": "component-pattern",
@@ -4686,8 +4692,8 @@
4686
4692
  "message to be attached to the stashed components"
4687
4693
  ]
4688
4694
  ],
4689
- "description": "stash modified components",
4690
- "extendedDescription": "",
4695
+ "description": "temporarily save and restore component changes",
4696
+ "extendedDescription": "temporarily stores modified component files without creating versions.\nallows saving work-in-progress changes and switching context, then restoring changes later.",
4691
4697
  "group": "version-control",
4692
4698
  "private": false,
4693
4699
  "commands": [
@@ -4772,8 +4778,8 @@
4772
4778
  "return the component schema in json format"
4773
4779
  ]
4774
4780
  ],
4775
- "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
4776
- "extendedDescription": "Extracts TypeScript definitions to provide a comprehensive view of a component's public API.\nShows detailed information about exported elements including classes, interfaces, functions, types, and enums with their respective signatures and documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
4781
+ "description": "display component API schema and type definitions",
4782
+ "extendedDescription": "extracts and displays the public API structure of components including types, functions, classes, and interfaces.\nshows detailed type information, function signatures, and JSDoc documentation for exported elements.\nuseful for understanding component interfaces and generating documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
4777
4783
  "group": "info-analysis",
4778
4784
  "private": false
4779
4785
  },
@@ -4817,8 +4823,8 @@
4817
4823
  "json format"
4818
4824
  ]
4819
4825
  ],
4820
- "description": "show components(s) version history",
4821
- "extendedDescription": "",
4826
+ "description": "display component version history",
4827
+ "extendedDescription": "shows chronological history of component versions including tags and snaps with metadata.\ndisplays commit messages, authors, dates, and version information. supports both local and remote component logs.\nuse various format options for compact or detailed views of version history.",
4822
4828
  "group": "version-control",
4823
4829
  "private": false,
4824
4830
  "remoteOp": true,
@@ -4840,8 +4846,8 @@
4840
4846
  "show each log entry in one line"
4841
4847
  ]
4842
4848
  ],
4843
- "description": "EXPERIMENTAL. show file history",
4844
- "extendedDescription": "",
4849
+ "description": "EXPERIMENTAL. display history of changes to a specific file",
4850
+ "extendedDescription": "shows version history for a specific file within component versions.\ntracks file-level changes across component snaps and tags.\ndisplays file modifications, hashes, and associated commit information.",
4845
4851
  "group": "version-control",
4846
4852
  "private": false,
4847
4853
  "arguments": [
@@ -4861,8 +4867,8 @@
4861
4867
  "show the commit message"
4862
4868
  ]
4863
4869
  ],
4864
- "description": "EXPERIMENTAL. per line, show who and when was the last to modify it",
4865
- "extendedDescription": "",
4870
+ "description": "EXPERIMENTAL. show line-by-line authorship and modification history",
4871
+ "extendedDescription": "displays who last modified each line of a file and when the change was made.\ntracks line-level changes across component versions.\nshows author, date, version hash, and optionally commit messages for each line.",
4866
4872
  "group": "version-control",
4867
4873
  "private": false,
4868
4874
  "arguments": [
@@ -4962,8 +4968,8 @@
4962
4968
  "name": "refactor <sub-command>",
4963
4969
  "alias": "",
4964
4970
  "options": [],
4965
- "description": "source code refactoring / codemod",
4966
- "extendedDescription": "",
4971
+ "description": "automatically refactor component source code",
4972
+ "extendedDescription": "performs automated code transformations and refactoring operations across components.\ncurrently supports updating import/require statements when component names or dependencies change.\nuseful for maintaining code consistency after renaming or restructuring components.",
4967
4973
  "group": "workspace-tools",
4968
4974
  "private": false,
4969
4975
  "commands": [
@@ -5023,8 +5029,8 @@
5023
5029
  "DEPRECATE. use --no-browser instead"
5024
5030
  ]
5025
5031
  ],
5026
- "description": "log in to Bit cloud",
5027
- "extendedDescription": "",
5032
+ "description": "authenticate with Bit Cloud for component publishing and collaboration",
5033
+ "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.",
5028
5034
  "group": "auth",
5029
5035
  "private": false,
5030
5036
  "remoteOp": true,
@@ -5034,8 +5040,8 @@
5034
5040
  "name": "logout",
5035
5041
  "alias": "",
5036
5042
  "options": [],
5037
- "description": "log the CLI out of Bit",
5038
- "extendedDescription": "",
5043
+ "description": "sign out of Bit Cloud and clear authentication tokens",
5044
+ "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.",
5039
5045
  "group": "auth",
5040
5046
  "private": false,
5041
5047
  "skipWorkspace": true
@@ -5044,8 +5050,8 @@
5044
5050
  "name": "whoami",
5045
5051
  "alias": "",
5046
5052
  "options": [],
5047
- "description": "display the currently logged in user",
5048
- "extendedDescription": "",
5053
+ "description": "display the currently authenticated Bit Cloud user",
5054
+ "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.",
5049
5055
  "group": "auth",
5050
5056
  "private": false,
5051
5057
  "skipWorkspace": true
@@ -5054,8 +5060,8 @@
5054
5060
  "name": "npmrc [sub-command]",
5055
5061
  "alias": "",
5056
5062
  "options": [],
5057
- "description": "manage npmrc file with scope, registry, and token information from bit.cloud",
5058
- "extendedDescription": "",
5063
+ "description": "configure .npmrc file with Bit Cloud registry and authentication settings",
5064
+ "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.",
5059
5065
  "group": "auth",
5060
5066
  "private": false,
5061
5067
  "skipWorkspace": true,
@@ -5093,8 +5099,8 @@
5093
5099
  "clear memory cache from a remote scope"
5094
5100
  ]
5095
5101
  ],
5096
- "description": "clears Bit's cache from current working machine",
5097
- "extendedDescription": "The following gets removed by this command:\n1) components cache on the filesystem (mainly the dependencies graph and docs)\n2) scope's index file, which maps the component-id:object-hash",
5102
+ "description": "remove cached data to resolve stale data issues",
5103
+ "extendedDescription": "clears various caches that Bit uses to improve performance. useful when experiencing stale data issues or\nunexpected behavior. this command removes:\n1) components cache on the filesystem (mainly the dependencies graph and docs)\n2) scope's index file, which maps the component-id:object-hash\n\nnote: this cache has minimal impact on disk space. to free significant disk space, use \"bit capsule delete --all\" to remove build capsules.",
5098
5104
  "group": "system",
5099
5105
  "private": false,
5100
5106
  "skipWorkspace": true
@@ -5139,8 +5145,8 @@
5139
5145
  "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value"
5140
5146
  ]
5141
5147
  ],
5142
- "description": "rename component. if exported, create a new component and delete the original component. otherwise just renames current component",
5143
- "extendedDescription": "",
5148
+ "description": "change a component name",
5149
+ "extendedDescription": "renames a component and optionally refactors dependent code to use the new name.\nfor exported components: creates a new component with the new name and marks the original as deleted.\nfor local components: simply renames the existing component in place.",
5144
5150
  "group": "component-development",
5145
5151
  "private": false,
5146
5152
  "remoteOp": true,
@@ -5206,8 +5212,8 @@
5206
5212
  "use ast to transform files instead of regex"
5207
5213
  ]
5208
5214
  ],
5209
- "description": "create a new component forked from an existing one (copies source files and configs)",
5210
- "extendedDescription": "",
5215
+ "description": "create a new component by copying from an existing one",
5216
+ "extendedDescription": "duplicates an existing component's source files and configuration to create a new independent component.\nuseful for creating variations or starting development from a similar component.\nautomatically handles import/require statement updates and provides refactoring options.",
5211
5217
  "group": "collaborate",
5212
5218
  "private": false,
5213
5219
  "remoteOp": true,
@@ -5243,8 +5249,8 @@
5243
5249
  "return the output in json format"
5244
5250
  ]
5245
5251
  ],
5246
- "description": "check typescript types",
5247
- "extendedDescription": "",
5252
+ "description": "validate TypeScript type correctness",
5253
+ "extendedDescription": "checks for TypeScript type errors in component files, similar to running tsc.\nby default only checks new and modified components. use --all to check all components.\nuseful for catching type issues before tagging, snapping or building components.",
5248
5254
  "group": "testing",
5249
5255
  "private": false,
5250
5256
  "arguments": [
@@ -5258,8 +5264,8 @@
5258
5264
  "name": "aspect <sub-command>",
5259
5265
  "alias": "",
5260
5266
  "options": [],
5261
- "description": "manage aspects",
5262
- "extendedDescription": "",
5267
+ "description": "manage component aspects and their configurations",
5268
+ "extendedDescription": "aspects provide functionality and tools for components throughout their development lifecycle.\nprimarily useful for inspecting aspect assignments and configurations with \"bit aspect get\".\nrarely used for manual aspect management as most aspects are configured automatically.",
5263
5269
  "group": "component-config",
5264
5270
  "private": false,
5265
5271
  "commands": [
@@ -5466,8 +5472,8 @@
5466
5472
  "return the format results in json format"
5467
5473
  ]
5468
5474
  ],
5469
- "description": "format components in the development workspace",
5470
- "extendedDescription": "",
5475
+ "description": "auto-format component source code",
5476
+ "extendedDescription": "formats component files using the formatter configured by each component's environment (Prettier, etc.).\nby default formats all components. use --changed to format only new and modified components.\nsupports check mode to verify formatting without making changes.",
5471
5477
  "group": "testing",
5472
5478
  "private": false,
5473
5479
  "arguments": [
@@ -5502,8 +5508,8 @@
5502
5508
  "return the lint results in json format"
5503
5509
  ]
5504
5510
  ],
5505
- "description": "lint components in the development workspace",
5506
- "extendedDescription": "",
5511
+ "description": "analyze component code for issues and style violations",
5512
+ "extendedDescription": "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.\nby default lints all components. use --changed to lint only new and modified components.\nsupports automatic fixing of certain issues with --fix flag.",
5507
5513
  "group": "testing",
5508
5514
  "private": false,
5509
5515
  "arguments": [