@teambit/harmony.content.cli-reference 2.0.644 → 2.0.646

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.
Files changed (9) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +126 -23
  3. package/cli-reference.mdx +47 -1
  4. package/dist/cli-reference.docs.mdx +1 -1
  5. package/dist/cli-reference.json +126 -23
  6. package/dist/cli-reference.mdx.js +290 -2
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/{preview-1748575149030.js → preview-1749007248643.js} +2 -2
  9. package/package.json +2 -2
package/cli-reference.docs.mdx CHANGED
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.11.6'
2
+ description: 'Bit command synopses. Bit version: 1.11.8'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
package/cli-reference.json CHANGED
@@ -75,7 +75,7 @@
75
75
  "private": false
76
76
  },
77
77
  {
78
- "name": "mcp-server",
78
+ "name": "mcp-server [sub-command]",
79
79
  "alias": "",
80
80
  "options": [
81
81
  [
@@ -112,7 +112,95 @@
112
112
  "description": "Start the Bit CLI Model Context Protocol (MCP) server for programmatic and remote access to Bit commands.",
113
113
  "extendedDescription": "",
114
114
  "group": "advanced",
115
- "private": false
115
+ "private": false,
116
+ "commands": [
117
+ {
118
+ "name": "start",
119
+ "alias": "",
120
+ "options": [
121
+ [
122
+ "e",
123
+ "extended",
124
+ "Enable the full set of Bit CLI commands as MCP tools"
125
+ ],
126
+ [
127
+ "",
128
+ "include-only <commands>",
129
+ "Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes, e.g. \"status,install,compile\""
130
+ ],
131
+ [
132
+ "",
133
+ "include-additional <commands>",
134
+ "Add specific commands to the default MCP tools set. Use comma-separated list in quotes. Only applies when --extended is not used"
135
+ ],
136
+ [
137
+ "",
138
+ "exclude <commands>",
139
+ "Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes"
140
+ ],
141
+ [
142
+ "",
143
+ "bit-bin <binary>",
144
+ "Specify the binary to use for running Bit commands (default: \"bit\")"
145
+ ],
146
+ [
147
+ "",
148
+ "consumer-project",
149
+ "For non-Bit workspaces that only consume Bit component packages. Enables only \"schema\", \"show\", and \"remote_search\" tools"
150
+ ]
151
+ ],
152
+ "description": "Start the MCP server",
153
+ "extendedDescription": "Start the Model Context Protocol (MCP) server with the specified configuration",
154
+ "group": "advanced",
155
+ "private": false
156
+ },
157
+ {
158
+ "name": "setup [editor]",
159
+ "alias": "",
160
+ "options": [
161
+ [
162
+ "e",
163
+ "extended",
164
+ "Enable the full set of Bit CLI commands as MCP tools"
165
+ ],
166
+ [
167
+ "",
168
+ "consumer-project",
169
+ "Configure for non-Bit workspaces that only consume Bit component packages"
170
+ ],
171
+ [
172
+ "",
173
+ "include-only <commands>",
174
+ "Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes"
175
+ ],
176
+ [
177
+ "",
178
+ "include-additional <commands>",
179
+ "Add specific commands to the default MCP tools set. Use comma-separated list in quotes"
180
+ ],
181
+ [
182
+ "",
183
+ "exclude <commands>",
184
+ "Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes"
185
+ ],
186
+ [
187
+ "g",
188
+ "global",
189
+ "Setup global configuration (default: workspace-specific)"
190
+ ]
191
+ ],
192
+ "description": "Setup MCP integration with VS Code, Cursor, Windsurf, or other editors",
193
+ "extendedDescription": "Creates or updates configuration files to integrate Bit MCP server with supported editors. Currently supports VS Code, Cursor, and Windsurf.",
194
+ "group": "ungrouped",
195
+ "private": false,
196
+ "arguments": [
197
+ {
198
+ "name": "editor",
199
+ "description": "Editor to setup (default: vscode). Available: vscode, cursor, windsurf"
200
+ }
201
+ ]
202
+ }
203
+ ]
116
204
  },
117
205
  {
118
206
  "name": "config",
@@ -601,6 +689,21 @@
601
689
  "extendedDescription": "",
602
690
  "group": "ungrouped",
603
691
  "private": false
692
+ },
693
+ {
694
+ "name": "list",
695
+ "alias": "",
696
+ "options": [
697
+ [
698
+ "g",
699
+ "global",
700
+ "see globally configured remotes"
701
+ ]
702
+ ],
703
+ "description": "list all configured remotes",
704
+ "extendedDescription": "",
705
+ "group": "collaborate",
706
+ "private": false
604
707
  }
605
708
  ]
606
709
  },
