@teambit/harmony.content.cli-reference 2.0.766 → 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.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +171 -165
- package/cli-reference.mdx +303 -198
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +171 -165
- package/dist/cli-reference.mdx.js +503 -494
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1757437404844.js → preview-1757523924602.js} +2 -2
- package/package.json +2 -2
|
@@ -43,9 +43,9 @@ function MDXContent(_ref) {
|
|
|
43
43
|
parentName: "p"
|
|
44
44
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
45
45
|
parentName: "p"
|
|
46
|
-
}, "Description"), ": track
|
|
46
|
+
}, "Description"), ": track existing directory contents as new components in the workspace", (0, _react2.mdx)("br", {
|
|
47
47
|
parentName: "p"
|
|
48
|
-
}), "\n", "
|
|
48
|
+
}), "\n", "Registers one or more directories as Bit components without changing your files. Each provided path becomes a component root tracked by Bit."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
49
49
|
parentName: "p"
|
|
50
50
|
}, "bit add [path...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
51
51
|
parentName: "table"
|
|
@@ -181,7 +181,13 @@ function MDXContent(_ref) {
|
|
|
181
181
|
parentName: "p"
|
|
182
182
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
183
183
|
parentName: "p"
|
|
184
|
-
}, "Description"), ":
|
|
184
|
+
}, "Description"), ": manage application components", (0, _react2.mdx)("br", {
|
|
185
|
+
parentName: "p"
|
|
186
|
+
}), "\n", "applications are components that create deployable, runnable applications like React apps or Node.js servers.", (0, _react2.mdx)("br", {
|
|
187
|
+
parentName: "p"
|
|
188
|
+
}), "\n", "list available apps in the workspace and inspect their configurations.", (0, _react2.mdx)("br", {
|
|
189
|
+
parentName: "p"
|
|
190
|
+
}), "\n", "use \"bit run\" to start an application locally."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
185
191
|
parentName: "p"
|
|
186
192
|
}, "bit app [sub-command]")), (0, _react2.mdx)("h3", null, "app list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
187
193
|
parentName: "p"
|
|
@@ -231,7 +237,13 @@ function MDXContent(_ref) {
|
|
|
231
237
|
parentName: "p"
|
|
232
238
|
}, "app run [app-name]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
233
239
|
parentName: "p"
|
|
234
|
-
}, "Description"), ":
|
|
240
|
+
}, "Description"), ": start an application component locally", (0, _react2.mdx)("br", {
|
|
241
|
+
parentName: "p"
|
|
242
|
+
}), "\n", "runs application components in their own development server, separate from the \"bit start\" UI.", (0, _react2.mdx)("br", {
|
|
243
|
+
parentName: "p"
|
|
244
|
+
}), "\n", "apps are components that create deployable applications (React apps, Node.js servers, etc.).", (0, _react2.mdx)("br", {
|
|
245
|
+
parentName: "p"
|
|
246
|
+
}), "\n", "when no app name is specified, automatically detects and runs the app if only one exists in the workspace."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
235
247
|
parentName: "table"
|
|
236
248
|
}, (0, _react2.mdx)("tr", {
|
|
237
249
|
parentName: "thead"
|
|
@@ -370,13 +382,13 @@ function MDXContent(_ref) {
|
|
|
370
382
|
"align": null
|
|
371
383
|
}, "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, "artifacts"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
372
384
|
parentName: "p"
|
|
373
|
-
}, "Description"), ":
|
|
385
|
+
}, "Description"), ": view and download build artifacts", (0, _react2.mdx)("br", {
|
|
374
386
|
parentName: "p"
|
|
375
|
-
}), "\n", "artifacts
|
|
387
|
+
}), "\n", "displays artifacts created during the build pipeline in isolated capsules during tag or snap operations.", (0, _react2.mdx)("br", {
|
|
376
388
|
parentName: "p"
|
|
377
|
-
}), "\n", "
|
|
389
|
+
}), "\n", "artifacts include compiled files, test reports, package files, and other build outputs generated by various tasks.", (0, _react2.mdx)("br", {
|
|
378
390
|
parentName: "p"
|
|
379
|
-
}), "\n", "
|
|
391
|
+
}), "\n", "use --out-dir to download artifacts locally for inspection or deployment purposes."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
380
392
|
parentName: "p"
|
|
381
393
|
}, "bit artifacts <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
382
394
|
parentName: "table"
|
|
@@ -483,7 +495,13 @@ function MDXContent(_ref) {
|
|
|
483
495
|
"align": null
|
|
484
496
|
}, "download the files to the specified dir")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "aspect"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
485
497
|
parentName: "p"
|
|
486
|
-
}, "Description"), ": manage aspects
|
|
498
|
+
}, "Description"), ": manage component aspects and their configurations", (0, _react2.mdx)("br", {
|
|
499
|
+
parentName: "p"
|
|
500
|
+
}), "\n", "aspects provide functionality and tools for components throughout their development lifecycle.", (0, _react2.mdx)("br", {
|
|
501
|
+
parentName: "p"
|
|
502
|
+
}), "\n", "primarily useful for inspecting aspect assignments and configurations with \"bit aspect get\".", (0, _react2.mdx)("br", {
|
|
503
|
+
parentName: "p"
|
|
504
|
+
}), "\n", "rarely used for manual aspect management as most aspects are configured automatically."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
487
505
|
parentName: "p"
|
|
488
506
|
}, "bit aspect <sub-command>")), (0, _react2.mdx)("h3", null, "aspect list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
489
507
|
parentName: "p"
|
|
@@ -898,7 +916,13 @@ function MDXContent(_ref) {
|
|
|
898
916
|
parentName: "td"
|
|
899
917
|
}, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "blame"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
900
918
|
parentName: "p"
|
|
901
|
-
}, "Description"), ": EXPERIMENTAL.
|
|
919
|
+
}, "Description"), ": EXPERIMENTAL. show line-by-line authorship and modification history", (0, _react2.mdx)("br", {
|
|
920
|
+
parentName: "p"
|
|
921
|
+
}), "\n", "displays who last modified each line of a file and when the change was made.", (0, _react2.mdx)("br", {
|
|
922
|
+
parentName: "p"
|
|
923
|
+
}), "\n", "tracks line-level changes across component versions.", (0, _react2.mdx)("br", {
|
|
924
|
+
parentName: "p"
|
|
925
|
+
}), "\n", "shows author, date, version hash, and optionally commit messages for each line."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
902
926
|
parentName: "p"
|
|
903
927
|
}, "bit blame <filepath>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
904
928
|
parentName: "table"
|
|
@@ -964,15 +988,15 @@ function MDXContent(_ref) {
|
|
|
964
988
|
"align": null
|
|
965
989
|
}, "show the commit message")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
966
990
|
parentName: "p"
|
|
967
|
-
}, "Description"), ": run
|
|
991
|
+
}, "Description"), ": run build pipeline tasks in isolated environments", (0, _react2.mdx)("br", {
|
|
968
992
|
parentName: "p"
|
|
969
|
-
}), "\n", "
|
|
993
|
+
}), "\n", "executes the complete build pipeline including compilation, testing, linting, and other tasks defined by component environments.", (0, _react2.mdx)("br", {
|
|
970
994
|
parentName: "p"
|
|
971
|
-
}), "\n", "the build takes place in
|
|
995
|
+
}), "\n", "the build takes place in isolated directories called \"capsules\" where component files are copied and dependencies are installed via the package manager.", (0, _react2.mdx)("br", {
|
|
972
996
|
parentName: "p"
|
|
973
|
-
}), "\n", "
|
|
997
|
+
}), "\n", "by default processes only new and modified components - use --unmodified to build all components.", (0, _react2.mdx)("br", {
|
|
974
998
|
parentName: "p"
|
|
975
|
-
}), "\n", "because this process can take a while on
|
|
999
|
+
}), "\n", "because this process can take a while on large workspaces, various flags are available to optimize the process - see examples for debugging workflows."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
976
1000
|
parentName: "p"
|
|
977
1001
|
}, "bit build [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
978
1002
|
parentName: "table"
|
|
@@ -1241,15 +1265,13 @@ function MDXContent(_ref) {
|
|
|
1241
1265
|
"align": null
|
|
1242
1266
|
}, "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore: ", "[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]", " to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"", "*", "\".")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "capsule"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1243
1267
|
parentName: "p"
|
|
1244
|
-
}, "Description"), ": manage
|
|
1268
|
+
}, "Description"), ": manage isolated component environments", (0, _react2.mdx)("br", {
|
|
1245
1269
|
parentName: "p"
|
|
1246
|
-
}), "\n", "
|
|
1270
|
+
}), "\n", "capsules are temporary isolated directories containing component code and dependencies.", (0, _react2.mdx)("br", {
|
|
1247
1271
|
parentName: "p"
|
|
1248
|
-
}), "\n", "
|
|
1272
|
+
}), "\n", "automatically created during build processes to compile and test components in isolation.", (0, _react2.mdx)("br", {
|
|
1249
1273
|
parentName: "p"
|
|
1250
|
-
}), "\n", "
|
|
1251
|
-
parentName: "p"
|
|
1252
|
-
}), "\n", "other users after publishing/exporting them."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1274
|
+
}), "\n", "ensures components work independently before publishing, similar to how they'll be consumed."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1253
1275
|
parentName: "p"
|
|
1254
1276
|
}, "bit capsule")), (0, _react2.mdx)("h3", null, "capsule list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1255
1277
|
parentName: "p"
|
|
@@ -1548,7 +1570,13 @@ function MDXContent(_ref) {
|
|
|
1548
1570
|
"align": null
|
|
1549
1571
|
}, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "check-types"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1550
1572
|
parentName: "p"
|
|
1551
|
-
}, "Description"), ":
|
|
1573
|
+
}, "Description"), ": validate TypeScript type correctness", (0, _react2.mdx)("br", {
|
|
1574
|
+
parentName: "p"
|
|
1575
|
+
}), "\n", "checks for TypeScript type errors in component files, similar to running tsc.", (0, _react2.mdx)("br", {
|
|
1576
|
+
parentName: "p"
|
|
1577
|
+
}), "\n", "by default only checks new and modified components. use --all to check all components.", (0, _react2.mdx)("br", {
|
|
1578
|
+
parentName: "p"
|
|
1579
|
+
}), "\n", "useful for catching type issues before tagging, snapping or building components."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1552
1580
|
parentName: "p"
|
|
1553
1581
|
}, "bit check-types [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
1554
1582
|
parentName: "table"
|
|
@@ -1652,27 +1680,25 @@ function MDXContent(_ref) {
|
|
|
1652
1680
|
parentName: "p"
|
|
1653
1681
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
1654
1682
|
parentName: "p"
|
|
1655
|
-
}, "Description"), ": switch between component versions or remove local changes"
|
|
1683
|
+
}, "Description"), ": switch between component versions or remove local changes", (0, _react2.mdx)("br", {
|
|
1656
1684
|
parentName: "p"
|
|
1657
|
-
}, "
|
|
1685
|
+
}), "\n", "checkout components to specified versions or remove local changes. most commonly used as 'bit checkout head' to get latest versions.", (0, _react2.mdx)("br", {
|
|
1658
1686
|
parentName: "p"
|
|
1659
|
-
}), "\n", (0, _react2.mdx)("inlineCode", {
|
|
1660
|
-
parentName: "p"
|
|
1661
|
-
}, "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", (0, _react2.mdx)("br", {
|
|
1662
|
-
parentName: "p"
|
|
1663
|
-
}), "\n", (0, _react2.mdx)("inlineCode", {
|
|
1664
|
-
parentName: "p"
|
|
1665
|
-
}, "bit checkout head~x [component-pattern]"), " => go backward x generations from the head and checkout to that version", (0, _react2.mdx)("br", {
|
|
1666
|
-
parentName: "p"
|
|
1667
|
-
}), "\n", (0, _react2.mdx)("inlineCode", {
|
|
1668
|
-
parentName: "p"
|
|
1669
|
-
}, "bit checkout latest [component-pattern]"), " => checkout to the latest satisfying semver tag, omit ", "[component-pattern]", " to checkout latest for all", (0, _react2.mdx)("br", {
|
|
1670
|
-
parentName: "p"
|
|
1671
|
-
}), "\n", (0, _react2.mdx)("inlineCode", {
|
|
1672
|
-
parentName: "p"
|
|
1673
|
-
}, "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", (0, _react2.mdx)("br", {
|
|
1687
|
+
}), "\n", "the ", (0, _react2.mdx)("inlineCode", {
|
|
1674
1688
|
parentName: "p"
|
|
1675
|
-
}
|
|
1689
|
+
}, "<to>"), " argument accepts these values:"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
|
|
1690
|
+
parentName: "ul"
|
|
1691
|
+
}, "head: checkout to last snap/tag (most common usage)"), (0, _react2.mdx)("li", {
|
|
1692
|
+
parentName: "ul"
|
|
1693
|
+
}, "specific version: checkout to exact version (e.g. 'bit checkout 1.0.5 component-name')"), (0, _react2.mdx)("li", {
|
|
1694
|
+
parentName: "ul"
|
|
1695
|
+
}, "head~x: go back x generations from head (e.g. 'head~2' for two versions back)"), (0, _react2.mdx)("li", {
|
|
1696
|
+
parentName: "ul"
|
|
1697
|
+
}, "latest: checkout to latest semver tag"), (0, _react2.mdx)("li", {
|
|
1698
|
+
parentName: "ul"
|
|
1699
|
+
}, "reset: remove local modifications and restore original files (also restores deleted component directories)", (0, _react2.mdx)("br", {
|
|
1700
|
+
parentName: "li"
|
|
1701
|
+
}), "when on lanes, 'checkout head' only affects lane components. to update main components, run 'bit lane merge main'.")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1676
1702
|
parentName: "p"
|
|
1677
1703
|
}, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
1678
1704
|
parentName: "table"
|
|
@@ -1866,7 +1892,9 @@ function MDXContent(_ref) {
|
|
|
1866
1892
|
"align": null
|
|
1867
1893
|
}, "do not merge, just overwrite with incoming files")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "ci"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1868
1894
|
parentName: "p"
|
|
1869
|
-
}, "Description"), ":
|
|
1895
|
+
}, "Description"), ": continuous integration commands for automated workflows", (0, _react2.mdx)("br", {
|
|
1896
|
+
parentName: "p"
|
|
1897
|
+
}), "\n", "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."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1870
1898
|
parentName: "p"
|
|
1871
1899
|
}, "bit ci <sub-command>")), (0, _react2.mdx)("h3", null, "ci verify"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1872
1900
|
parentName: "p"
|
|
@@ -2211,13 +2239,15 @@ function MDXContent(_ref) {
|
|
|
2211
2239
|
parentName: "p"
|
|
2212
2240
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
2213
2241
|
parentName: "p"
|
|
2214
|
-
}, "Description"), ":
|
|
2242
|
+
}, "Description"), ": remove cached data to resolve stale data issues", (0, _react2.mdx)("br", {
|
|
2215
2243
|
parentName: "p"
|
|
2216
|
-
}), "\n", "
|
|
2244
|
+
}), "\n", "clears various caches that Bit uses to improve performance. useful when experiencing stale data issues or", (0, _react2.mdx)("br", {
|
|
2245
|
+
parentName: "p"
|
|
2246
|
+
}), "\n", "unexpected behavior. this command removes:"), (0, _react2.mdx)("ol", null, (0, _react2.mdx)("li", {
|
|
2217
2247
|
parentName: "ol"
|
|
2218
2248
|
}, "components cache on the filesystem (mainly the dependencies graph and docs)"), (0, _react2.mdx)("li", {
|
|
2219
2249
|
parentName: "ol"
|
|
2220
|
-
}, "scope's index file, which maps the component-id:object-hash")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2250
|
+
}, "scope's index file, which maps the component-id:object-hash")), (0, _react2.mdx)("p", null, "note: this cache has minimal impact on disk space. to free significant disk space, use \"bit capsule delete --all\" to remove build capsules."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2221
2251
|
parentName: "p"
|
|
2222
2252
|
}, "bit clear-cache")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
2223
2253
|
parentName: "table"
|
|
@@ -2255,81 +2285,15 @@ function MDXContent(_ref) {
|
|
|
2255
2285
|
}, "-r")), (0, _react2.mdx)("td", {
|
|
2256
2286
|
parentName: "tr",
|
|
2257
2287
|
"align": null
|
|
2258
|
-
}, "clear memory cache from a remote scope")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "
|
|
2259
|
-
parentName: "p"
|
|
2260
|
-
}, "Description"), ": EXPERIMENTAL. enters bit cli program and generates commands list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2288
|
+
}, "clear memory cache from a remote scope")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2261
2289
|
parentName: "p"
|
|
2262
|
-
}, "
|
|
2290
|
+
}, "Description"), ": transpile component source files", (0, _react2.mdx)("br", {
|
|
2263
2291
|
parentName: "p"
|
|
2264
|
-
}, "
|
|
2265
|
-
parentName: "p"
|
|
2266
|
-
}, "cli generate")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2292
|
+
}), "\n", "compiles TypeScript, JSX, and other source files into JavaScript using the compiler configured by each component's environment.", (0, _react2.mdx)("br", {
|
|
2267
2293
|
parentName: "p"
|
|
2268
|
-
}, "
|
|
2269
|
-
parentName: "table"
|
|
2270
|
-
}, (0, _react2.mdx)("tr", {
|
|
2271
|
-
parentName: "thead"
|
|
2272
|
-
}, (0, _react2.mdx)("th", {
|
|
2273
|
-
parentName: "tr",
|
|
2274
|
-
"align": null
|
|
2275
|
-
}, (0, _react2.mdx)("strong", {
|
|
2276
|
-
parentName: "th"
|
|
2277
|
-
}, "Option")), (0, _react2.mdx)("th", {
|
|
2278
|
-
parentName: "tr",
|
|
2279
|
-
"align": "center"
|
|
2280
|
-
}, (0, _react2.mdx)("strong", {
|
|
2281
|
-
parentName: "th"
|
|
2282
|
-
}, "Option alias")), (0, _react2.mdx)("th", {
|
|
2283
|
-
parentName: "tr",
|
|
2284
|
-
"align": null
|
|
2285
|
-
}, (0, _react2.mdx)("strong", {
|
|
2286
|
-
parentName: "th"
|
|
2287
|
-
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
2288
|
-
parentName: "table"
|
|
2289
|
-
}, (0, _react2.mdx)("tr", {
|
|
2290
|
-
parentName: "tbody"
|
|
2291
|
-
}, (0, _react2.mdx)("td", {
|
|
2292
|
-
parentName: "tr",
|
|
2293
|
-
"align": null
|
|
2294
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
2295
|
-
parentName: "td"
|
|
2296
|
-
}, "--metadata")), (0, _react2.mdx)("td", {
|
|
2297
|
-
parentName: "tr",
|
|
2298
|
-
"align": "center"
|
|
2299
|
-
}), (0, _react2.mdx)("td", {
|
|
2300
|
-
parentName: "tr",
|
|
2301
|
-
"align": null
|
|
2302
|
-
}, "metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands")), (0, _react2.mdx)("tr", {
|
|
2303
|
-
parentName: "tbody"
|
|
2304
|
-
}, (0, _react2.mdx)("td", {
|
|
2305
|
-
parentName: "tr",
|
|
2306
|
-
"align": null
|
|
2307
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
2308
|
-
parentName: "td"
|
|
2309
|
-
}, "--docs")), (0, _react2.mdx)("td", {
|
|
2310
|
-
parentName: "tr",
|
|
2311
|
-
"align": "center"
|
|
2312
|
-
}), (0, _react2.mdx)("td", {
|
|
2313
|
-
parentName: "tr",
|
|
2314
|
-
"align": null
|
|
2315
|
-
}, "generate the cli-reference.docs.mdx file")), (0, _react2.mdx)("tr", {
|
|
2316
|
-
parentName: "tbody"
|
|
2317
|
-
}, (0, _react2.mdx)("td", {
|
|
2318
|
-
parentName: "tr",
|
|
2319
|
-
"align": null
|
|
2320
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
2321
|
-
parentName: "td"
|
|
2322
|
-
}, "--json")), (0, _react2.mdx)("td", {
|
|
2323
|
-
parentName: "tr",
|
|
2324
|
-
"align": "center"
|
|
2325
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
2326
|
-
parentName: "td"
|
|
2327
|
-
}, "-j")), (0, _react2.mdx)("td", {
|
|
2328
|
-
parentName: "tr",
|
|
2329
|
-
"align": null
|
|
2330
|
-
}, "output the commands info as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "compile"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2294
|
+
}), "\n", "outputs compiled files to node_modules/component-package-name/dist for consumption by other components.", (0, _react2.mdx)("br", {
|
|
2331
2295
|
parentName: "p"
|
|
2332
|
-
}, "
|
|
2296
|
+
}), "\n", "automatically triggered by \"bit watch\", \"bit start\", or IDE extensions, but can be run manually for debugging."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2333
2297
|
parentName: "p"
|
|
2334
2298
|
}, "bit compile [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
2335
2299
|
parentName: "table"
|
|
@@ -2453,7 +2417,15 @@ function MDXContent(_ref) {
|
|
|
2453
2417
|
"align": null
|
|
2454
2418
|
}, "EXPERIMENTAL. generate d.ts files for typescript components (hurts performance)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2455
2419
|
parentName: "p"
|
|
2456
|
-
}, "Description"), ":
|
|
2420
|
+
}, "Description"), ": manage Bit configuration settings", (0, _react2.mdx)("br", {
|
|
2421
|
+
parentName: "p"
|
|
2422
|
+
}), "\n", "view and modify Bit configuration at different levels: global, workspace, or scope.", (0, _react2.mdx)("br", {
|
|
2423
|
+
parentName: "p"
|
|
2424
|
+
}), "\n", "configurations control various aspects of Bit including user settings, registries, and feature flags.", (0, _react2.mdx)("br", {
|
|
2425
|
+
parentName: "p"
|
|
2426
|
+
}), "\n", "use environment variables prefixed with BIT", (0, _react2.mdx)("em", {
|
|
2427
|
+
parentName: "p"
|
|
2428
|
+
}, "CONFIG"), " for temporary overrides.", (0, _react2.mdx)("br", {
|
|
2457
2429
|
parentName: "p"
|
|
2458
2430
|
}), "\n", (0, _react2.mdx)("a", {
|
|
2459
2431
|
parentName: "p",
|
|
@@ -2645,7 +2617,9 @@ function MDXContent(_ref) {
|
|
|
2645
2617
|
"align": null
|
|
2646
2618
|
}, "output as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "create"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2647
2619
|
parentName: "p"
|
|
2648
|
-
}, "Description"), ":
|
|
2620
|
+
}, "Description"), ": scaffold new component(s) from a template (sources, config, and env)", (0, _react2.mdx)("br", {
|
|
2621
|
+
parentName: "p"
|
|
2622
|
+
}), "\n", "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."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2649
2623
|
parentName: "p"
|
|
2650
2624
|
}, "bit create <template-name> <component-names...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
2651
2625
|
parentName: "table"
|
|
@@ -2813,13 +2787,13 @@ function MDXContent(_ref) {
|
|
|
2813
2787
|
"align": null
|
|
2814
2788
|
}, "replace existing files at the target location")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "delete"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2815
2789
|
parentName: "p"
|
|
2816
|
-
}, "Description"), ":
|
|
2790
|
+
}, "Description"), ": soft-delete components from remote scopes", (0, _react2.mdx)("br", {
|
|
2817
2791
|
parentName: "p"
|
|
2818
|
-
}), "\n", "
|
|
2792
|
+
}), "\n", "marks components as deleted so they won't be visible on remote scopes after export.", (0, _react2.mdx)("br", {
|
|
2819
2793
|
parentName: "p"
|
|
2820
|
-
}), "\n", "
|
|
2794
|
+
}), "\n", "components remain recoverable using \"bit recover\" unless --hard is used (permanent deletion, not recommended).", (0, _react2.mdx)("br", {
|
|
2821
2795
|
parentName: "p"
|
|
2822
|
-
}), "\n", "
|
|
2796
|
+
}), "\n", "to remove components from your local workspace only, use \"bit remove\" instead."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2823
2797
|
parentName: "p"
|
|
2824
2798
|
}, "bit delete <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
2825
2799
|
parentName: "table"
|
|
@@ -2972,7 +2946,13 @@ function MDXContent(_ref) {
|
|
|
2972
2946
|
"align": null
|
|
2973
2947
|
}, "comma-separated list of snap hashes to mark as deleted (e.g. --snaps \"hash1,hash2,hash3\")")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2974
2948
|
parentName: "p"
|
|
2975
|
-
}, "Description"), ": show
|
|
2949
|
+
}, "Description"), ": show components that depend on the specified component", (0, _react2.mdx)("br", {
|
|
2950
|
+
parentName: "p"
|
|
2951
|
+
}), "\n", "displays components from both workspace and scope that depend on the specified component.", (0, _react2.mdx)("br", {
|
|
2952
|
+
parentName: "p"
|
|
2953
|
+
}), "\n", "useful for understanding impact before making changes to a component or when planning refactoring.", (0, _react2.mdx)("br", {
|
|
2954
|
+
parentName: "p"
|
|
2955
|
+
}), "\n", "shows both direct and transitive dependents organized by their origin (workspace vs scope)."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
2976
2956
|
parentName: "p"
|
|
2977
2957
|
}, "bit dependents <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
2978
2958
|
parentName: "table"
|
|
@@ -3044,7 +3024,13 @@ function MDXContent(_ref) {
|
|
|
3044
3024
|
parentName: "p"
|
|
3045
3025
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
3046
3026
|
parentName: "p"
|
|
3047
|
-
}, "Description"), ":
|
|
3027
|
+
}, "Description"), ": mark a component as deprecated to discourage its use", (0, _react2.mdx)("br", {
|
|
3028
|
+
parentName: "p"
|
|
3029
|
+
}), "\n", "marks a component as deprecated locally, then after snap/tag and export it becomes deprecated in the remote scope.", (0, _react2.mdx)("br", {
|
|
3030
|
+
parentName: "p"
|
|
3031
|
+
}), "\n", "optionally specify a replacement component or deprecate only specific version ranges.", (0, _react2.mdx)("br", {
|
|
3032
|
+
parentName: "p"
|
|
3033
|
+
}), "\n", "deprecated components remain available but display warnings when installed or imported."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
3048
3034
|
parentName: "p"
|
|
3049
3035
|
}, "bit deprecate <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
3050
3036
|
parentName: "table"
|
|
@@ -3130,7 +3116,9 @@ function MDXContent(_ref) {
|
|
|
3130
3116
|
parentName: "p"
|
|
3131
3117
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
3132
3118
|
parentName: "p"
|
|
3133
|
-
}, "Description"), ": manage dependencies"
|
|
3119
|
+
}, "Description"), ": manage component dependencies", (0, _react2.mdx)("br", {
|
|
3120
|
+
parentName: "p"
|
|
3121
|
+
}), "\n", "configure and analyze component dependencies with sub-commands for setting, removing, and inspecting dependency relationships."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
3134
3122
|
parentName: "p"
|
|
3135
3123
|
}, "bit deps <sub-command>")), (0, _react2.mdx)("h3", null, "deps get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
3136
3124
|
parentName: "p"
|
|
@@ -3684,7 +3672,13 @@ function MDXContent(_ref) {
|
|
|
3684
3672
|
parentName: "p"
|
|
3685
3673
|
}, "deps usage <dependency-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
3686
3674
|
parentName: "p"
|
|
3687
|
-
}, "Description"), ": find components that use the specified dependency"
|
|
3675
|
+
}, "Description"), ": find components that use the specified dependency", (0, _react2.mdx)("br", {
|
|
3676
|
+
parentName: "p"
|
|
3677
|
+
}), "\n", "searches workspace components to find which ones depend on the specified package or component.", (0, _react2.mdx)("br", {
|
|
3678
|
+
parentName: "p"
|
|
3679
|
+
}), "\n", "useful for understanding dependency usage before removing packages or when refactoring components.", (0, _react2.mdx)("br", {
|
|
3680
|
+
parentName: "p"
|
|
3681
|
+
}), "\n", "supports both exact version matching and package name patterns."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
3688
3682
|
parentName: "table"
|
|
3689
3683
|
}, (0, _react2.mdx)("tr", {
|
|
3690
3684
|
parentName: "thead"
|
|
@@ -3790,7 +3784,13 @@ function MDXContent(_ref) {
|
|
|
3790
3784
|
"align": null
|
|
3791
3785
|
}, "specify where the dependencies should be written. By default they are saved to workspace.jsonc")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
3792
3786
|
parentName: "p"
|
|
3793
|
-
}, "Description"), ":
|
|
3787
|
+
}, "Description"), ": compare component changes between versions or against the current workspace", (0, _react2.mdx)("br", {
|
|
3788
|
+
parentName: "p"
|
|
3789
|
+
}), "\n", "shows a detailed diff of component files, dependencies, and configuration changes.", (0, _react2.mdx)("br", {
|
|
3790
|
+
parentName: "p"
|
|
3791
|
+
}), "\n", "by default, compares workspace changes against the latest version. specify versions to compare historical changes.", (0, _react2.mdx)("br", {
|
|
3792
|
+
parentName: "p"
|
|
3793
|
+
}), "\n", "supports pattern matching to filter components and various output formats for better readability."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
3794
3794
|
parentName: "p"
|
|
3795
3795
|
}, "bit diff [component-pattern] [version] [to-version]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
3796
3796
|
parentName: "table"
|
|
@@ -3910,7 +3910,13 @@ function MDXContent(_ref) {
|
|
|
3910
3910
|
"align": null
|
|
3911
3911
|
}, "show tables instead of plain text for dependencies diff")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "doctor"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
3912
3912
|
parentName: "p"
|
|
3913
|
-
}, "Description"), ": diagnose
|
|
3913
|
+
}, "Description"), ": diagnose and troubleshoot workspace issues", (0, _react2.mdx)("br", {
|
|
3914
|
+
parentName: "p"
|
|
3915
|
+
}), "\n", "runs comprehensive health checks on your workspace to detect and report configuration problems,", (0, _react2.mdx)("br", {
|
|
3916
|
+
parentName: "p"
|
|
3917
|
+
}), "\n", "missing dependencies, corrupted data, and other issues that may affect workspace functionality.", (0, _react2.mdx)("br", {
|
|
3918
|
+
parentName: "p"
|
|
3919
|
+
}), "\n", "can generate diagnostic reports and workspace archives for debugging and support purposes."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
3914
3920
|
parentName: "p"
|
|
3915
3921
|
}, "bit doctor [diagnosis-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
3916
3922
|
parentName: "table"
|
|
@@ -4044,9 +4050,13 @@ function MDXContent(_ref) {
|
|
|
4044
4050
|
parentName: "p"
|
|
4045
4051
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
4046
4052
|
parentName: "p"
|
|
4047
|
-
}, "Description"), ": remove component from
|
|
4053
|
+
}, "Description"), ": remove component from workspace and install it as npm package", (0, _react2.mdx)("br", {
|
|
4048
4054
|
parentName: "p"
|
|
4049
|
-
}), "\n", "
|
|
4055
|
+
}), "\n", "converts workspace components to external npm packages by removing them from .bitmap and installing via package manager.", (0, _react2.mdx)("br", {
|
|
4056
|
+
parentName: "p"
|
|
4057
|
+
}), "\n", "by default removes component files from workspace. use --keep-files to preserve source code while converting to package dependency.", (0, _react2.mdx)("br", {
|
|
4058
|
+
parentName: "p"
|
|
4059
|
+
}), "\n", "useful for components that no longer need active development in current workspace."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4050
4060
|
parentName: "p"
|
|
4051
4061
|
}, "bit eject <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
4052
4062
|
parentName: "table"
|
|
@@ -4159,13 +4169,13 @@ function MDXContent(_ref) {
|
|
|
4159
4169
|
"align": null
|
|
4160
4170
|
}, "keep the component files in the workspace intact")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "eject-conf"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
4161
4171
|
parentName: "p"
|
|
4162
|
-
}, "Description"), ":
|
|
4172
|
+
}, "Description"), ": create component.json configuration files for components", (0, _react2.mdx)("br", {
|
|
4163
4173
|
parentName: "p"
|
|
4164
|
-
}, "
|
|
4174
|
+
}), "\n", "generates component.json files containing component-specific configuration that overrides workspace defaults.", (0, _react2.mdx)("br", {
|
|
4165
4175
|
parentName: "p"
|
|
4166
|
-
}), "\n", "
|
|
4176
|
+
}), "\n", "useful for customizing individual component settings. alternatively, use commands like \"bit env set\", \"bit deps set\", or \"bit aspect set\".", (0, _react2.mdx)("br", {
|
|
4167
4177
|
parentName: "p"
|
|
4168
|
-
}), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
|
|
4178
|
+
}), "\n", "can be reversed by deleting the component.json file and snapping/tagging the changes."), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
|
|
4169
4179
|
parentName: "p"
|
|
4170
4180
|
}, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
|
|
4171
4181
|
parentName: "p"
|
|
@@ -4242,7 +4252,11 @@ function MDXContent(_ref) {
|
|
|
4242
4252
|
parentName: "p"
|
|
4243
4253
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
4244
4254
|
parentName: "p"
|
|
4245
|
-
}, "Description"), ":
|
|
4255
|
+
}, "Description"), ": show components and their assigned environments", (0, _react2.mdx)("br", {
|
|
4256
|
+
parentName: "p"
|
|
4257
|
+
}), "\n", "displays a table showing each workspace component and its corresponding environment.", (0, _react2.mdx)("br", {
|
|
4258
|
+
parentName: "p"
|
|
4259
|
+
}), "\n", "environments control how components are built, tested, linted, and deployed."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4246
4260
|
parentName: "p"
|
|
4247
4261
|
}, "bit envs")), (0, _react2.mdx)("h3", null, "envs list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
4248
4262
|
parentName: "p"
|
|
@@ -4520,17 +4534,13 @@ function MDXContent(_ref) {
|
|
|
4520
4534
|
parentName: "p"
|
|
4521
4535
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
4522
4536
|
parentName: "p"
|
|
4523
|
-
}, "Description"), ":
|
|
4524
|
-
parentName: "p"
|
|
4525
|
-
}), "\n", "bit export => export all staged snaps/tags of components to their remote scope. if checked out to a lane, export the lane as well", (0, _react2.mdx)("br", {
|
|
4537
|
+
}, "Description"), ": upload components to remote scopes", (0, _react2.mdx)("br", {
|
|
4526
4538
|
parentName: "p"
|
|
4527
|
-
}), "\n", "", (0, _react2.mdx)("
|
|
4539
|
+
}), "\n", "uploads staged versions (snaps/tags) to remote scopes, making them available for consumption by other workspaces.", (0, _react2.mdx)("br", {
|
|
4528
4540
|
parentName: "p"
|
|
4529
|
-
}, "
|
|
4541
|
+
}), "\n", "without arguments, exports all staged components. when on a lane, exports the lane as well.", (0, _react2.mdx)("br", {
|
|
4530
4542
|
parentName: "p"
|
|
4531
|
-
}), "\n", "
|
|
4532
|
-
parentName: "p"
|
|
4533
|
-
}), "\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)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4543
|
+
}), "\n", "exporting is the final step after development and versioning to share components with your team."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4534
4544
|
parentName: "p"
|
|
4535
4545
|
}, "bit export [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
4536
4546
|
parentName: "table"
|
|
@@ -4734,7 +4744,13 @@ function MDXContent(_ref) {
|
|
|
4734
4744
|
"align": null
|
|
4735
4745
|
}, "show output in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
4736
4746
|
parentName: "p"
|
|
4737
|
-
}, "Description"), ": create a new component
|
|
4747
|
+
}, "Description"), ": create a new component by copying from an existing one", (0, _react2.mdx)("br", {
|
|
4748
|
+
parentName: "p"
|
|
4749
|
+
}), "\n", "duplicates an existing component's source files and configuration to create a new independent component.", (0, _react2.mdx)("br", {
|
|
4750
|
+
parentName: "p"
|
|
4751
|
+
}), "\n", "useful for creating variations or starting development from a similar component.", (0, _react2.mdx)("br", {
|
|
4752
|
+
parentName: "p"
|
|
4753
|
+
}), "\n", "automatically handles import/require statement updates and provides refactoring options."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4738
4754
|
parentName: "p"
|
|
4739
4755
|
}, "bit fork <source-component-id> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
4740
4756
|
parentName: "table"
|
|
@@ -4924,7 +4940,13 @@ function MDXContent(_ref) {
|
|
|
4924
4940
|
"align": null
|
|
4925
4941
|
}, "use ast to transform files instead of regex")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "format"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
4926
4942
|
parentName: "p"
|
|
4927
|
-
}, "Description"), ": format
|
|
4943
|
+
}, "Description"), ": auto-format component source code", (0, _react2.mdx)("br", {
|
|
4944
|
+
parentName: "p"
|
|
4945
|
+
}), "\n", "formats component files using the formatter configured by each component's environment (Prettier, etc.).", (0, _react2.mdx)("br", {
|
|
4946
|
+
parentName: "p"
|
|
4947
|
+
}), "\n", "by default formats all components. use --changed to format only new and modified components.", (0, _react2.mdx)("br", {
|
|
4948
|
+
parentName: "p"
|
|
4949
|
+
}), "\n", "supports check mode to verify formatting without making changes."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
4928
4950
|
parentName: "p"
|
|
4929
4951
|
}, "bit format [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
4930
4952
|
parentName: "table"
|
|
@@ -5022,7 +5044,13 @@ function MDXContent(_ref) {
|
|
|
5022
5044
|
"align": null
|
|
5023
5045
|
}, "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", {
|
|
5024
5046
|
parentName: "p"
|
|
5025
|
-
}, "Description"), ":
|
|
5047
|
+
}, "Description"), ": Git utilities for Bit repositories", (0, _react2.mdx)("br", {
|
|
5048
|
+
parentName: "p"
|
|
5049
|
+
}), "\n", "provides specialized Git utilities for handling Bit-specific files and conflicts.", (0, _react2.mdx)("br", {
|
|
5050
|
+
parentName: "p"
|
|
5051
|
+
}), "\n", "includes tools for setting up merge drivers for bitmap files and resolving conflicts during Git merges.", (0, _react2.mdx)("br", {
|
|
5052
|
+
parentName: "p"
|
|
5053
|
+
}), "\n", "essential for properly handling Bit's internal files when working with Git repositories."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5026
5054
|
parentName: "p"
|
|
5027
5055
|
}, "bit git <sub-command>")), (0, _react2.mdx)("h3", null, "git set-merge-driver"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
5028
5056
|
parentName: "p"
|
|
@@ -5074,7 +5102,11 @@ function MDXContent(_ref) {
|
|
|
5074
5102
|
parentName: "p"
|
|
5075
5103
|
}, "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", {
|
|
5076
5104
|
parentName: "p"
|
|
5077
|
-
}, "Description"), ":
|
|
5105
|
+
}, "Description"), ": display global directories and paths used by Bit", (0, _react2.mdx)("br", {
|
|
5106
|
+
parentName: "p"
|
|
5107
|
+
}), "\n", "shows all global directories including cache, logs, and config locations used by Bit across your system.", (0, _react2.mdx)("br", {
|
|
5108
|
+
parentName: "p"
|
|
5109
|
+
}), "\n", "useful for debugging and understanding where Bit stores data."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5078
5110
|
parentName: "p"
|
|
5079
5111
|
}, "bit globals")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5080
5112
|
parentName: "table"
|
|
@@ -5114,7 +5146,13 @@ function MDXContent(_ref) {
|
|
|
5114
5146
|
"align": null
|
|
5115
5147
|
}, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "graph"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
5116
5148
|
parentName: "p"
|
|
5117
|
-
}, "Description"), ":
|
|
5149
|
+
}, "Description"), ": visualize component dependencies as a graph image", (0, _react2.mdx)("br", {
|
|
5150
|
+
parentName: "p"
|
|
5151
|
+
}), "\n", "generates an SVG (or PNG) image showing component dependency relationships.", (0, _react2.mdx)("br", {
|
|
5152
|
+
parentName: "p"
|
|
5153
|
+
}), "\n", "black arrows represent runtime dependencies, red arrows show dev or peer dependencies.", (0, _react2.mdx)("br", {
|
|
5154
|
+
parentName: "p"
|
|
5155
|
+
}), "\n", "by default shows only workspace components; use --include-dependencies for full dependency tree."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5118
5156
|
parentName: "p"
|
|
5119
5157
|
}, "bit graph [id]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5120
5158
|
parentName: "table"
|
|
@@ -5240,7 +5278,11 @@ function MDXContent(_ref) {
|
|
|
5240
5278
|
parentName: "p"
|
|
5241
5279
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
5242
5280
|
parentName: "p"
|
|
5243
|
-
}, "Description"), ":
|
|
5281
|
+
}, "Description"), ": display available commands and usage information", (0, _react2.mdx)("br", {
|
|
5282
|
+
parentName: "p"
|
|
5283
|
+
}), "\n", "shows a categorized list of all available Bit commands with brief descriptions. use ", (0, _react2.mdx)("inlineCode", {
|
|
5284
|
+
parentName: "p"
|
|
5285
|
+
}, "bit <command> --help"), " for detailed help on specific commands."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5244
5286
|
parentName: "p"
|
|
5245
5287
|
}, "bit help")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5246
5288
|
parentName: "table"
|
|
@@ -5278,7 +5320,13 @@ function MDXContent(_ref) {
|
|
|
5278
5320
|
"align": null
|
|
5279
5321
|
}, "show internal commands")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "import"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
5280
5322
|
parentName: "p"
|
|
5281
|
-
}, "Description"), ":
|
|
5323
|
+
}, "Description"), ": bring components from remote scopes into your workspace", (0, _react2.mdx)("br", {
|
|
5324
|
+
parentName: "p"
|
|
5325
|
+
}), "\n", "brings component source files from remote scopes into your workspace and installs their dependencies as packages.", (0, _react2.mdx)("br", {
|
|
5326
|
+
parentName: "p"
|
|
5327
|
+
}), "\n", "supports pattern matching for bulk imports, merge strategies for handling conflicts, and various optimization options.", (0, _react2.mdx)("br", {
|
|
5328
|
+
parentName: "p"
|
|
5329
|
+
}), "\n", "without arguments, fetches all workspace components' latest versions from their remote scopes."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5282
5330
|
parentName: "p"
|
|
5283
5331
|
}, "bit import [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5284
5332
|
parentName: "table"
|
|
@@ -5712,9 +5760,13 @@ function MDXContent(_ref) {
|
|
|
5712
5760
|
"align": null
|
|
5713
5761
|
})))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "init"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
5714
5762
|
parentName: "p"
|
|
5715
|
-
}, "Description"), ":
|
|
5763
|
+
}, "Description"), ": initialize a Bit workspace in an existing project", (0, _react2.mdx)("br", {
|
|
5764
|
+
parentName: "p"
|
|
5765
|
+
}), "\n", "creates Bit configuration files in an existing project directory to start tracking components.", (0, _react2.mdx)("br", {
|
|
5766
|
+
parentName: "p"
|
|
5767
|
+
}), "\n", "if already a workspace, validates and repairs Bit files as needed.", (0, _react2.mdx)("br", {
|
|
5716
5768
|
parentName: "p"
|
|
5717
|
-
}), "\n", "
|
|
5769
|
+
}), "\n", "supports various reset options to recover from corrupted state or restart from scratch."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5718
5770
|
parentName: "p"
|
|
5719
5771
|
}, "bit init [path]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5720
5772
|
parentName: "table"
|
|
@@ -5967,9 +6019,13 @@ function MDXContent(_ref) {
|
|
|
5967
6019
|
parentName: "p"
|
|
5968
6020
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
5969
6021
|
parentName: "p"
|
|
5970
|
-
}, "Description"), ":
|
|
6022
|
+
}, "Description"), ": install workspace dependencies", (0, _react2.mdx)("br", {
|
|
5971
6023
|
parentName: "p"
|
|
5972
|
-
}), "\n", "
|
|
6024
|
+
}), "\n", "installs workspace dependencies and prepares the workspace for development.", (0, _react2.mdx)("br", {
|
|
6025
|
+
parentName: "p"
|
|
6026
|
+
}), "\n", "when packages are specified, adds them to workspace.jsonc policy and installs. when no packages specified, installs existing dependencies.", (0, _react2.mdx)("br", {
|
|
6027
|
+
parentName: "p"
|
|
6028
|
+
}), "\n", "automatically imports components, compiles components, links to node_modules, and writes config files."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
5973
6029
|
parentName: "p"
|
|
5974
6030
|
}, "bit install [packages...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
5975
6031
|
parentName: "table"
|
|
@@ -6214,7 +6270,13 @@ function MDXContent(_ref) {
|
|
|
6214
6270
|
parentName: "p"
|
|
6215
6271
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
6216
6272
|
parentName: "p"
|
|
6217
|
-
}, "Description"), ": manage lanes
|
|
6273
|
+
}, "Description"), ": manage lanes for parallel development", (0, _react2.mdx)("br", {
|
|
6274
|
+
parentName: "p"
|
|
6275
|
+
}), "\n", "lanes allow isolated development of features without affecting main branch components.", (0, _react2.mdx)("br", {
|
|
6276
|
+
parentName: "p"
|
|
6277
|
+
}), "\n", "create, switch between, and merge lanes to coordinate parallel work across teams.", (0, _react2.mdx)("br", {
|
|
6278
|
+
parentName: "p"
|
|
6279
|
+
}), "\n", "without a sub-command, lists all available lanes."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
6218
6280
|
parentName: "p"
|
|
6219
6281
|
}, "bit lane [sub-command]")), (0, _react2.mdx)("h3", null, "lane list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
6220
6282
|
parentName: "p"
|
|
@@ -8155,7 +8217,13 @@ function MDXContent(_ref) {
|
|
|
8155
8217
|
"align": null
|
|
8156
8218
|
}, "list only lanes that haven't been merged")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "link"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8157
8219
|
parentName: "p"
|
|
8158
|
-
}, "Description"), ": create links
|
|
8220
|
+
}, "Description"), ": create links between components and node_modules", (0, _react2.mdx)("br", {
|
|
8221
|
+
parentName: "p"
|
|
8222
|
+
}), "\n", "creates links in node_modules for workspace components and core aspects, enabling import resolution.", (0, _react2.mdx)("br", {
|
|
8223
|
+
parentName: "p"
|
|
8224
|
+
}), "\n", "automatically links all workspace components and Bit's core aspects to their respective package names.", (0, _react2.mdx)("br", {
|
|
8225
|
+
parentName: "p"
|
|
8226
|
+
}), "\n", "useful for development when components need to reference each other or when debugging linking issues."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8159
8227
|
parentName: "p"
|
|
8160
8228
|
}, "bit link [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8161
8229
|
parentName: "table"
|
|
@@ -8301,7 +8369,13 @@ function MDXContent(_ref) {
|
|
|
8301
8369
|
"align": null
|
|
8302
8370
|
}, "show only a summary of component links instead of listing all components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "lint"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8303
8371
|
parentName: "p"
|
|
8304
|
-
}, "Description"), ":
|
|
8372
|
+
}, "Description"), ": analyze component code for issues and style violations", (0, _react2.mdx)("br", {
|
|
8373
|
+
parentName: "p"
|
|
8374
|
+
}), "\n", "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.", (0, _react2.mdx)("br", {
|
|
8375
|
+
parentName: "p"
|
|
8376
|
+
}), "\n", "by default lints all components. use --changed to lint only new and modified components.", (0, _react2.mdx)("br", {
|
|
8377
|
+
parentName: "p"
|
|
8378
|
+
}), "\n", "supports automatic fixing of certain issues with --fix flag."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8305
8379
|
parentName: "p"
|
|
8306
8380
|
}, "bit lint [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8307
8381
|
parentName: "table"
|
|
@@ -8420,7 +8494,13 @@ function MDXContent(_ref) {
|
|
|
8420
8494
|
parentName: "p"
|
|
8421
8495
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
8422
8496
|
parentName: "p"
|
|
8423
|
-
}, "Description"), ":
|
|
8497
|
+
}, "Description"), ": display components in workspace or remote scope", (0, _react2.mdx)("br", {
|
|
8498
|
+
parentName: "p"
|
|
8499
|
+
}), "\n", "shows components in the current workspace by default, or from a specified remote scope.", (0, _react2.mdx)("br", {
|
|
8500
|
+
parentName: "p"
|
|
8501
|
+
}), "\n", "supports filtering by scope, namespace, and various display options.", (0, _react2.mdx)("br", {
|
|
8502
|
+
parentName: "p"
|
|
8503
|
+
}), "\n", "use --outdated to highlight components that have newer versions available."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8424
8504
|
parentName: "p"
|
|
8425
8505
|
}, "bit list [remote-scope]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8426
8506
|
parentName: "table"
|
|
@@ -8550,7 +8630,13 @@ function MDXContent(_ref) {
|
|
|
8550
8630
|
"align": null
|
|
8551
8631
|
}, "filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '", "*", "/ui')")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "local-only"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8552
8632
|
parentName: "p"
|
|
8553
|
-
}, "Description"), ": manage
|
|
8633
|
+
}, "Description"), ": manage components that exist only in the workspace", (0, _react2.mdx)("br", {
|
|
8634
|
+
parentName: "p"
|
|
8635
|
+
}), "\n", "controls components that are excluded from versioning (snap/tag) and exporting operations.", (0, _react2.mdx)("br", {
|
|
8636
|
+
parentName: "p"
|
|
8637
|
+
}), "\n", "local-only components are useful for workspace-specific tools, configs, or temporary components.", (0, _react2.mdx)("br", {
|
|
8638
|
+
parentName: "p"
|
|
8639
|
+
}), "\n", "these components remain in the workspace but won't be shared or versioned."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8554
8640
|
parentName: "p"
|
|
8555
8641
|
}, "bit local-only <sub-command>")), (0, _react2.mdx)("h3", null, "local-only set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8556
8642
|
parentName: "p"
|
|
@@ -8632,7 +8718,13 @@ function MDXContent(_ref) {
|
|
|
8632
8718
|
parentName: "p"
|
|
8633
8719
|
}, "Description"), ": list all local-only components"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "log"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8634
8720
|
parentName: "p"
|
|
8635
|
-
}, "Description"), ":
|
|
8721
|
+
}, "Description"), ": display component version history", (0, _react2.mdx)("br", {
|
|
8722
|
+
parentName: "p"
|
|
8723
|
+
}), "\n", "shows chronological history of component versions including tags and snaps with metadata.", (0, _react2.mdx)("br", {
|
|
8724
|
+
parentName: "p"
|
|
8725
|
+
}), "\n", "displays commit messages, authors, dates, and version information. supports both local and remote component logs.", (0, _react2.mdx)("br", {
|
|
8726
|
+
parentName: "p"
|
|
8727
|
+
}), "\n", "use various format options for compact or detailed views of version history."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8636
8728
|
parentName: "p"
|
|
8637
8729
|
}, "bit log <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8638
8730
|
parentName: "table"
|
|
@@ -8784,7 +8876,13 @@ function MDXContent(_ref) {
|
|
|
8784
8876
|
"align": null
|
|
8785
8877
|
}, "json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "log-file"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8786
8878
|
parentName: "p"
|
|
8787
|
-
}, "Description"), ": EXPERIMENTAL.
|
|
8879
|
+
}, "Description"), ": EXPERIMENTAL. display history of changes to a specific file", (0, _react2.mdx)("br", {
|
|
8880
|
+
parentName: "p"
|
|
8881
|
+
}), "\n", "shows version history for a specific file within component versions.", (0, _react2.mdx)("br", {
|
|
8882
|
+
parentName: "p"
|
|
8883
|
+
}), "\n", "tracks file-level changes across component snaps and tags.", (0, _react2.mdx)("br", {
|
|
8884
|
+
parentName: "p"
|
|
8885
|
+
}), "\n", "displays file modifications, hashes, and associated commit information."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8788
8886
|
parentName: "p"
|
|
8789
8887
|
}, "bit log-file <filepath>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8790
8888
|
parentName: "table"
|
|
@@ -8850,7 +8948,13 @@ function MDXContent(_ref) {
|
|
|
8850
8948
|
"align": null
|
|
8851
8949
|
}, "show each log entry in one line")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "login"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8852
8950
|
parentName: "p"
|
|
8853
|
-
}, "Description"), ":
|
|
8951
|
+
}, "Description"), ": authenticate with Bit Cloud for component publishing and collaboration", (0, _react2.mdx)("br", {
|
|
8952
|
+
parentName: "p"
|
|
8953
|
+
}), "\n", "opens browser to authenticate with Bit Cloud (bit.cloud) and obtain access token for publishing components.", (0, _react2.mdx)("br", {
|
|
8954
|
+
parentName: "p"
|
|
8955
|
+
}), "\n", "automatically updates .npmrc file with registry configuration and authentication token for seamless package publishing.", (0, _react2.mdx)("br", {
|
|
8956
|
+
parentName: "p"
|
|
8957
|
+
}), "\n", "supports custom cloud domains, CI/machine authentication, and manual token refresh options."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8854
8958
|
parentName: "p"
|
|
8855
8959
|
}, "bit login")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
8856
8960
|
parentName: "table"
|
|
@@ -8983,11 +9087,23 @@ function MDXContent(_ref) {
|
|
|
8983
9087
|
"align": null
|
|
8984
9088
|
}, "DEPRECATE. use --no-browser instead")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "logout"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8985
9089
|
parentName: "p"
|
|
8986
|
-
}, "Description"), ":
|
|
9090
|
+
}, "Description"), ": sign out of Bit Cloud and clear authentication tokens", (0, _react2.mdx)("br", {
|
|
9091
|
+
parentName: "p"
|
|
9092
|
+
}), "\n", "removes stored authentication tokens and signs out of Bit Cloud.", (0, _react2.mdx)("br", {
|
|
9093
|
+
parentName: "p"
|
|
9094
|
+
}), "\n", "clears local credentials while preserving .npmrc configurations.", (0, _react2.mdx)("br", {
|
|
9095
|
+
parentName: "p"
|
|
9096
|
+
}), "\n", "use this to switch between accounts or when authentication tokens expire."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8987
9097
|
parentName: "p"
|
|
8988
9098
|
}, "bit logout")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "mcp-server"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8989
9099
|
parentName: "p"
|
|
8990
|
-
}, "Description"), ":
|
|
9100
|
+
}, "Description"), ": start Model Context Protocol server for AI assistants", (0, _react2.mdx)("br", {
|
|
9101
|
+
parentName: "p"
|
|
9102
|
+
}), "\n", "enables AI assistants and other tools to interact with Bit via the Model Context Protocol.", (0, _react2.mdx)("br", {
|
|
9103
|
+
parentName: "p"
|
|
9104
|
+
}), "\n", "provides a standardized interface for AI agents to execute Bit commands and access component information.", (0, _react2.mdx)("br", {
|
|
9105
|
+
parentName: "p"
|
|
9106
|
+
}), "\n", "allows writing custom instructions and rules to guide AI agents in their interactions with Bit."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
8991
9107
|
parentName: "p"
|
|
8992
9108
|
}, "bit mcp-server [sub-command]")), (0, _react2.mdx)("h3", null, "mcp-server start"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
8993
9109
|
parentName: "p"
|
|
@@ -9326,15 +9442,17 @@ function MDXContent(_ref) {
|
|
|
9326
9442
|
"align": null
|
|
9327
9443
|
}, "For non-Bit workspaces that only consume Bit component packages. Enables only \"schema\", \"show\", and \"remote_search\" tools")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "merge"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9328
9444
|
parentName: "p"
|
|
9329
|
-
}, "Description"), ": merge
|
|
9445
|
+
}, "Description"), ": merge diverged component history when local and remote have different versions", (0, _react2.mdx)("br", {
|
|
9330
9446
|
parentName: "p"
|
|
9331
|
-
}), "\n", "
|
|
9447
|
+
}), "\n", "resolves diverged component history when both local and remote have created different snaps/tags from the same base version.", (0, _react2.mdx)("br", {
|
|
9332
9448
|
parentName: "p"
|
|
9333
|
-
}), "\n", "
|
|
9449
|
+
}), "\n", "if no component pattern is specified, all pending-merge components will be merged (run 'bit status' to list them).", (0, _react2.mdx)("br", {
|
|
9334
9450
|
parentName: "p"
|
|
9335
|
-
}), "\n", "
|
|
9451
|
+
}), "\n", "'bit status' will show diverged components and suggest either merging or resetting local changes.", (0, _react2.mdx)("br", {
|
|
9336
9452
|
parentName: "p"
|
|
9337
|
-
}), "\n", "
|
|
9453
|
+
}), "\n", "preferred approach: use 'bit reset' to remove local versions, then 'bit checkout head' to get remote versions.", (0, _react2.mdx)("br", {
|
|
9454
|
+
parentName: "p"
|
|
9455
|
+
}), "\n", "for lane-to-lane merging, use 'bit lane merge' instead."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9338
9456
|
parentName: "p"
|
|
9339
9457
|
}, "bit merge [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
9340
9458
|
parentName: "table"
|
|
@@ -9544,9 +9662,13 @@ function MDXContent(_ref) {
|
|
|
9544
9662
|
parentName: "p"
|
|
9545
9663
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
9546
9664
|
parentName: "p"
|
|
9547
|
-
}, "Description"), ":
|
|
9665
|
+
}, "Description"), ": relocate a component to a different directory", (0, _react2.mdx)("br", {
|
|
9666
|
+
parentName: "p"
|
|
9667
|
+
}), "\n", "moves component files to a new location within the workspace and updates the .bitmap tracking.", (0, _react2.mdx)("br", {
|
|
9548
9668
|
parentName: "p"
|
|
9549
|
-
}), "\n", "
|
|
9669
|
+
}), "\n", "only changes the filesystem location - does not affect the component's name, scope, or ID.", (0, _react2.mdx)("br", {
|
|
9670
|
+
parentName: "p"
|
|
9671
|
+
}), "\n", "useful for reorganizing workspace structure or following new directory conventions."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9550
9672
|
parentName: "p"
|
|
9551
9673
|
}, "bit move <current-component-dir> <new-component-dir>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
9552
9674
|
parentName: "table"
|
|
@@ -9586,7 +9708,13 @@ function MDXContent(_ref) {
|
|
|
9586
9708
|
"align": "center"
|
|
9587
9709
|
}, "the new directory (relative to the workspace root) to create and move the component's files to")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "new"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9588
9710
|
parentName: "p"
|
|
9589
|
-
}, "Description"), ": create a new workspace from a template"
|
|
9711
|
+
}, "Description"), ": create a new Bit workspace from a template", (0, _react2.mdx)("br", {
|
|
9712
|
+
parentName: "p"
|
|
9713
|
+
}), "\n", "initializes a new Bit workspace with pre-configured settings, environments, and optionally starter components.", (0, _react2.mdx)("br", {
|
|
9714
|
+
parentName: "p"
|
|
9715
|
+
}), "\n", "templates provide different setups for React, Angular, Node.js, or custom development workflows.", (0, _react2.mdx)("br", {
|
|
9716
|
+
parentName: "p"
|
|
9717
|
+
}), "\n", "installs dependencies and configures the workspace for immediate development."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9590
9718
|
parentName: "p"
|
|
9591
9719
|
}, "bit new <template-name> <workspace-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
9592
9720
|
parentName: "table"
|
|
@@ -9776,7 +9904,13 @@ function MDXContent(_ref) {
|
|
|
9776
9904
|
"align": null
|
|
9777
9905
|
}, "create the new workspace in current directory (default is to create a new directory, inside the current dir)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "npmrc"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9778
9906
|
parentName: "p"
|
|
9779
|
-
}, "Description"), ":
|
|
9907
|
+
}, "Description"), ": configure .npmrc file with Bit Cloud registry and authentication settings", (0, _react2.mdx)("br", {
|
|
9908
|
+
parentName: "p"
|
|
9909
|
+
}), "\n", "manages .npmrc configuration for seamless package installation from Bit Cloud registries.", (0, _react2.mdx)("br", {
|
|
9910
|
+
parentName: "p"
|
|
9911
|
+
}), "\n", "automatically configures scoped registries and authentication tokens for your workspace components.", (0, _react2.mdx)("br", {
|
|
9912
|
+
parentName: "p"
|
|
9913
|
+
}), "\n", "provides sub-commands for generating, updating, and managing npm registry configurations."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9780
9914
|
parentName: "p"
|
|
9781
9915
|
}, "bit npmrc [sub-command]")), (0, _react2.mdx)("h3", null, "npmrc generate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9782
9916
|
parentName: "p"
|
|
@@ -9835,7 +9969,7 @@ function MDXContent(_ref) {
|
|
|
9835
9969
|
"align": null
|
|
9836
9970
|
}, "force update the .npmrc file even if there are conflicts")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "pattern"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9837
9971
|
parentName: "p"
|
|
9838
|
-
}, "Description"), ":
|
|
9972
|
+
}, "Description"), ": test and validate component patterns", (0, _react2.mdx)("br", {
|
|
9839
9973
|
parentName: "p"
|
|
9840
9974
|
}), "\n", "this command helps validating a pattern before using it in other commands.", (0, _react2.mdx)("br", {
|
|
9841
9975
|
parentName: "p"
|
|
@@ -9906,7 +10040,9 @@ function MDXContent(_ref) {
|
|
|
9906
10040
|
"align": null
|
|
9907
10041
|
}, "return the output as JSON")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "recover"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9908
10042
|
parentName: "p"
|
|
9909
|
-
}, "Description"), ":
|
|
10043
|
+
}, "Description"), ": restore soft-deleted components", (0, _react2.mdx)("br", {
|
|
10044
|
+
parentName: "p"
|
|
10045
|
+
}), "\n", "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."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9910
10046
|
parentName: "p"
|
|
9911
10047
|
}, "bit recover <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
9912
10048
|
parentName: "table"
|
|
@@ -9959,7 +10095,13 @@ function MDXContent(_ref) {
|
|
|
9959
10095
|
"align": null
|
|
9960
10096
|
}, "do not write config files (such as eslint, tsconfig, prettier, etc...)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "refactor"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9961
10097
|
parentName: "p"
|
|
9962
|
-
}, "Description"), ":
|
|
10098
|
+
}, "Description"), ": automatically refactor component source code", (0, _react2.mdx)("br", {
|
|
10099
|
+
parentName: "p"
|
|
10100
|
+
}), "\n", "performs automated code transformations and refactoring operations across components.", (0, _react2.mdx)("br", {
|
|
10101
|
+
parentName: "p"
|
|
10102
|
+
}), "\n", "currently supports updating import/require statements when component names or dependencies change.", (0, _react2.mdx)("br", {
|
|
10103
|
+
parentName: "p"
|
|
10104
|
+
}), "\n", "useful for maintaining code consistency after renaming or restructuring components."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9963
10105
|
parentName: "p"
|
|
9964
10106
|
}, "bit refactor <sub-command>")), (0, _react2.mdx)("h3", null, "refactor dependency-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9965
10107
|
parentName: "p"
|
|
@@ -9975,7 +10117,13 @@ function MDXContent(_ref) {
|
|
|
9975
10117
|
parentName: "p"
|
|
9976
10118
|
}, "<new-id>"), " arguments can be either a component-id or a package-name."), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "remote"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9977
10119
|
parentName: "p"
|
|
9978
|
-
}, "Description"), ": manage
|
|
10120
|
+
}, "Description"), ": manage remote scopes for self-hosted environments", (0, _react2.mdx)("br", {
|
|
10121
|
+
parentName: "p"
|
|
10122
|
+
}), "\n", "configure connections to self-hosted remote scopes via HTTP or file protocol.", (0, _react2.mdx)("br", {
|
|
10123
|
+
parentName: "p"
|
|
10124
|
+
}), "\n", "note: this command is only needed for self-hosted scopes. when using bit.cloud, remote scopes are automatically configured.", (0, _react2.mdx)("br", {
|
|
10125
|
+
parentName: "p"
|
|
10126
|
+
}), "\n", "remotes are bare scopes that store exported components and enable collaboration across teams."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
9979
10127
|
parentName: "p"
|
|
9980
10128
|
}, "bit remote")), (0, _react2.mdx)("h3", null, "remote add"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
9981
10129
|
parentName: "p"
|
|
@@ -10151,9 +10299,13 @@ function MDXContent(_ref) {
|
|
|
10151
10299
|
parentName: "p"
|
|
10152
10300
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
10153
10301
|
parentName: "p"
|
|
10154
|
-
}, "Description"), ":
|
|
10302
|
+
}, "Description"), ": untrack components from the workspace", (0, _react2.mdx)("br", {
|
|
10155
10303
|
parentName: "p"
|
|
10156
|
-
}), "\n", "
|
|
10304
|
+
}), "\n", "removes components from the local workspace only - stops tracking them in .bitmap and deletes their files by default.", (0, _react2.mdx)("br", {
|
|
10305
|
+
parentName: "p"
|
|
10306
|
+
}), "\n", "does not affect remote scopes - to delete components from remotes, use \"bit delete\" instead.", (0, _react2.mdx)("br", {
|
|
10307
|
+
parentName: "p"
|
|
10308
|
+
}), "\n", "use --keep-files to preserve component files while only removing the tracking."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10157
10309
|
parentName: "p"
|
|
10158
10310
|
}, "bit remove <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
10159
10311
|
parentName: "table"
|
|
@@ -10266,7 +10418,13 @@ function MDXContent(_ref) {
|
|
|
10266
10418
|
"align": null
|
|
10267
10419
|
}, "skip confirmation")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
10268
10420
|
parentName: "p"
|
|
10269
|
-
}, "Description"), ":
|
|
10421
|
+
}, "Description"), ": change a component name", (0, _react2.mdx)("br", {
|
|
10422
|
+
parentName: "p"
|
|
10423
|
+
}), "\n", "renames a component and optionally refactors dependent code to use the new name.", (0, _react2.mdx)("br", {
|
|
10424
|
+
parentName: "p"
|
|
10425
|
+
}), "\n", "for exported components: creates a new component with the new name and marks the original as deleted.", (0, _react2.mdx)("br", {
|
|
10426
|
+
parentName: "p"
|
|
10427
|
+
}), "\n", "for local components: simply renames the existing component in place."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10270
10428
|
parentName: "p"
|
|
10271
10429
|
}, "bit rename <current-name> <new-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
10272
10430
|
parentName: "table"
|
|
@@ -10424,12 +10582,13 @@ function MDXContent(_ref) {
|
|
|
10424
10582
|
"align": null
|
|
10425
10583
|
}, "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")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "reset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
10426
10584
|
parentName: "p"
|
|
10427
|
-
}, "Description"), ": revert
|
|
10585
|
+
}, "Description"), ": revert local tags and snaps to previous versions", (0, _react2.mdx)("br", {
|
|
10428
10586
|
parentName: "p"
|
|
10429
|
-
}), "\n", (0, _react2.mdx)("
|
|
10430
|
-
parentName: "p"
|
|
10431
|
-
|
|
10432
|
-
|
|
10587
|
+
}), "\n", "removes local component versions (tags/snaps) that haven't been exported yet.", (0, _react2.mdx)("br", {
|
|
10588
|
+
parentName: "p"
|
|
10589
|
+
}), "\n", "by default reverts all local versions. use --head to revert only the latest version.", (0, _react2.mdx)("br", {
|
|
10590
|
+
parentName: "p"
|
|
10591
|
+
}), "\n", "useful for undoing mistakes before exporting. exported versions cannot be reset."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10433
10592
|
parentName: "p"
|
|
10434
10593
|
}, "bit reset [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
10435
10594
|
parentName: "table"
|
|
@@ -10553,7 +10712,11 @@ function MDXContent(_ref) {
|
|
|
10553
10712
|
"align": null
|
|
10554
10713
|
}, "reset only components that were never exported")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "revert"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
10555
10714
|
parentName: "p"
|
|
10556
|
-
}, "Description"), ": replace
|
|
10715
|
+
}, "Description"), ": replace component files with specified version while preserving current version", (0, _react2.mdx)("br", {
|
|
10716
|
+
parentName: "p"
|
|
10717
|
+
}), "\n", "replaces component source files with files from the specified version but keeps the current component version.", (0, _react2.mdx)("br", {
|
|
10718
|
+
parentName: "p"
|
|
10719
|
+
}), "\n", "useful for reverting file changes without changing the component's version history. different from checkout which changes the version."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10557
10720
|
parentName: "p"
|
|
10558
10721
|
}, "bit revert <component-pattern> <to>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
10559
10722
|
parentName: "table"
|
|
@@ -10654,7 +10817,13 @@ function MDXContent(_ref) {
|
|
|
10654
10817
|
parentName: "p"
|
|
10655
10818
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
10656
10819
|
parentName: "p"
|
|
10657
|
-
}, "Description"), ":
|
|
10820
|
+
}, "Description"), ": start an application component locally", (0, _react2.mdx)("br", {
|
|
10821
|
+
parentName: "p"
|
|
10822
|
+
}), "\n", "runs application components in their own development server, separate from the \"bit start\" UI.", (0, _react2.mdx)("br", {
|
|
10823
|
+
parentName: "p"
|
|
10824
|
+
}), "\n", "apps are components that create deployable applications (React apps, Node.js servers, etc.).", (0, _react2.mdx)("br", {
|
|
10825
|
+
parentName: "p"
|
|
10826
|
+
}), "\n", "when no app name is specified, automatically detects and runs the app if only one exists in the workspace."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10658
10827
|
parentName: "p"
|
|
10659
10828
|
}, "bit run [app-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
10660
10829
|
parentName: "table"
|
|
@@ -10795,11 +10964,13 @@ function MDXContent(_ref) {
|
|
|
10795
10964
|
"align": null
|
|
10796
10965
|
}, "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", {
|
|
10797
10966
|
parentName: "p"
|
|
10798
|
-
}, "Description"), ":
|
|
10967
|
+
}, "Description"), ": display component API schema and type definitions", (0, _react2.mdx)("br", {
|
|
10799
10968
|
parentName: "p"
|
|
10800
|
-
}), "\n", "
|
|
10969
|
+
}), "\n", "extracts and displays the public API structure of components including types, functions, classes, and interfaces.", (0, _react2.mdx)("br", {
|
|
10801
10970
|
parentName: "p"
|
|
10802
|
-
}), "\n", "
|
|
10971
|
+
}), "\n", "shows detailed type information, function signatures, and JSDoc documentation for exported elements.", (0, _react2.mdx)("br", {
|
|
10972
|
+
parentName: "p"
|
|
10973
|
+
}), "\n", "useful for understanding component interfaces and generating documentation."), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
|
|
10803
10974
|
parentName: "p"
|
|
10804
10975
|
}, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
|
|
10805
10976
|
parentName: "p"
|
|
@@ -10870,7 +11041,13 @@ function MDXContent(_ref) {
|
|
|
10870
11041
|
"align": null
|
|
10871
11042
|
}, "return the component schema in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
10872
11043
|
parentName: "p"
|
|
10873
|
-
}, "Description"), ": manage
|
|
11044
|
+
}, "Description"), ": manage component scope names and assignments", (0, _react2.mdx)("br", {
|
|
11045
|
+
parentName: "p"
|
|
11046
|
+
}), "\n", "configure scope assignments for components including setting default scopes and renaming existing scopes.", (0, _react2.mdx)("br", {
|
|
11047
|
+
parentName: "p"
|
|
11048
|
+
}), "\n", "scopes determine where components are stored and published, forming the first part of component IDs.", (0, _react2.mdx)("br", {
|
|
11049
|
+
parentName: "p"
|
|
11050
|
+
}), "\n", "essential for organizing components and managing component namespaces across teams."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
10874
11051
|
parentName: "p"
|
|
10875
11052
|
}, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
10876
11053
|
parentName: "p"
|
|
@@ -11252,7 +11429,13 @@ function MDXContent(_ref) {
|
|
|
11252
11429
|
"align": null
|
|
11253
11430
|
}, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "set-peer"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
11254
11431
|
parentName: "p"
|
|
11255
|
-
}, "Description"), ":
|
|
11432
|
+
}, "Description"), ": configure component to always be installed as peer dependency", (0, _react2.mdx)("br", {
|
|
11433
|
+
parentName: "p"
|
|
11434
|
+
}), "\n", "marks a component to always be treated as a peer dependency when used by other components.", (0, _react2.mdx)("br", {
|
|
11435
|
+
parentName: "p"
|
|
11436
|
+
}), "\n", "useful for shared libraries that should be provided by the consuming application.", (0, _react2.mdx)("br", {
|
|
11437
|
+
parentName: "p"
|
|
11438
|
+
}), "\n", "the specified version range will be used when adding this component as a peer dependency."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
11256
11439
|
parentName: "p"
|
|
11257
11440
|
}, "bit set-peer <component-id> <range>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
11258
11441
|
parentName: "table"
|
|
@@ -11290,9 +11473,15 @@ function MDXContent(_ref) {
|
|
|
11290
11473
|
}, "range")), (0, _react2.mdx)("td", {
|
|
11291
11474
|
parentName: "tr",
|
|
11292
11475
|
"align": "center"
|
|
11293
|
-
}, "the default range to use for the
|
|
11476
|
+
}, "the default range to use for the component, when added to peerDependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "show"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
11477
|
+
parentName: "p"
|
|
11478
|
+
}, "Description"), ": display component metadata, dependencies, and configuration", (0, _react2.mdx)("br", {
|
|
11479
|
+
parentName: "p"
|
|
11480
|
+
}), "\n", "shows detailed information about a component including its version, dependencies, environment, and other metadata.", (0, _react2.mdx)("br", {
|
|
11481
|
+
parentName: "p"
|
|
11482
|
+
}), "\n", "note: to see file changes made in a specific version, use ", (0, _react2.mdx)("inlineCode", {
|
|
11294
11483
|
parentName: "p"
|
|
11295
|
-
}, "
|
|
11484
|
+
}, "bit diff <component> <version> --parent"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
11296
11485
|
parentName: "p"
|
|
11297
11486
|
}, "bit show <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
11298
11487
|
parentName: "table"
|
|
@@ -11418,7 +11607,13 @@ function MDXContent(_ref) {
|
|
|
11418
11607
|
"align": null
|
|
11419
11608
|
}, "legacy-only. compare current file system component to its latest tagged version ", "[default=latest]")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "snap"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
11420
11609
|
parentName: "p"
|
|
11421
|
-
}, "Description"), ": create
|
|
11610
|
+
}, "Description"), ": create immutable component snapshots for development versions", (0, _react2.mdx)("br", {
|
|
11611
|
+
parentName: "p"
|
|
11612
|
+
}), "\n", "creates snapshots with hash-based versions for development and testing. snapshots are immutable and exportable.", (0, _react2.mdx)("br", {
|
|
11613
|
+
parentName: "p"
|
|
11614
|
+
}), "\n", "by default snaps only new and modified components. use for development iterations before creating semantic version tags.", (0, _react2.mdx)("br", {
|
|
11615
|
+
parentName: "p"
|
|
11616
|
+
}), "\n", "snapshots maintain component history and enable collaboration without formal releases."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
11422
11617
|
parentName: "p"
|
|
11423
11618
|
}, "bit snap [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
11424
11619
|
parentName: "table"
|
|
@@ -11682,7 +11877,13 @@ function MDXContent(_ref) {
|
|
|
11682
11877
|
parentName: "p"
|
|
11683
11878
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
11684
11879
|
parentName: "p"
|
|
11685
|
-
}, "Description"), ":
|
|
11880
|
+
}, "Description"), ": launch the Bit development server", (0, _react2.mdx)("br", {
|
|
11881
|
+
parentName: "p"
|
|
11882
|
+
}), "\n", "starts the local development server providing a UI to browse, preview, and interact with components.", (0, _react2.mdx)("br", {
|
|
11883
|
+
parentName: "p"
|
|
11884
|
+
}), "\n", "works in both workspaces and scopes. opens automatically in your browser at http://localhost:3000 (or specified port).", (0, _react2.mdx)("br", {
|
|
11885
|
+
parentName: "p"
|
|
11886
|
+
}), "\n", "includes hot module reloading for development."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
11686
11887
|
parentName: "p"
|
|
11687
11888
|
}, "bit start [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
11688
11889
|
parentName: "table"
|
|
@@ -11866,7 +12067,11 @@ function MDXContent(_ref) {
|
|
|
11866
12067
|
"align": null
|
|
11867
12068
|
}, "name of the ui root to use, e.g. \"teambit.scope/scope\" or \"teambit.workspace/workspace\"")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "stash"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
11868
12069
|
parentName: "p"
|
|
11869
|
-
}, "Description"), ":
|
|
12070
|
+
}, "Description"), ": temporarily save and restore component changes", (0, _react2.mdx)("br", {
|
|
12071
|
+
parentName: "p"
|
|
12072
|
+
}), "\n", "temporarily stores modified component files without creating versions.", (0, _react2.mdx)("br", {
|
|
12073
|
+
parentName: "p"
|
|
12074
|
+
}), "\n", "allows saving work-in-progress changes and switching context, then restoring changes later."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
11870
12075
|
parentName: "p"
|
|
11871
12076
|
}, "bit stash <sub-command>")), (0, _react2.mdx)("h3", null, "stash save"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
11872
12077
|
parentName: "p"
|
|
@@ -12092,7 +12297,13 @@ function MDXContent(_ref) {
|
|
|
12092
12297
|
parentName: "p"
|
|
12093
12298
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
12094
12299
|
parentName: "p"
|
|
12095
|
-
}, "Description"), ":
|
|
12300
|
+
}, "Description"), ": show workspace component status and issues", (0, _react2.mdx)("br", {
|
|
12301
|
+
parentName: "p"
|
|
12302
|
+
}), "\n", "displays the current state of all workspace components including new, modified, staged, and problematic components.", (0, _react2.mdx)("br", {
|
|
12303
|
+
parentName: "p"
|
|
12304
|
+
}), "\n", "identifies blocking issues that prevent tagging/snapping and provides warnings with --warnings flag.", (0, _react2.mdx)("br", {
|
|
12305
|
+
parentName: "p"
|
|
12306
|
+
}), "\n", "essential for understanding workspace health before versioning components."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12096
12307
|
parentName: "p"
|
|
12097
12308
|
}, "bit status")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
12098
12309
|
parentName: "table"
|
|
@@ -12216,7 +12427,11 @@ function MDXContent(_ref) {
|
|
|
12216
12427
|
"align": null
|
|
12217
12428
|
}, "do not check for circular dependencies to get the results quicker")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "system"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
12218
12429
|
parentName: "p"
|
|
12219
|
-
}, "Description"), ": system operations
|
|
12430
|
+
}, "Description"), ": access system-level operations and debugging tools", (0, _react2.mdx)("br", {
|
|
12431
|
+
parentName: "p"
|
|
12432
|
+
}), "\n", "provides commands for system-level operations including viewing and tailing debug logs.", (0, _react2.mdx)("br", {
|
|
12433
|
+
parentName: "p"
|
|
12434
|
+
}), "\n", "useful for troubleshooting issues and monitoring Bit's internal operations in real-time."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12220
12435
|
parentName: "p"
|
|
12221
12436
|
}, "bit system <sub-command>")), (0, _react2.mdx)("h3", null, "system log"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
12222
12437
|
parentName: "p"
|
|
@@ -12240,14 +12455,16 @@ function MDXContent(_ref) {
|
|
|
12240
12455
|
parentName: "p"
|
|
12241
12456
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
12242
12457
|
parentName: "p"
|
|
12243
|
-
}, "Description"), ": create
|
|
12458
|
+
}, "Description"), ": create immutable component snapshots with semantic version tags", (0, _react2.mdx)("br", {
|
|
12244
12459
|
parentName: "p"
|
|
12245
|
-
}), "\n", "
|
|
12460
|
+
}), "\n", "creates tagged versions using semantic versioning (semver) for component releases. tags are immutable and exportable.", (0, _react2.mdx)("br", {
|
|
12246
12461
|
parentName: "p"
|
|
12247
|
-
}), "\n", "
|
|
12462
|
+
}), "\n", "by default tags all new and modified components. supports version specification per pattern using \"@\" (e.g. ", (0, _react2.mdx)("a", {
|
|
12248
12463
|
parentName: "p",
|
|
12249
12464
|
"href": "mailto:foo@1.0.0"
|
|
12250
|
-
}, "foo@1.0.0"), " bar@minor
|
|
12465
|
+
}, "foo@1.0.0"), ", bar@minor).", (0, _react2.mdx)("br", {
|
|
12466
|
+
parentName: "p"
|
|
12467
|
+
}), "\n", "use for official releases. for development versions, use 'bit snap' instead."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12251
12468
|
parentName: "p"
|
|
12252
12469
|
}, "bit tag [component-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
12253
12470
|
parentName: "table"
|
|
@@ -12684,9 +12901,9 @@ function MDXContent(_ref) {
|
|
|
12684
12901
|
"align": null
|
|
12685
12902
|
}, "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "templates"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
12686
12903
|
parentName: "p"
|
|
12687
|
-
}, "Description"), ": list available templates for
|
|
12904
|
+
}, "Description"), ": list available templates for creating components and workspaces", (0, _react2.mdx)("br", {
|
|
12688
12905
|
parentName: "p"
|
|
12689
|
-
}), "\n", "
|
|
12906
|
+
}), "\n", "Lists available templates. Inside a workspace it shows component templates for 'bit create'; outside a workspace it shows workspace templates for 'bit new'."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12690
12907
|
parentName: "p"
|
|
12691
12908
|
}, "bit templates")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
12692
12909
|
parentName: "table"
|
|
@@ -12762,7 +12979,13 @@ function MDXContent(_ref) {
|
|
|
12762
12979
|
parentName: "p"
|
|
12763
12980
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
12764
12981
|
parentName: "p"
|
|
12765
|
-
}, "Description"), ":
|
|
12982
|
+
}, "Description"), ": run component tests", (0, _react2.mdx)("br", {
|
|
12983
|
+
parentName: "p"
|
|
12984
|
+
}), "\n", "executes tests using the testing framework configured by each component's environment (Jest, Mocha, etc.).", (0, _react2.mdx)("br", {
|
|
12985
|
+
parentName: "p"
|
|
12986
|
+
}), "\n", "by default only runs tests for new and modified components. use --unmodified to test all components.", (0, _react2.mdx)("br", {
|
|
12987
|
+
parentName: "p"
|
|
12988
|
+
}), "\n", "supports watch mode, coverage reporting, and debug mode for development workflows."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12766
12989
|
parentName: "p"
|
|
12767
12990
|
}, "bit test [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
12768
12991
|
parentName: "table"
|
|
@@ -12961,7 +13184,9 @@ function MDXContent(_ref) {
|
|
|
12961
13184
|
"align": null
|
|
12962
13185
|
}, "return the results in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "undeprecate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
12963
13186
|
parentName: "p"
|
|
12964
|
-
}, "Description"), ":
|
|
13187
|
+
}, "Description"), ": remove the deprecation status from a component", (0, _react2.mdx)("br", {
|
|
13188
|
+
parentName: "p"
|
|
13189
|
+
}), "\n", "reverses the deprecation of a component, removing warnings and allowing normal use again."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12965
13190
|
parentName: "p"
|
|
12966
13191
|
}, "bit undeprecate <id>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "uninstall"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
12967
13192
|
parentName: "p"
|
|
@@ -12971,13 +13196,11 @@ function MDXContent(_ref) {
|
|
|
12971
13196
|
parentName: "p"
|
|
12972
13197
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
12973
13198
|
parentName: "p"
|
|
12974
|
-
}, "Description"), ":
|
|
13199
|
+
}, "Description"), ": remove dependencies from workspace", (0, _react2.mdx)("br", {
|
|
12975
13200
|
parentName: "p"
|
|
12976
|
-
}, "
|
|
13201
|
+
}), "\n", "removes specified packages from workspace.jsonc dependency policy and runs install to update node_modules."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
12977
13202
|
parentName: "p"
|
|
12978
|
-
}, "
|
|
12979
|
-
parentName: "p"
|
|
12980
|
-
}, "bit unset-peer <component-id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13203
|
+
}, "bit uninstall [packages...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
12981
13204
|
parentName: "table"
|
|
12982
13205
|
}, (0, _react2.mdx)("tr", {
|
|
12983
13206
|
parentName: "thead"
|
|
@@ -13000,20 +13223,18 @@ function MDXContent(_ref) {
|
|
|
13000
13223
|
"align": null
|
|
13001
13224
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13002
13225
|
parentName: "td"
|
|
13003
|
-
}, "
|
|
13226
|
+
}, "packages...")), (0, _react2.mdx)("td", {
|
|
13004
13227
|
parentName: "tr",
|
|
13005
13228
|
"align": "center"
|
|
13006
|
-
}, "
|
|
13007
|
-
parentName: "p"
|
|
13008
|
-
}, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
13229
|
+
}, "list of package names to remove from workspace dependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "unset-peer"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13009
13230
|
parentName: "p"
|
|
13010
|
-
}, "
|
|
13231
|
+
}, "Description"), ": remove always-peer configuration from component", (0, _react2.mdx)("br", {
|
|
13011
13232
|
parentName: "p"
|
|
13012
|
-
}), "\n", (0, _react2.mdx)("
|
|
13233
|
+
}), "\n", "removes the always-peer marking from a component, allowing it to be installed as a regular dependency.", (0, _react2.mdx)("br", {
|
|
13013
13234
|
parentName: "p"
|
|
13014
|
-
}, "
|
|
13235
|
+
}), "\n", "reverses the effect of 'bit set-peer' command. the component will be treated normally in dependency resolution."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13015
13236
|
parentName: "p"
|
|
13016
|
-
}, "bit
|
|
13237
|
+
}, "bit unset-peer <component-id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13017
13238
|
parentName: "table"
|
|
13018
13239
|
}, (0, _react2.mdx)("tr", {
|
|
13019
13240
|
parentName: "thead"
|
|
@@ -13036,12 +13257,26 @@ function MDXContent(_ref) {
|
|
|
13036
13257
|
"align": null
|
|
13037
13258
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13038
13259
|
parentName: "td"
|
|
13039
|
-
}, "
|
|
13260
|
+
}, "component-id")), (0, _react2.mdx)("td", {
|
|
13040
13261
|
parentName: "tr",
|
|
13041
13262
|
"align": "center"
|
|
13042
|
-
}, "
|
|
13043
|
-
parentName: "
|
|
13044
|
-
}, "
|
|
13263
|
+
}, "the component to unset as always peer")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13264
|
+
parentName: "p"
|
|
13265
|
+
}, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
13266
|
+
parentName: "p"
|
|
13267
|
+
}, "up"), (0, _react2.mdx)("br", {
|
|
13268
|
+
parentName: "p"
|
|
13269
|
+
}), "\n", (0, _react2.mdx)("strong", {
|
|
13270
|
+
parentName: "p"
|
|
13271
|
+
}, "Description"), ": update workspace dependencies to newer versions", (0, _react2.mdx)("br", {
|
|
13272
|
+
parentName: "p"
|
|
13273
|
+
}), "\n", "updates dependencies in workspace.jsonc to newer versions and runs install to apply changes.", (0, _react2.mdx)("br", {
|
|
13274
|
+
parentName: "p"
|
|
13275
|
+
}), "\n", "by default, updates to highest semver-compatible versions. use --major, --minor, or --patch for specific version types.", (0, _react2.mdx)("br", {
|
|
13276
|
+
parentName: "p"
|
|
13277
|
+
}), "\n", "supports glob patterns to update specific packages. prompts for confirmation unless --yes is specified."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13278
|
+
parentName: "p"
|
|
13279
|
+
}, "bit update [package-patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13045
13280
|
parentName: "table"
|
|
13046
13281
|
}, (0, _react2.mdx)("tr", {
|
|
13047
13282
|
parentName: "thead"
|
|
@@ -13050,108 +13285,11 @@ function MDXContent(_ref) {
|
|
|
13050
13285
|
"align": null
|
|
13051
13286
|
}, (0, _react2.mdx)("strong", {
|
|
13052
13287
|
parentName: "th"
|
|
13053
|
-
}, "
|
|
13054
|
-
parentName: "tr",
|
|
13055
|
-
"align": "center"
|
|
13056
|
-
}, (0, _react2.mdx)("strong", {
|
|
13057
|
-
parentName: "th"
|
|
13058
|
-
}, "Option alias")), (0, _react2.mdx)("th", {
|
|
13059
|
-
parentName: "tr",
|
|
13060
|
-
"align": null
|
|
13061
|
-
}, (0, _react2.mdx)("strong", {
|
|
13062
|
-
parentName: "th"
|
|
13063
|
-
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
13064
|
-
parentName: "table"
|
|
13065
|
-
}, (0, _react2.mdx)("tr", {
|
|
13066
|
-
parentName: "tbody"
|
|
13067
|
-
}, (0, _react2.mdx)("td", {
|
|
13068
|
-
parentName: "tr",
|
|
13069
|
-
"align": null
|
|
13070
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13071
|
-
parentName: "td"
|
|
13072
|
-
}, "--yes")), (0, _react2.mdx)("td", {
|
|
13073
|
-
parentName: "tr",
|
|
13074
|
-
"align": "center"
|
|
13075
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13076
|
-
parentName: "td"
|
|
13077
|
-
}, "-y")), (0, _react2.mdx)("td", {
|
|
13078
|
-
parentName: "tr",
|
|
13079
|
-
"align": null
|
|
13080
|
-
}, "automatically update all outdated versions for packages specified in pattern (all if no pattern supplied) - use carefully as could result in breaking updates for dependencies")), (0, _react2.mdx)("tr", {
|
|
13081
|
-
parentName: "tbody"
|
|
13082
|
-
}, (0, _react2.mdx)("td", {
|
|
13083
|
-
parentName: "tr",
|
|
13084
|
-
"align": null
|
|
13085
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13086
|
-
parentName: "td"
|
|
13087
|
-
}, "--patch")), (0, _react2.mdx)("td", {
|
|
13088
|
-
parentName: "tr",
|
|
13089
|
-
"align": "center"
|
|
13090
|
-
}), (0, _react2.mdx)("td", {
|
|
13091
|
-
parentName: "tr",
|
|
13092
|
-
"align": null
|
|
13093
|
-
}, "update to the latest patch version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13094
|
-
parentName: "tbody"
|
|
13095
|
-
}, (0, _react2.mdx)("td", {
|
|
13096
|
-
parentName: "tr",
|
|
13097
|
-
"align": null
|
|
13098
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13099
|
-
parentName: "td"
|
|
13100
|
-
}, "--minor")), (0, _react2.mdx)("td", {
|
|
13101
|
-
parentName: "tr",
|
|
13102
|
-
"align": "center"
|
|
13103
|
-
}), (0, _react2.mdx)("td", {
|
|
13104
|
-
parentName: "tr",
|
|
13105
|
-
"align": null
|
|
13106
|
-
}, "update to the latest minor version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13107
|
-
parentName: "tbody"
|
|
13108
|
-
}, (0, _react2.mdx)("td", {
|
|
13109
|
-
parentName: "tr",
|
|
13110
|
-
"align": null
|
|
13111
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13112
|
-
parentName: "td"
|
|
13113
|
-
}, "--major")), (0, _react2.mdx)("td", {
|
|
13114
|
-
parentName: "tr",
|
|
13115
|
-
"align": "center"
|
|
13116
|
-
}), (0, _react2.mdx)("td", {
|
|
13117
|
-
parentName: "tr",
|
|
13118
|
-
"align": null
|
|
13119
|
-
}, "update to the latest major version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13120
|
-
parentName: "tbody"
|
|
13121
|
-
}, (0, _react2.mdx)("td", {
|
|
13122
|
-
parentName: "tr",
|
|
13123
|
-
"align": null
|
|
13124
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13125
|
-
parentName: "td"
|
|
13126
|
-
}, "--semver")), (0, _react2.mdx)("td", {
|
|
13127
|
-
parentName: "tr",
|
|
13128
|
-
"align": "center"
|
|
13129
|
-
}), (0, _react2.mdx)("td", {
|
|
13130
|
-
parentName: "tr",
|
|
13131
|
-
"align": null
|
|
13132
|
-
}, "update to the newest version respecting semver")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13133
|
-
parentName: "p"
|
|
13134
|
-
}, "Description"), ": shows bit version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13135
|
-
parentName: "p"
|
|
13136
|
-
}, "bit version")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13137
|
-
parentName: "table"
|
|
13138
|
-
}, (0, _react2.mdx)("tr", {
|
|
13139
|
-
parentName: "thead"
|
|
13140
|
-
}, (0, _react2.mdx)("th", {
|
|
13141
|
-
parentName: "tr",
|
|
13142
|
-
"align": null
|
|
13143
|
-
}, (0, _react2.mdx)("strong", {
|
|
13144
|
-
parentName: "th"
|
|
13145
|
-
}, "Option")), (0, _react2.mdx)("th", {
|
|
13288
|
+
}, "Arg")), (0, _react2.mdx)("th", {
|
|
13146
13289
|
parentName: "tr",
|
|
13147
13290
|
"align": "center"
|
|
13148
13291
|
}, (0, _react2.mdx)("strong", {
|
|
13149
13292
|
parentName: "th"
|
|
13150
|
-
}, "Option alias")), (0, _react2.mdx)("th", {
|
|
13151
|
-
parentName: "tr",
|
|
13152
|
-
"align": null
|
|
13153
|
-
}, (0, _react2.mdx)("strong", {
|
|
13154
|
-
parentName: "th"
|
|
13155
13293
|
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
13156
13294
|
parentName: "table"
|
|
13157
13295
|
}, (0, _react2.mdx)("tr", {
|
|
@@ -13161,31 +13299,12 @@ function MDXContent(_ref) {
|
|
|
13161
13299
|
"align": null
|
|
13162
13300
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13163
13301
|
parentName: "td"
|
|
13164
|
-
}, "
|
|
13302
|
+
}, "package-patterns...")), (0, _react2.mdx)("td", {
|
|
13165
13303
|
parentName: "tr",
|
|
13166
13304
|
"align": "center"
|
|
13167
|
-
}, (0, _react2.mdx)("
|
|
13305
|
+
}, "a string list of package names, or patterns (separated by spaces or commas), e.g. \"@teambit/", (0, _react2.mdx)("strong", {
|
|
13168
13306
|
parentName: "td"
|
|
13169
|
-
}, "-
|
|
13170
|
-
parentName: "tr",
|
|
13171
|
-
"align": null
|
|
13172
|
-
}, "return the version in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "version-history"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13173
|
-
parentName: "p"
|
|
13174
|
-
}, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
13175
|
-
parentName: "p"
|
|
13176
|
-
}, "vh"), (0, _react2.mdx)("br", {
|
|
13177
|
-
parentName: "p"
|
|
13178
|
-
}), "\n", (0, _react2.mdx)("strong", {
|
|
13179
|
-
parentName: "p"
|
|
13180
|
-
}, "Description"), ": manage the version-history of components"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13181
|
-
parentName: "p"
|
|
13182
|
-
}, "bit version-history <sub-command>")), (0, _react2.mdx)("h3", null, "version-history graph"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13183
|
-
parentName: "p"
|
|
13184
|
-
}, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
13185
|
-
parentName: "p"
|
|
13186
|
-
}, "version-history graph <component-id>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13187
|
-
parentName: "p"
|
|
13188
|
-
}, "Description"), ": generate a graph of the version history of a component and save as an SVG file"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13307
|
+
}, ",@my-org/ui."), "\". The patterns should be in glob format. By default, all packages are selected.")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13189
13308
|
parentName: "table"
|
|
13190
13309
|
}, (0, _react2.mdx)("tr", {
|
|
13191
13310
|
parentName: "thead"
|
|
@@ -13213,77 +13332,71 @@ function MDXContent(_ref) {
|
|
|
13213
13332
|
"align": null
|
|
13214
13333
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13215
13334
|
parentName: "td"
|
|
13216
|
-
}, "--
|
|
13335
|
+
}, "--yes")), (0, _react2.mdx)("td", {
|
|
13217
13336
|
parentName: "tr",
|
|
13218
13337
|
"align": "center"
|
|
13219
13338
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13220
13339
|
parentName: "td"
|
|
13221
|
-
}, "-
|
|
13340
|
+
}, "-y")), (0, _react2.mdx)("td", {
|
|
13222
13341
|
parentName: "tr",
|
|
13223
13342
|
"align": null
|
|
13224
|
-
}, "
|
|
13343
|
+
}, "automatically update all outdated versions for packages specified in pattern (all if no pattern supplied) - use carefully as could result in breaking updates for dependencies")), (0, _react2.mdx)("tr", {
|
|
13225
13344
|
parentName: "tbody"
|
|
13226
13345
|
}, (0, _react2.mdx)("td", {
|
|
13227
13346
|
parentName: "tr",
|
|
13228
13347
|
"align": null
|
|
13229
13348
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13230
13349
|
parentName: "td"
|
|
13231
|
-
}, "--
|
|
13350
|
+
}, "--patch")), (0, _react2.mdx)("td", {
|
|
13232
13351
|
parentName: "tr",
|
|
13233
13352
|
"align": "center"
|
|
13234
|
-
}, (0, _react2.mdx)("
|
|
13235
|
-
parentName: "td"
|
|
13236
|
-
}, "-m")), (0, _react2.mdx)("td", {
|
|
13353
|
+
}), (0, _react2.mdx)("td", {
|
|
13237
13354
|
parentName: "tr",
|
|
13238
13355
|
"align": null
|
|
13239
|
-
}, "
|
|
13356
|
+
}, "update to the latest patch version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13240
13357
|
parentName: "tbody"
|
|
13241
13358
|
}, (0, _react2.mdx)("td", {
|
|
13242
13359
|
parentName: "tr",
|
|
13243
13360
|
"align": null
|
|
13244
13361
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13245
13362
|
parentName: "td"
|
|
13246
|
-
}, "--
|
|
13363
|
+
}, "--minor")), (0, _react2.mdx)("td", {
|
|
13247
13364
|
parentName: "tr",
|
|
13248
13365
|
"align": "center"
|
|
13249
13366
|
}), (0, _react2.mdx)("td", {
|
|
13250
13367
|
parentName: "tr",
|
|
13251
13368
|
"align": null
|
|
13252
|
-
}, "
|
|
13369
|
+
}, "update to the latest minor version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13253
13370
|
parentName: "tbody"
|
|
13254
13371
|
}, (0, _react2.mdx)("td", {
|
|
13255
13372
|
parentName: "tr",
|
|
13256
13373
|
"align": null
|
|
13257
13374
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13258
13375
|
parentName: "td"
|
|
13259
|
-
}, "--
|
|
13376
|
+
}, "--major")), (0, _react2.mdx)("td", {
|
|
13260
13377
|
parentName: "tr",
|
|
13261
13378
|
"align": "center"
|
|
13262
|
-
}, (0, _react2.mdx)("
|
|
13263
|
-
parentName: "td"
|
|
13264
|
-
}, "-l")), (0, _react2.mdx)("td", {
|
|
13379
|
+
}), (0, _react2.mdx)("td", {
|
|
13265
13380
|
parentName: "tr",
|
|
13266
13381
|
"align": null
|
|
13267
|
-
}, "
|
|
13382
|
+
}, "update to the latest major version. Semver rules are ignored")), (0, _react2.mdx)("tr", {
|
|
13268
13383
|
parentName: "tbody"
|
|
13269
13384
|
}, (0, _react2.mdx)("td", {
|
|
13270
13385
|
parentName: "tr",
|
|
13271
13386
|
"align": null
|
|
13272
13387
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13273
13388
|
parentName: "td"
|
|
13274
|
-
}, "--
|
|
13389
|
+
}, "--semver")), (0, _react2.mdx)("td", {
|
|
13275
13390
|
parentName: "tr",
|
|
13276
13391
|
"align": "center"
|
|
13277
13392
|
}), (0, _react2.mdx)("td", {
|
|
13278
13393
|
parentName: "tr",
|
|
13279
13394
|
"align": null
|
|
13280
|
-
}, "
|
|
13281
|
-
parentName: "p"
|
|
13282
|
-
}, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
13395
|
+
}, "update to the newest version respecting semver")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13283
13396
|
parentName: "p"
|
|
13284
|
-
}, "
|
|
13397
|
+
}, "Description"), ": display the installed Bit version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13285
13398
|
parentName: "p"
|
|
13286
|
-
}, "
|
|
13399
|
+
}, "bit version")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13287
13400
|
parentName: "table"
|
|
13288
13401
|
}, (0, _react2.mdx)("tr", {
|
|
13289
13402
|
parentName: "thead"
|
|
@@ -13311,21 +13424,6 @@ function MDXContent(_ref) {
|
|
|
13311
13424
|
"align": null
|
|
13312
13425
|
}, (0, _react2.mdx)("inlineCode", {
|
|
13313
13426
|
parentName: "td"
|
|
13314
|
-
}, "--short-hash")), (0, _react2.mdx)("td", {
|
|
13315
|
-
parentName: "tr",
|
|
13316
|
-
"align": "center"
|
|
13317
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13318
|
-
parentName: "td"
|
|
13319
|
-
}, "-s")), (0, _react2.mdx)("td", {
|
|
13320
|
-
parentName: "tr",
|
|
13321
|
-
"align": null
|
|
13322
|
-
}, "show only 9 chars of the hash")), (0, _react2.mdx)("tr", {
|
|
13323
|
-
parentName: "tbody"
|
|
13324
|
-
}, (0, _react2.mdx)("td", {
|
|
13325
|
-
parentName: "tr",
|
|
13326
|
-
"align": null
|
|
13327
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13328
|
-
parentName: "td"
|
|
13329
13427
|
}, "--json")), (0, _react2.mdx)("td", {
|
|
13330
13428
|
parentName: "tr",
|
|
13331
13429
|
"align": "center"
|
|
@@ -13334,122 +13432,15 @@ function MDXContent(_ref) {
|
|
|
13334
13432
|
}, "-j")), (0, _react2.mdx)("td", {
|
|
13335
13433
|
parentName: "tr",
|
|
13336
13434
|
"align": null
|
|
13337
|
-
}, "json format")))), (0, _react2.mdx)("
|
|
13435
|
+
}, "return the version in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13338
13436
|
parentName: "p"
|
|
13339
|
-
}, "
|
|
13437
|
+
}, "Description"), ": watch and compile components on file changes", (0, _react2.mdx)("br", {
|
|
13340
13438
|
parentName: "p"
|
|
13341
|
-
}, "
|
|
13439
|
+
}), "\n", "monitors component files for changes and automatically recompiles them using their environment's configured compiler.", (0, _react2.mdx)("br", {
|
|
13342
13440
|
parentName: "p"
|
|
13343
|
-
}, "
|
|
13344
|
-
parentName: "table"
|
|
13345
|
-
}, (0, _react2.mdx)("tr", {
|
|
13346
|
-
parentName: "thead"
|
|
13347
|
-
}, (0, _react2.mdx)("th", {
|
|
13348
|
-
parentName: "tr",
|
|
13349
|
-
"align": null
|
|
13350
|
-
}, (0, _react2.mdx)("strong", {
|
|
13351
|
-
parentName: "th"
|
|
13352
|
-
}, "Arg")), (0, _react2.mdx)("th", {
|
|
13353
|
-
parentName: "tr",
|
|
13354
|
-
"align": "center"
|
|
13355
|
-
}, (0, _react2.mdx)("strong", {
|
|
13356
|
-
parentName: "th"
|
|
13357
|
-
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
13358
|
-
parentName: "table"
|
|
13359
|
-
}, (0, _react2.mdx)("tr", {
|
|
13360
|
-
parentName: "tbody"
|
|
13361
|
-
}, (0, _react2.mdx)("td", {
|
|
13362
|
-
parentName: "tr",
|
|
13363
|
-
"align": null
|
|
13364
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13365
|
-
parentName: "td"
|
|
13366
|
-
}, "component-pattern")), (0, _react2.mdx)("td", {
|
|
13367
|
-
parentName: "tr",
|
|
13368
|
-
"align": "center"
|
|
13369
|
-
}, "component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use ", (0, _react2.mdx)("inlineCode", {
|
|
13370
|
-
parentName: "td"
|
|
13371
|
-
}, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
|
|
13372
|
-
parentName: "td"
|
|
13373
|
-
}, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13374
|
-
parentName: "table"
|
|
13375
|
-
}, (0, _react2.mdx)("tr", {
|
|
13376
|
-
parentName: "thead"
|
|
13377
|
-
}, (0, _react2.mdx)("th", {
|
|
13378
|
-
parentName: "tr",
|
|
13379
|
-
"align": null
|
|
13380
|
-
}, (0, _react2.mdx)("strong", {
|
|
13381
|
-
parentName: "th"
|
|
13382
|
-
}, "Option")), (0, _react2.mdx)("th", {
|
|
13383
|
-
parentName: "tr",
|
|
13384
|
-
"align": "center"
|
|
13385
|
-
}, (0, _react2.mdx)("strong", {
|
|
13386
|
-
parentName: "th"
|
|
13387
|
-
}, "Option alias")), (0, _react2.mdx)("th", {
|
|
13388
|
-
parentName: "tr",
|
|
13389
|
-
"align": null
|
|
13390
|
-
}, (0, _react2.mdx)("strong", {
|
|
13391
|
-
parentName: "th"
|
|
13392
|
-
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
13393
|
-
parentName: "table"
|
|
13394
|
-
}, (0, _react2.mdx)("tr", {
|
|
13395
|
-
parentName: "tbody"
|
|
13396
|
-
}, (0, _react2.mdx)("td", {
|
|
13397
|
-
parentName: "tr",
|
|
13398
|
-
"align": null
|
|
13399
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13400
|
-
parentName: "td"
|
|
13401
|
-
}, "--from-snap <snap>")), (0, _react2.mdx)("td", {
|
|
13402
|
-
parentName: "tr",
|
|
13403
|
-
"align": "center"
|
|
13404
|
-
}), (0, _react2.mdx)("td", {
|
|
13405
|
-
parentName: "tr",
|
|
13406
|
-
"align": null
|
|
13407
|
-
}, "build the version history from a specific snap. the pattern must be a single component-id")), (0, _react2.mdx)("tr", {
|
|
13408
|
-
parentName: "tbody"
|
|
13409
|
-
}, (0, _react2.mdx)("td", {
|
|
13410
|
-
parentName: "tr",
|
|
13411
|
-
"align": null
|
|
13412
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13413
|
-
parentName: "td"
|
|
13414
|
-
}, "--from-all-lanes")), (0, _react2.mdx)("td", {
|
|
13415
|
-
parentName: "tr",
|
|
13416
|
-
"align": "center"
|
|
13417
|
-
}), (0, _react2.mdx)("td", {
|
|
13418
|
-
parentName: "tr",
|
|
13419
|
-
"align": null
|
|
13420
|
-
}, "build the version history from the heads of all lanes that include this component")), (0, _react2.mdx)("tr", {
|
|
13421
|
-
parentName: "tbody"
|
|
13422
|
-
}, (0, _react2.mdx)("td", {
|
|
13423
|
-
parentName: "tr",
|
|
13424
|
-
"align": null
|
|
13425
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13426
|
-
parentName: "td"
|
|
13427
|
-
}, "--delete-existing")), (0, _react2.mdx)("td", {
|
|
13428
|
-
parentName: "tr",
|
|
13429
|
-
"align": "center"
|
|
13430
|
-
}), (0, _react2.mdx)("td", {
|
|
13431
|
-
parentName: "tr",
|
|
13432
|
-
"align": null
|
|
13433
|
-
}, "delete the existing version history before building it")), (0, _react2.mdx)("tr", {
|
|
13434
|
-
parentName: "tbody"
|
|
13435
|
-
}, (0, _react2.mdx)("td", {
|
|
13436
|
-
parentName: "tr",
|
|
13437
|
-
"align": null
|
|
13438
|
-
}, (0, _react2.mdx)("inlineCode", {
|
|
13439
|
-
parentName: "td"
|
|
13440
|
-
}, "--remote <scope>")), (0, _react2.mdx)("td", {
|
|
13441
|
-
parentName: "tr",
|
|
13442
|
-
"align": "center"
|
|
13443
|
-
}), (0, _react2.mdx)("td", {
|
|
13444
|
-
parentName: "tr",
|
|
13445
|
-
"align": null
|
|
13446
|
-
}, "make the change on the remote scope")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "watch"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13447
|
-
parentName: "p"
|
|
13448
|
-
}, "Description"), ": automatically recompile modified components (on save)", (0, _react2.mdx)("br", {
|
|
13441
|
+
}), "\n", "enables immediate feedback during development by keeping components compiled as you work.", (0, _react2.mdx)("br", {
|
|
13449
13442
|
parentName: "p"
|
|
13450
|
-
}), "\n", "by default
|
|
13451
|
-
parentName: "p"
|
|
13452
|
-
}), "\n", "if this doesn't work well for you, run \"bit config set watch_use_polling true\" to use polling."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13443
|
+
}), "\n", "by default uses file system events (not polling) to minimize CPU usage - enable polling with \"bit config set watch_use_polling true\" if needed."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13453
13444
|
parentName: "p"
|
|
13454
13445
|
}, "bit watch")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13455
13446
|
parentName: "table"
|
|
@@ -13571,11 +13562,23 @@ function MDXContent(_ref) {
|
|
|
13571
13562
|
"align": null
|
|
13572
13563
|
}, "trigger recompilation of the specified component regardless of what changed. helpful when this comp-id must be a bundle")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "whoami"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13573
13564
|
parentName: "p"
|
|
13574
|
-
}, "Description"), ": display the currently
|
|
13565
|
+
}, "Description"), ": display the currently authenticated Bit Cloud user", (0, _react2.mdx)("br", {
|
|
13566
|
+
parentName: "p"
|
|
13567
|
+
}), "\n", "shows the username of the currently logged in Bit Cloud account.", (0, _react2.mdx)("br", {
|
|
13568
|
+
parentName: "p"
|
|
13569
|
+
}), "\n", "verifies authentication status with the cloud service and displays the active username.", (0, _react2.mdx)("br", {
|
|
13570
|
+
parentName: "p"
|
|
13571
|
+
}), "\n", "useful for confirming authentication before publishing or when switching between accounts."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13575
13572
|
parentName: "p"
|
|
13576
13573
|
}, "bit whoami")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "why"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13577
13574
|
parentName: "p"
|
|
13578
|
-
}, "Description"), ": find components that use the specified dependency"
|
|
13575
|
+
}, "Description"), ": find components that use the specified dependency", (0, _react2.mdx)("br", {
|
|
13576
|
+
parentName: "p"
|
|
13577
|
+
}), "\n", "searches workspace components to find which ones depend on the specified package or component.", (0, _react2.mdx)("br", {
|
|
13578
|
+
parentName: "p"
|
|
13579
|
+
}), "\n", "useful for understanding dependency usage before removing packages or when refactoring components.", (0, _react2.mdx)("br", {
|
|
13580
|
+
parentName: "p"
|
|
13581
|
+
}), "\n", "supports both exact version matching and package name patterns."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13579
13582
|
parentName: "p"
|
|
13580
13583
|
}, "bit why <dependency-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
13581
13584
|
parentName: "table"
|
|
@@ -13645,7 +13648,13 @@ function MDXContent(_ref) {
|
|
|
13645
13648
|
parentName: "p"
|
|
13646
13649
|
}), "\n", (0, _react2.mdx)("strong", {
|
|
13647
13650
|
parentName: "p"
|
|
13648
|
-
}, "Description"), ":
|
|
13651
|
+
}, "Description"), ": generate IDE configuration files", (0, _react2.mdx)("br", {
|
|
13652
|
+
parentName: "p"
|
|
13653
|
+
}), "\n", "writes configuration files (tsconfig.json, eslintrc.js, etc.) to your workspace for better IDE support.", (0, _react2.mdx)("br", {
|
|
13654
|
+
parentName: "p"
|
|
13655
|
+
}), "\n", "automatically generates configs based on your components' environments and settings.", (0, _react2.mdx)("br", {
|
|
13656
|
+
parentName: "p"
|
|
13657
|
+
}), "\n", "useful for enabling proper IntelliSense, linting, and type-checking in your IDE."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
13649
13658
|
parentName: "p"
|
|
13650
13659
|
}, "bit ws-config <sub-command>")), (0, _react2.mdx)("h3", null, "ws-config write"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
13651
13660
|
parentName: "p"
|