@teambit/harmony.content.cli-reference 1.95.161 → 1.95.163

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.
@@ -1,12 +1,5 @@
1
1
  ---
2
- description: 'An MDX component.'
3
- labels: ['content', 'mdx']
2
+ description: 'Bit command synopses. Bit version: 0.1.82'
3
+ labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
-
6
- import { CliReference } from './index';
7
-
8
- ### Component usage
9
-
10
- ```js
11
- <CliReference />
12
- ```
5
+
@@ -622,6 +622,11 @@
622
622
  "metadata",
623
623
  "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands"
624
624
  ],
625
+ [
626
+ "",
627
+ "docs",
628
+ "generate the cli-reference.docs.mdx file"
629
+ ],
625
630
  [
626
631
  "j",
627
632
  "json",
@@ -1226,6 +1231,41 @@
1226
1231
  }
1227
1232
  ]
1228
1233
  },
1234
+ {
1235
+ "name": "git <sub-command>",
1236
+ "alias": "",
1237
+ "options": [],
1238
+ "description": "perform git operations",
1239
+ "extendedDescription": "",
1240
+ "group": "git",
1241
+ "private": false,
1242
+ "commands": [
1243
+ {
1244
+ "name": "set-merge-driver",
1245
+ "alias": "smd",
1246
+ "options": [
1247
+ [
1248
+ "g",
1249
+ "global",
1250
+ "set the git merge driver globally"
1251
+ ]
1252
+ ],
1253
+ "description": "setup bit's git merge driver for bitmap files",
1254
+ "extendedDescription": "",
1255
+ "group": "git",
1256
+ "private": false
1257
+ },
1258
+ {
1259
+ "name": "merge-bitmaps <ancestor> <current> <other>",
1260
+ "alias": "",
1261
+ "options": [],
1262
+ "description": "a special command to merge conflicting bitmap files during git merge",
1263
+ "extendedDescription": "",
1264
+ "group": "git",
1265
+ "private": true
1266
+ }
1267
+ ]
1268
+ },
1229
1269
  {
1230
1270
  "name": "watch",
1231
1271
  "alias": "",
@@ -1933,6 +1973,11 @@
1933
1973
  "",
1934
1974
  "track-only",
1935
1975
  "do not write any file, just create .bitmap entries of the imported components"
1976
+ ],
1977
+ [
1978
+ "",
1979
+ "include-deprecated",
1980
+ "when importing with patterns, include deprecated components (default to exclude them)"
1936
1981
  ]
1937
1982
  ],
1938
1983
  "description": "import components from their remote scopes to the local workspace",
@@ -4250,6 +4295,11 @@
4250
4295
  "skip-dependency-installation",
4251
4296
  "do not install packages of the imported components"
4252
4297
  ],