@@ -2407,7 +2510,7 @@
2407
2510
  ],
2408
2511
  "description": "fetch remote objects and store locally",
2409
2512
  "extendedDescription": "for lanes, use \"/\" as a separator between the remote and the lane name, e.g. teambit.ui/fix-button",
2410
- "group": "ungrouped",
2513
+ "group": "collaborate",
2411
2514
  "private": true
2412
2515
  },
2413
2516
  {
@@ -3420,6 +3523,26 @@
3420
3523
  }
3421
3524
  ]
3422
3525
  },
3526
+ {
3527
+ "name": "schema <pattern>",
3528
+ "alias": "",
3529
+ "options": [
3530
+ [
3531
+ "r",
3532
+ "remote",
3533
+ "fetch schema from remote scope (works for components not in workspace)"
3534
+ ],
3535
+ [
3536
+ "j",
3537
+ "json",
3538
+ "return the component schema in json format"
3539
+ ]
3540
+ ],
3541
+ "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
3542
+ "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",
3543
+ "group": "info-analysis",
3544
+ "private": false
3545
+ },
3423
3546
  {
3424
3547
  "name": "test [component-pattern]",
3425
3548
  "alias": "at",
@@ -4894,26 +5017,6 @@
4894
5017
  }
4895
5018
  ]
4896
5019
  },
4897
- {
4898
- "name": "schema <pattern>",
4899
- "alias": "",
4900
- "options": [
4901
- [
4902
- "r",
4903
- "remote",
4904
- "fetch schema from remote scope (works for components not in workspace)"
4905
- ],
4906
- [
4907
- "j",
4908
- "json",
4909
- "return the component schema in json format"
4910
- ]
4911
- ],
4912
- "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
4913
- "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",
4914
- "group": "info-analysis",
4915
- "private": false
4916
- },
4917
5020
  {
4918
5021
  "name": "check-types [component-pattern]",
4919
5022
  "alias": "",
package/cli-reference.mdx CHANGED
@@ -1588,7 +1588,43 @@ this command does the following:
1588
1588
 
1589
1589
  **Description**: Start the Bit CLI Model Context Protocol (MCP) server for programmatic and remote access to Bit commands.
1590
1590
 
1591
- `bit mcp-server`
1591
+ `bit mcp-server [sub-command]`
1592
+
1593
+ ### mcp-server start
1594
+
1595
+ **Usage**: `mcp-server start`
1596
+
1597
+ **Description**: Start the MCP server
1598
+ Start the Model Context Protocol (MCP) server with the specified configuration
1599
+
1600
+ | **Option** | **Option alias** | **Description** |
1601
+ | --------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
1602
+ | `--extended` | `-e` | Enable the full set of Bit CLI commands as MCP tools |
1603
+ | `--include-only <commands>` | | Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes, e.g. "status,install,compile" |
1604
+ | `--include-additional <commands>` | | Add specific commands to the default MCP tools set. Use comma-separated list in quotes. Only applies when --extended is not used |
1605
+ | `--exclude <commands>` | | Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes |
1606
+ | `--bit-bin <binary>` | | Specify the binary to use for running Bit commands (default: "bit") |
1607
+ | `--consumer-project` | | For non-Bit workspaces that only consume Bit component packages. Enables only "schema", "show", and "remote_search" tools |
1608
+
1609
+ ### mcp-server setup
1610
+
1611
+ **Usage**: `mcp-server setup [editor]`
1612
+
1613
+ **Description**: Setup MCP integration with VS Code, Cursor, Windsurf, or other editors
1614
+ Creates or updates configuration files to integrate Bit MCP server with supported editors. Currently supports VS Code, Cursor, and Windsurf.
1615
+
1616
+ | **Arg** | **Description** |
1617
+ | -------- | :--------------------------------------------------------------------: |
1618
+ | `editor` | Editor to setup (default: vscode). Available: vscode, cursor, windsurf |
1619
+
1620
+ | **Option** | **Option alias** | **Description** |
1621
+ | --------------------------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1622
+ | `--extended` | `-e` | Enable the full set of Bit CLI commands as MCP tools |
1623
+ | `--consumer-project` | | Configure for non-Bit workspaces that only consume Bit component packages |
1624
+ | `--include-only <commands>` | | Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes |
1625
+ | `--include-additional <commands>` | | Add specific commands to the default MCP tools set. Use comma-separated list in quotes |
1626
+ | `--exclude <commands>` | | Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes |
1627
+ | `--global` | `-g` | Setup global configuration (default: workspace-specific) |
1592
1628
 
1593
1629
  | **Option** | **Option alias** | **Description** |
1594
1630
  | --------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
@@ -1771,6 +1807,16 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1771
1807
  | ---------- | :--------------: | ----------------------------------------- |
1772
1808
  | `--global` | `-g` | remove a globally configured remote scope |
1773
1809
 
1810
+ ### remote list
1811
+
1812
+ **Usage**: `remote list`
1813
+
1814
+ **Description**: list all configured remotes
1815
+
1816
+ | **Option** | **Option alias** | **Description** |
1817
+ | ---------- | :--------------: | ------------------------------- |
1818
+ | `--global` | `-g` | see globally configured remotes |
1819
+
1774
1820
  | **Option** | **Option alias** | **Description** |
1775
1821
  | ---------- | :--------------: | ------------------------------- |
1776
1822
  | `--global` | `-g` | see globally configured remotes |
package/dist/cli-reference.docs.mdx CHANGED
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.11.6'
2
+ description: 'Bit command synopses. Bit version: 1.11.8'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
package/dist/cli-reference.json CHANGED
@@ -75,7 +75,7 @@
75
75
  "private": false
76
76
  },
