@teambit/harmony.content.cli-reference 2.0.635 → 2.0.637

package/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 1.10.8'
+description: 'Bit command synopses. Bit version: 1.10.10'
 labels: ['cli', 'mdx', 'docs']
 ---

package/cli-reference.json

@@ -4878,14 +4878,19 @@
     "name": "schema <pattern>",
     "alias": "",
     "options": [
+      [
+        "r",
+        "remote",
+        "fetch schema from remote scope (works for components not in workspace)"
+      ],
       [
         "j",
         "json",
         "return the component schema in json format"
       ]
     ],
-    "description": "shows the API schema of the specified component/s.",
-    "extendedDescription": "you 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",
+    "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
+    "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",
     "group": "development",
     "private": false
   },

package/cli-reference.mdx

@@ -1900,7 +1900,10 @@ https://bit.dev/components/tags#undoing-a-tag
 
 ## schema
 
-**Description**: shows the API schema of the specified component/s.  
+**Description**: extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.  
+Extracts TypeScript definitions to provide a comprehensive view of a component's public API.  
+Shows detailed information about exported elements including classes, interfaces, functions, types, and enums with their respective signatures and documentation.
+
 you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.  
 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'.  
@@ -1909,9 +1912,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 `bit schema <pattern>`
 
-| **Option** | **Option alias** | **Description**                            |
-| ---------- | :--------------: | ------------------------------------------ |
-| `--json`   |       `-j`       | return the component schema in json format |
+| **Option** | **Option alias** | **Description**                                                        |
+| ---------- | :--------------: | ---------------------------------------------------------------------- |
+| `--remote` |       `-r`       | fetch schema from remote scope (works for components not in workspace) |
+| `--json`   |       `-j`       | return the component schema in json format                             |
 
 ---
 

package/dist/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 1.10.8'
+description: 'Bit command synopses. Bit version: 1.10.10'
 labels: ['cli', 'mdx', 'docs']
 ---

package/dist/cli-reference.json

@@ -4878,14 +4878,19 @@
         "name": "schema <pattern>",
         "alias": "",
         "options": [
+            [
+                "r",
+                "remote",
+                "fetch schema from remote scope (works for components not in workspace)"
+            ],
             [
                 "j",
                 "json",
                 "return the component schema in json format"
             ]
         ],
-        "description": "shows the API schema of the specified component/s.",
-        "extendedDescription": "you 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",
+        "description": "extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.",
+        "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",
         "group": "development",
         "private": false
     },

package/dist/cli-reference.mdx.js

@@ -10097,9 +10097,11 @@ function MDXContent(_ref) {
     "align": null
   }, "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.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "schema"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": shows the API schema of the specified component/s.", (0, _react2.mdx)("br", {
+  }, "Description"), ": extracts and displays the API schema (types, functions, classes, interfaces) of the specified component/s.", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
+  }), "\n", "Extracts TypeScript definitions to provide a comprehensive view of a component's public API.", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "Shows detailed information about exported elements including classes, interfaces, functions, types, and enums with their respective signatures and documentation."), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -10145,6 +10147,21 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
+  }, "--remote")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-r")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "fetch schema from remote scope (works for components not in workspace)")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
   }, "--json")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"