4298
+ [
4299
+ "e",
4300
+ "env <string>",
4301
+ "set the environment for the new component"
4302
+ ],
4253
4303
  [
4254
4304
  "",
4255
4305
  "skip-config",
package/cli-reference.mdx CHANGED
@@ -287,6 +287,7 @@ The following gets removed by this command:
287
287
  | **Option** | **Option alias** | **Description** |
288
288
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
289
289
  | `--metadata` | | metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands |
290
+ | `--docs` | | generate the cli-reference.docs.mdx file |
290
291
  | `--json` | `-j` | output the commands info as JSON |
291
292
 
292
293
  ---
@@ -616,6 +617,7 @@ bit export => export all staged components to their current scope, if checked ou
616
617
  | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
617
618
  | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
618
619
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
620
+ | `--env <string>` | `-e` | set the environment for the new component |
619
621
  | `--skip-config` | | do not copy the config (aspects-config) to the new component. helpful when it fails during aspect loading |
620
622
  | `--preserve` | | avoid renaming files and variables/classes according to the new component name |
621
623
  | `--no-link` | | avoid saving a reference to the original component |
@@ -636,6 +638,30 @@ bit export => export all staged components to their current scope, if checked ou
636
638
 
637
639
  ---
638
640
 
641
+ ## git
642
+
643
+ **Description**: perform git operations
644
+
645
+ `bit git <sub-command>`
646
+
647
+ ### git set-merge-driver
648
+
649
+ **Usage**: `git set-merge-driver`
650
+
651
+ **Description**: setup bit's git merge driver for bitmap files
652
+
653
+ | **Option** | **Option alias** | **Description** |
654
+ | ---------- | :--------------: | --------------------------------- |
655
+ | `--global` | `-g` | set the git merge driver globally |
656
+
657
+ ### git merge-bitmaps
658
+
659
+ **Usage**: `git merge-bitmaps <ancestor> <current> <other>`
660
+
661
+ **Description**: a special command to merge conflicting bitmap files during git merge
662
+
663
+ ---
664
+
639
665
  ## globals
640
666
 
641
667
  **Description**: list all globals
@@ -699,6 +725,7 @@ bit export => export all staged components to their current scope, if checked ou
699
725
  | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
700
726
  | `--fetch-deps` | | fetch dependencies objects |
701
727
  | `--track-only` | | do not write any file, just create .bitmap entries of the imported components |
728
+ | `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
702
729
 
703
730
  ---
704
731
 
@@ -1,12 +1,5 @@
1
1
  ---
2
- description: 'An MDX component.'
3
- labels: ['content', 'mdx']
2
+ description: 'Bit command synopses. Bit version: 0.1.82'
3
+ labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
-
6
- import { CliReference } from './index';
7
-
8
- ### Component usage
9
-
10
- ```js
11
- <CliReference />
12
- ```
5
+
@@ -622,6 +622,11 @@
622
622
  "metadata",
623
623
  "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands"
624
624
  ],
625
+ [
626
+ "",
627
+ "docs",
628
+ "generate the cli-reference.docs.mdx file"
629
+ ],
625
630
  [
626
631
  "j",
627
632
  "json",
@@ -1226,6 +1231,41 @@
1226
1231
  }
1227
1232
  ]
1228
1233
  },
1234
+ {
1235
+ "name": "git <sub-command>",
1236
+ "alias": "",
1237
+ "options": [],
1238
+ "description": "perform git operations",
1239
+ "extendedDescription": "",
1240
+ "group": "git",
1241
+ "private": false,
1242
+ "commands": [
1243
+ {
1244
+ "name": "set-merge-driver",
1245
+ "alias": "smd",
1246
+ "options": [
1247
+ [
1248
+ "g",
1249
+ "global",
1250
+ "set the git merge driver globally"
1251
+ ]
1252
+ ],
1253
+ "description": "setup bit's git merge driver for bitmap files",
1254
+ "extendedDescription": "",
1255
+ "group": "git",
1256
+ "private": false
1257
+ },
1258
+ {
1259
+ "name": "merge-bitmaps <ancestor> <current> <other>",
1260
+ "alias": "",
1261
+ "options": [],
1262
+ "description": "a special command to merge conflicting bitmap files during git merge",
1263
+ "extendedDescription": "",
1264
+ "group": "git",
1265
+ "private": true
1266
+ }
1267
+ ]
1268
+ },
1229
1269
  {
1230
1270
  "name": "watch",
1231
1271
  "alias": "",
@@ -1933,6 +1973,11 @@
1933
1973
  "",
1934
1974
  "track-only",
1935
1975
  "do not write any file, just create .bitmap entries of the imported components"
1976
+ ],
1977
+ [
1978
+ "",
1979
+ "include-deprecated",
1980
+ "when importing with patterns, include deprecated components (default to exclude them)"
1936
1981
  ]
1937
1982
  ],
1938
1983
  "description": "import components from their remote scopes to the local workspace",
@@ -4250,6 +4295,11 @@
4250
4295
  "skip-dependency-installation",
4251
4296
  "do not install packages of the imported components"
4252
4297
  ],
4298
+ [
4299
+ "e",
4300
+ "env <string>",
4301
+ "set the environment for the new component"
4302
+ ],
4253
4303
  [
4254
4304
  "",
4255
4305
  "skip-config",
@@ -1341,6 +1341,19 @@ function MDXContent(_ref) {
1341
1341
  "align": null
1342
1342
  }, (0, _react2.mdx)("inlineCode", {
1343
1343
  parentName: "td"
1344
+ }, "--docs")), (0, _react2.mdx)("td", {
1345
+ parentName: "tr",
1346
+ "align": "center"
1347
+ }), (0, _react2.mdx)("td", {
1348
+ parentName: "tr",
1349
+ "align": null
1350
+ }, "generate the cli-reference.docs.mdx file")), (0, _react2.mdx)("tr", {
1351
+ parentName: "tbody"
1352
+ }, (0, _react2.mdx)("td", {
1353
+ parentName: "tr",
1354
+ "align": null
1355
+ }, (0, _react2.mdx)("inlineCode", {
1356
+ parentName: "td"
1344
1357
  }, "--json")), (0, _react2.mdx)("td", {
1345
1358
  parentName: "tr",
1346
1359
  "align": "center"
@@ -2510,6 +2523,21 @@ function MDXContent(_ref) {
2510
2523
  "align": null
2511
2524
  }, (0, _react2.mdx)("inlineCode", {
2512
2525
  parentName: "td"
2526
+ }, "--env <string>")), (0, _react2.mdx)("td", {
2527
+ parentName: "tr",
2528
+ "align": "center"
2529
+ }, (0, _react2.mdx)("inlineCode", {
2530
+ parentName: "td"
2531
+ }, "-e")), (0, _react2.mdx)("td", {
2532
+ parentName: "tr",
2533
+ "align": null
2534
+ }, "set the environment for the new component")), (0, _react2.mdx)("tr", {
2535
+ parentName: "tbody"
2536
+ }, (0, _react2.mdx)("td", {
2537
+ parentName: "tr",
2538
+ "align": null
2539
+ }, (0, _react2.mdx)("inlineCode", {
2540
+ parentName: "td"
2513
2541
  }, "--skip-config")), (0, _react2.mdx)("td", {
2514
2542
  parentName: "tr",
2515
2543
  "align": "center"
@@ -2610,7 +2638,59 @@ function MDXContent(_ref) {
2610
2638
  }, "-j")), (0, _react2.mdx)("td", {
2611
2639
  parentName: "tr",
2612
2640
  "align": null
2613
- }, "return the format results in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "globals"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2641
+ }, "return the format results in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "git"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2642
+ parentName: "p"
2643
+ }, "Description"), ": perform git operations"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2644
+ parentName: "p"
2645
+ }, "bit git <sub-command>")), (0, _react2.mdx)("h3", null, "git set-merge-driver"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2646
+ parentName: "p"
2647
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2648
+ parentName: "p"
2649
+ }, "git set-merge-driver")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2650
+ parentName: "p"
2651
+ }, "Description"), ": setup bit's git merge driver for bitmap files"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2652
+ parentName: "table"
2653
+ }, (0, _react2.mdx)("tr", {
2654
+ parentName: "thead"
2655
+ }, (0, _react2.mdx)("th", {
2656
+ parentName: "tr",
2657
+ "align": null
2658
+ }, (0, _react2.mdx)("strong", {
2659
+ parentName: "th"
2660
+ }, "Option")), (0, _react2.mdx)("th", {
2661
+ parentName: "tr",
2662
+ "align": "center"
2663
+ }, (0, _react2.mdx)("strong", {
2664
+ parentName: "th"
2665
+ }, "Option alias")), (0, _react2.mdx)("th", {
2666
+ parentName: "tr",
2667
+ "align": null
2668
+ }, (0, _react2.mdx)("strong", {
2669
+ parentName: "th"
2670
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2671
+ parentName: "table"
2672
+ }, (0, _react2.mdx)("tr", {
2673
+ parentName: "tbody"
2674
+ }, (0, _react2.mdx)("td", {
2675
+ parentName: "tr",
2676
+ "align": null
2677
+ }, (0, _react2.mdx)("inlineCode", {
2678
+ parentName: "td"
2679
+ }, "--global")), (0, _react2.mdx)("td", {
2680
+ parentName: "tr",
2681
+ "align": "center"
2682
+ }, (0, _react2.mdx)("inlineCode", {
2683
+ parentName: "td"
2684
+ }, "-g")), (0, _react2.mdx)("td", {
2685
+ parentName: "tr",
2686
+ "align": null
2687
+ }, "set the git merge driver globally")))), (0, _react2.mdx)("h3", null, "git merge-bitmaps"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2688
+ parentName: "p"
2689
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2690
+ parentName: "p"
2691
+ }, "git merge-bitmaps <ancestor> <current> <other>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2692
+ parentName: "p"
2693
+ }, "Description"), ": a special command to merge conflicting bitmap files during git merge"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "globals"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2614
2694
  parentName: "p"
2615
2695
  }, "Description"), ": list all globals"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2616
2696
  parentName: "p"
@@ -3013,7 +3093,20 @@ function MDXContent(_ref) {
3013
3093
  }), (0, _react2.mdx)("td", {
3014
3094
  parentName: "tr",
3015
3095
  "align": null
3016
- }, "do not write any file, just create .bitmap entries of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "init"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
3096
+ }, "do not write any file, just create .bitmap entries of the imported components")), (0, _react2.mdx)("tr", {
3097
+ parentName: "tbody"
3098
+ }, (0, _react2.mdx)("td", {
3099
+ parentName: "tr",
3100
+ "align": null
3101
+ }, (0, _react2.mdx)("inlineCode", {
3102
+ parentName: "td"
3103
+ }, "--include-deprecated")), (0, _react2.mdx)("td", {
3104
+ parentName: "tr",
3105
+ "align": "center"
3106
+ }), (0, _react2.mdx)("td", {
3107
+ parentName: "tr",
3108
+ "align": null
3109
+ }, "when importing with patterns, include deprecated components (default to exclude them)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "init"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
3017
3110
  parentName: "p"
3018
3111
  }, "Description"), ": create or reinitialize an empty workspace", (0, _react2.mdx)("br", {
3019
3112
  parentName: "p"