77
77
  {
78
- "name": "mcp-server",
78
+ "name": "mcp-server [sub-command]",
79
79
  "alias": "",
80
80
  "options": [
81
81
  [
@@ -112,7 +112,95 @@
112
112
  "description": "Start the Bit CLI Model Context Protocol (MCP) server for programmatic and remote access to Bit commands.",
113
113
  "extendedDescription": "",
114
114
  "group": "advanced",
115
- "private": false
115
+ "private": false,
116
+ "commands": [
117
+ {
118
+ "name": "start",
119
+ "alias": "",
120
+ "options": [
121
+ [
122
+ "e",
123
+ "extended",
124
+ "Enable the full set of Bit CLI commands as MCP tools"
125
+ ],
126
+ [
127
+ "",
128
+ "include-only <commands>",
129
+ "Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes, e.g. \"status,install,compile\""
130
+ ],
131
+ [
132
+ "",
133
+ "include-additional <commands>",
134
+ "Add specific commands to the default MCP tools set. Use comma-separated list in quotes. Only applies when --extended is not used"
135
+ ],
136
+ [
137
+ "",
138
+ "exclude <commands>",
139
+ "Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes"
140
+ ],
141
+ [
142
+ "",
143
+ "bit-bin <binary>",
144
+ "Specify the binary to use for running Bit commands (default: \"bit\")"
145
+ ],
146
+ [
147
+ "",
148
+ "consumer-project",
149
+ "For non-Bit workspaces that only consume Bit component packages. Enables only \"schema\", \"show\", and \"remote_search\" tools"
150
+ ]
151
+ ],
152
+ "description": "Start the MCP server",
153
+ "extendedDescription": "Start the Model Context Protocol (MCP) server with the specified configuration",
154
+ "group": "advanced",
155
+ "private": false
156
+ },
157
+ {
158
+ "name": "setup [editor]",
159
+ "alias": "",
160
+ "options": [
161
+ [
162
+ "e",
163
+ "extended",
164
+ "Enable the full set of Bit CLI commands as MCP tools"
165
+ ],
166
+ [
167
+ "",
168
+ "consumer-project",
169
+ "Configure for non-Bit workspaces that only consume Bit component packages"
170
+ ],
171
+ [
172
+ "",
173
+ "include-only <commands>",
174
+ "Specify a subset of commands to expose as MCP tools. Use comma-separated list in quotes"
175
+ ],
176
+ [
177
+ "",
178
+ "include-additional <commands>",
179
+ "Add specific commands to the default MCP tools set. Use comma-separated list in quotes"
180
+ ],
181
+ [
182
+ "",
183
+ "exclude <commands>",
184
+ "Prevent specific commands from being exposed as MCP tools. Use comma-separated list in quotes"
185
+ ],
186
+ [
187
+ "g",
188
+ "global",
189
+ "Setup global configuration (default: workspace-specific)"
190
+ ]
191
+ ],
192
+ "description": "Setup MCP integration with VS Code, Cursor, Windsurf, or other editors",
193
+ "extendedDescription": "Creates or updates configuration files to integrate Bit MCP server with supported editors. Currently supports VS Code, Cursor, and Windsurf.",
194
+ "group": "ungrouped",
195
+ "private": false,
196
+ "arguments": [
197
+ {
198
+ "name": "editor",
199
+ "description": "Editor to setup (default: vscode). Available: vscode, cursor, windsurf"
200
+ }
201
+ ]
202
+ }
203
+ ]
116
204
  },
117
205
  {
118
206
  "name": "config",
@@ -601,6 +689,21 @@
601
689
  "extendedDescription": "",
602
690
  "group": "ungrouped",
603
691
  "private": false
692
+ },
693
+ {
694
+ "name": "list",
695
+ "alias": "",
696
+ "options": [
697
+ [
698
+ "g",
699
+ "global",
700
+ "see globally configured remotes"
701
+ ]
702
+ ],
703
+ "description": "list all configured remotes",
704
+ "extendedDescription": "",
705
+ "group": "collaborate",
706
+ "private": false
604
707
  }
605
708
  ]
606
709
  },
@@ -2407,7 +2510,7 @@
2407
2510
  ],
2408
2511
  "description": "fetch remote objects and store locally",
2409
2512
  "extendedDescription": "for lanes, use \"/\" as a separator between the remote and the lane name, e.g. teambit.ui/fix-button",
2410
- "group": "ungrouped",
2513
+ "group": "collaborate",
2411
2514
  "private": true
2412
2515
  },
2413
2516
  {
@@ -3420,6 +3523,26 @@
3420
3523
  }
3421
3524
  ]
3422
3525
  },
3526
+ {
3527
+ "name": "schema <pattern>",
3528
+ "alias": "",
3529
+ "options": [
3530
+ [
3531
+ "r",
3532
+ "remote",
3533
+ "fetch schema from remote scope (works for components not in workspace)"
3534
+ ],
3535
+ [
3536
+ "j",
3537
+ "json",
3538
+ "return the component schema in json format"
3539
+ ]
3540
+ ],
3541
+ "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
3542
+ "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",
3543
+ "group": "info-analysis",
3544
+ "private": false
3545
+ },
3423
3546
  {
3424
3547
  "name": "test [component-pattern]",
3425
3548
  "alias": "at",
@@ -4894,26 +5017,6 @@
4894
5017
  }
4895
5018
  ]
4896
5019
  },
4897
- {
4898
- "name": "schema <pattern>",
4899
- "alias": "",
4900
- "options": [
4901
- [
4902
- "r",
4903
- "remote",
4904
- "fetch schema from remote scope (works for components not in workspace)"
4905
- ],
4906
- [
4907
- "j",
4908
- "json",
4909
- "return the component schema in json format"
4910
- ]
4911
- ],
4912
- "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
4913
- "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",
4914
- "group": "info-analysis",
4915
- "private": false
4916
- },
4917
5020
  {
4918
5021
  "name": "check-types [component-pattern]",
4919
5022
  "alias": "",