@teambit/harmony.content.cli-reference 2.0.984 → 2.0.986
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 +51 -51
- package/cli-reference.mdx +171 -171
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +51 -51
- package/dist/cli-reference.mdx.js +169 -169
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1775582642866.js → preview-1775595031658.js} +2 -2
- package/package.json +2 -2
package/cli-reference.mdx
CHANGED
|
@@ -91,9 +91,9 @@ use --out-dir to download artifacts locally for inspection or deployment purpose
|
|
|
91
91
|
|
|
92
92
|
`bit artifacts <component-pattern>`
|
|
93
93
|
|
|
94
|
-
| **Arg** |
|
|
95
|
-
| ------------------- |
|
|
96
|
-
| `component-pattern` | component name, component id, or
|
|
94
|
+
| **Arg** | **Description** |
|
|
95
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
96
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
97
97
|
|
|
98
98
|
| **Option** | **Option alias** | **Description** |
|
|
99
99
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -119,9 +119,9 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
119
119
|
|
|
120
120
|
**Description**: list all aspects configured on component(s)
|
|
121
121
|
|
|
122
|
-
| **Arg** |
|
|
123
|
-
| --------- |
|
|
124
|
-
| `pattern` | component name, component id, or
|
|
122
|
+
| **Arg** | **Description** |
|
|
123
|
+
| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
124
|
+
| `pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
125
125
|
|
|
126
126
|
| **Option** | **Option alias** | **Description** |
|
|
127
127
|
| ---------- | :--------------: | -------------------------------------------------- |
|
|
@@ -133,9 +133,9 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
133
133
|
|
|
134
134
|
**Description**: list all core aspects
|
|
135
135
|
|
|
136
|
-
| **Arg** |
|
|
137
|
-
| --------- |
|
|
138
|
-
| `pattern` | component name, component id, or
|
|
136
|
+
| **Arg** | **Description** |
|
|
137
|
+
| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
138
|
+
| `pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
139
139
|
|
|
140
140
|
| **Option** | **Option alias** | **Description** |
|
|
141
141
|
| ---------- | :--------------: | --------------- |
|
|
@@ -162,11 +162,11 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
162
162
|
|
|
163
163
|
**Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
|
|
164
164
|
|
|
165
|
-
| **Arg** |
|
|
166
|
-
| ----------- |
|
|
167
|
-
| `pattern` | the components to extend. component name, component id, or
|
|
168
|
-
| `aspect-id` |
|
|
169
|
-
| `config` |
|
|
165
|
+
| **Arg** | **Description** |
|
|
166
|
+
| ----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
167
|
+
| `pattern` | the components to extend. component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
168
|
+
| `aspect-id` | the aspect's component id |
|
|
169
|
+
| `config` | the aspect config. enter the config as a stringified JSON (e.g. `{"foo":"bar"}` ). when no config is provided, an aspect is set with an empty config ({}). |
|
|
170
170
|
|
|
171
171
|
| **Option** | **Option alias** | **Description** |
|
|
172
172
|
| ---------- | :--------------: | ---------------------------------------------------------------------------------------------- |
|
|
@@ -178,10 +178,10 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
178
178
|
|
|
179
179
|
**Description**: unset an aspect from component(s).
|
|
180
180
|
|
|
181
|
-
| **Arg** |
|
|
182
|
-
| ----------- |
|
|
183
|
-
| `pattern` | the components to target. component name, component id, or
|
|
184
|
-
| `aspect-id` |
|
|
181
|
+
| **Arg** | **Description** |
|
|
182
|
+
| ----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
183
|
+
| `pattern` | the components to target. component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
184
|
+
| `aspect-id` | the aspect's component id |
|
|
185
185
|
|
|
186
186
|
### aspect update
|
|
187
187
|
|
|
@@ -189,10 +189,10 @@ rarely used for manual aspect management as most aspects are configured automati
|
|
|
189
189
|
|
|
190
190
|
**Description**: update a version of an aspect for all or specified components
|
|
191
191
|
|
|
192
|
-
| **Arg** |
|
|
193
|
-
| ----------- |
|
|
194
|
-
| `aspect-id` |
|
|
195
|
-
| `pattern` | the components to update (defaults to all components). component name, component id, or
|
|
192
|
+
| **Arg** | **Description** |
|
|
193
|
+
| ----------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
194
|
+
| `aspect-id` | the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote |
|
|
195
|
+
| `pattern` | the components to update (defaults to all components). component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
196
196
|
|
|
197
197
|
---
|
|
198
198
|
|
|
@@ -225,9 +225,9 @@ because this process can take a while on large workspaces, various flags are ava
|
|
|
225
225
|
|
|
226
226
|
`bit build [component-pattern]`
|
|
227
227
|
|
|
228
|
-
| **Arg** |
|
|
229
|
-
| ------------------- |
|
|
230
|
-
| `component-pattern` | component name, component id, or
|
|
228
|
+
| **Arg** | **Description** |
|
|
229
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
230
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
231
231
|
|
|
232
232
|
| **Option** | **Option alias** | **Description** |
|
|
233
233
|
| ---------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -314,9 +314,9 @@ useful for catching type issues before tagging, snapping or building components.
|
|
|
314
314
|
|
|
315
315
|
`bit check-types [component-pattern]`
|
|
316
316
|
|
|
317
|
-
| **Arg** |
|
|
318
|
-
| ------------------- |
|
|
319
|
-
| `component-pattern` | component name, component id, or
|
|
317
|
+
| **Arg** | **Description** |
|
|
318
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
319
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
320
320
|
|
|
321
321
|
| **Option** | **Option alias** | **Description** |
|
|
322
322
|
| -------------- | :--------------: | --------------------------------------------------------- |
|
|
@@ -343,10 +343,10 @@ the `<to>` argument accepts these values:
|
|
|
343
343
|
|
|
344
344
|
`bit checkout <to> [component-pattern]`
|
|
345
345
|
|
|
346
|
-
| **Arg** |
|
|
347
|
-
| ------------------- |
|
|
348
|
-
| `to` |
|
|
349
|
-
| `component-pattern` | component name, component id, or
|
|
346
|
+
| **Arg** | **Description** |
|
|
347
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
348
|
+
| `to` | permitted values: `[head, latest, reset, {specific-version}, {head~x}]`. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
|
|
349
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
350
350
|
|
|
351
351
|
| **Option** | **Option alias** | **Description** |
|
|
352
352
|
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -549,9 +549,9 @@ to remove components from your local workspace only, use "bit remove" instead.
|
|
|
549
549
|
|
|
550
550
|
`bit delete <component-pattern>`
|
|
551
551
|
|
|
552
|
-
| **Arg** |
|
|
553
|
-
| ------------------- |
|
|
554
|
-
| `component-pattern` | component name, component id, or
|
|
552
|
+
| **Arg** | **Description** |
|
|
553
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
554
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
555
555
|
|
|
556
556
|
| **Option** | **Option alias** | **Description** |
|
|
557
557
|
| ------------------ | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -638,10 +638,10 @@ if the dependency was auto-detected, it will be marked with a minus sign in the
|
|
|
638
638
|
otherwise, the config is written to .bitmap without the dependency.
|
|
639
639
|
see also 'bit deps unset'
|
|
640
640
|
|
|
641
|
-
| **Arg** |
|
|
642
|
-
| ------------------- |
|
|
643
|
-
| `component-pattern` | component name, component id, or
|
|
644
|
-
| `package...` |
|
|
641
|
+
| **Arg** | **Description** |
|
|
642
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
643
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
644
|
+
| `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will remove all lodash instances of any version |
|
|
645
645
|
|
|
646
646
|
| **Option** | **Option alias** | **Description** |
|
|
647
647
|
| ---------- | :--------------: | ---------------------------- |
|
|
@@ -657,10 +657,10 @@ this command removes the dependency only when it was set by config not if it was
|
|
|
657
657
|
in the .bitmap file, the config is written without the dependency.
|
|
658
658
|
see also "bit deps remove"
|
|
659
659
|
|
|
660
|
-
| **Arg** |
|
|
661
|
-
| ------------------- |
|
|
662
|
-
| `component-pattern` | component name, component id, or
|
|
663
|
-
| `package...` |
|
|
660
|
+
| **Arg** | **Description** |
|
|
661
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
662
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
663
|
+
| `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will remove all lodash instances of any version |
|
|
664
664
|
|
|
665
665
|
| **Option** | **Option alias** | **Description** |
|
|
666
666
|
| ---------- | :--------------: | --------------------------- |
|
|
@@ -683,10 +683,10 @@ see also "bit deps remove"
|
|
|
683
683
|
|
|
684
684
|
**Description**: set a dependency to component(s)
|
|
685
685
|
|
|
686
|
-
| **Arg** |
|
|
687
|
-
| ------------------- |
|
|
688
|
-
| `component-pattern` | component name, component id, or
|
|
689
|
-
| `package...` |
|
|
686
|
+
| **Arg** | **Description** |
|
|
687
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
688
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
689
|
+
| `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
|
|
690
690
|
|
|
691
691
|
| **Option** | **Option alias** | **Description** |
|
|
692
692
|
| ------------ | :--------------: | ------------------------------- |
|
|
@@ -700,9 +700,9 @@ see also "bit deps remove"
|
|
|
700
700
|
|
|
701
701
|
**Description**: reset dependencies to the default values (revert any previously "bit deps set")
|
|
702
702
|
|
|
703
|
-
| **Arg** |
|
|
704
|
-
| ------------------- |
|
|
705
|
-
| `component-pattern` | component name, component id, or
|
|
703
|
+
| **Arg** | **Description** |
|
|
704
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
705
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
706
706
|
|
|
707
707
|
### deps eject
|
|
708
708
|
|
|
@@ -710,9 +710,9 @@ see also "bit deps remove"
|
|
|
710
710
|
|
|
711
711
|
**Description**: write dependencies that were previously set via "bit deps set" into .bitmap
|
|
712
712
|
|
|
713
|
-
| **Arg** |
|
|
714
|
-
| ------------------- |
|
|
715
|
-
| `component-pattern` | component name, component id, or
|
|
713
|
+
| **Arg** | **Description** |
|
|
714
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
715
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
716
716
|
|
|
717
717
|
### deps blame
|
|
718
718
|
|
|
@@ -793,11 +793,11 @@ supports pattern matching to filter components and various output formats for be
|
|
|
793
793
|
|
|
794
794
|
`bit diff [component-pattern] [version] [to-version]`
|
|
795
795
|
|
|
796
|
-
| **Arg** |
|
|
797
|
-
| ------------------- |
|
|
798
|
-
| `component-pattern` | component name, component id, or
|
|
799
|
-
| `version` |
|
|
800
|
-
| `to-version` |
|
|
796
|
+
| **Arg** | **Description** |
|
|
797
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
798
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
799
|
+
| `version` | the base version to compare from. if omitted, compares the workspace's current files to the component's latest version. |
|
|
800
|
+
| `to-version` | the target version to compare against "version". if both "version" and "to-version" are provided, compare those two versions directly (ignoring the workspace). |
|
|
801
801
|
|
|
802
802
|
| **Option** | **Option alias** | **Description** |
|
|
803
803
|
| ----------- | :--------------: | ----------------------------------------------------------------------------------------------- |
|
|
@@ -839,9 +839,9 @@ useful for components that no longer need active development in current workspac
|
|
|
839
839
|
|
|
840
840
|
`bit eject <component-pattern>`
|
|
841
841
|
|
|
842
|
-
| **Arg** |
|
|
843
|
-
| ------------------- |
|
|
844
|
-
| `component-pattern` | component name, component id, or
|
|
842
|
+
| **Arg** | **Description** |
|
|
843
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
844
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
845
845
|
|
|
846
846
|
| **Option** | **Option alias** | **Description** |
|
|
847
847
|
| -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -909,10 +909,10 @@ environments control how components are built, tested, linted, and deployed.
|
|
|
909
909
|
|
|
910
910
|
**Description**: Assigns one or more components a development environment (env)
|
|
911
911
|
|
|
912
|
-
| **Arg** |
|
|
913
|
-
| ------------------- |
|
|
914
|
-
| `component-pattern` | component name, component id, or
|
|
915
|
-
| `env` |
|
|
912
|
+
| **Arg** | **Description** |
|
|
913
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
914
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
915
|
+
| `env` | the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`) |
|
|
916
916
|
|
|
917
917
|
### envs unset
|
|
918
918
|
|
|
@@ -928,9 +928,9 @@ use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' o
|
|
|
928
928
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
929
929
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
930
930
|
|
|
931
|
-
| **Arg** |
|
|
932
|
-
| ------------------- |
|
|
933
|
-
| `component-pattern` | component name, component id, or
|
|
931
|
+
| **Arg** | **Description** |
|
|
932
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
933
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
934
934
|
|
|
935
935
|
### envs replace
|
|
936
936
|
|
|
@@ -949,10 +949,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
949
949
|
|
|
950
950
|
**Description**: update a version of an env for all components using that env
|
|
951
951
|
|
|
952
|
-
| **Arg** |
|
|
953
|
-
| --------- |
|
|
954
|
-
| `env-id` |
|
|
955
|
-
| `pattern` | the components to update (defaults to all components). component name, component id, or
|
|
952
|
+
| **Arg** | **Description** |
|
|
953
|
+
| --------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
954
|
+
| `env-id` | the environment id (defaults to all envs). optionally, add a version (id@version), if no version is supplied will use the latest version on the remote. |
|
|
955
|
+
| `pattern` | the components to update (defaults to all components). component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
956
956
|
|
|
957
957
|
---
|
|
958
958
|
|
|
@@ -966,9 +966,9 @@ exporting is the final step after development and versioning to share components
|
|
|
966
966
|
|
|
967
967
|
`bit export [component-patterns...]`
|
|
968
968
|
|
|
969
|
-
| **Arg** |
|
|
970
|
-
| ----------------------- |
|
|
971
|
-
| `component-patterns...` | (not recommended) component name, component id, or
|
|
969
|
+
| **Arg** | **Description** |
|
|
970
|
+
| ----------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
971
|
+
| `component-patterns...` | (not recommended) component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
972
972
|
|
|
973
973
|
| **Option** | **Option alias** | **Description** |
|
|
974
974
|
| ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -998,10 +998,10 @@ the target-component-name argument is not allowed when using patterns.
|
|
|
998
998
|
|
|
999
999
|
`bit fork <pattern> [target-component-name]`
|
|
1000
1000
|
|
|
1001
|
-
| **Arg** |
|
|
1002
|
-
| ----------------------- |
|
|
1003
|
-
| `pattern` | component name, component id, or
|
|
1004
|
-
| `target-component-name` |
|
|
1001
|
+
| **Arg** | **Description** |
|
|
1002
|
+
| ----------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1003
|
+
| `pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1004
|
+
| `target-component-name` | the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag. not allowed when using patterns |
|
|
1005
1005
|
|
|
1006
1006
|
| **Option** | **Option alias** | **Description** |
|
|
1007
1007
|
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1026,9 +1026,9 @@ supports check mode to verify formatting without making changes.
|
|
|
1026
1026
|
|
|
1027
1027
|
`bit format [component-pattern]`
|
|
1028
1028
|
|
|
1029
|
-
| **Arg** |
|
|
1030
|
-
| ------------------- |
|
|
1031
|
-
| `component-pattern` | component name, component id, or
|
|
1029
|
+
| **Arg** | **Description** |
|
|
1030
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1031
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1032
1032
|
|
|
1033
1033
|
| **Option** | **Option alias** | **Description** |
|
|
1034
1034
|
| ----------- | :--------------: | ---------------------------------------------------------------------------- |
|
|
@@ -1255,20 +1255,20 @@ without a sub-command, lists all available lanes.
|
|
|
1255
1255
|
| ------- | :------------------------------------------------------: |
|
|
1256
1256
|
| `lane` | lane-name or lane-id (if lane is not local) to switch to |
|
|
1257
1257
|
|
|
1258
|
-
| **Option** | **Option alias** | **Description**
|
|
1259
|
-
| --------------------------------------- | :--------------: |
|
|
1260
|
-
| `--head` | `-h` | switch to the head of the lane/main (fetches the latest changes from the remote)
|
|
1261
|
-
| `--auto-merge-resolve <merge-strategy>` | `-r` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual"
|
|
1262
|
-
| `--force-ours` | | do not merge, preserve local files as is
|
|
1263
|
-
| `--force-theirs` | | do not merge, just overwrite with incoming files
|
|
1264
|
-
| `--get-all` | `-a` | DEPRECATED. this is currently the default behavior
|
|
1265
|
-
| `--workspace-only` | | checkout only the components in the workspace to the selected lane
|
|
1266
|
-
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components
|
|
1267
|
-
| `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, or
|
|
1268
|
-
| `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote
|
|
1269
|
-
| `--verbose` | | display detailed information about components that legitimately were not switched
|
|
1270
|
-
| `--json` | `-j` | return the output as JSON
|
|
1271
|
-
| `--branch` | | create and checkout a new git branch named after the lane
|
|
1258
|
+
| **Option** | **Option alias** | **Description** |
|
|
1259
|
+
| --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1260
|
+
| `--head` | `-h` | switch to the head of the lane/main (fetches the latest changes from the remote) |
|
|
1261
|
+
| `--auto-merge-resolve <merge-strategy>` | `-r` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
1262
|
+
| `--force-ours` | | do not merge, preserve local files as is |
|
|
1263
|
+
| `--force-theirs` | | do not merge, just overwrite with incoming files |
|
|
1264
|
+
| `--get-all` | `-a` | DEPRECATED. this is currently the default behavior |
|
|
1265
|
+
| `--workspace-only` | | checkout only the components in the workspace to the selected lane |
|
|
1266
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1267
|
+
| `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1268
|
+
| `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote |
|
|
1269
|
+
| `--verbose` | | display detailed information about components that legitimately were not switched |
|
|
1270
|
+
| `--json` | `-j` | return the output as JSON |
|
|
1271
|
+
| `--branch` | | create and checkout a new git branch named after the lane |
|
|
1272
1272
|
|
|
1273
1273
|
### lane show
|
|
1274
1274
|
|
|
@@ -1360,9 +1360,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1360
1360
|
| `from` | base lane for comparison |
|
|
1361
1361
|
| `to` | lane being compared to base lane |
|
|
1362
1362
|
|
|
1363
|
-
| **Option** | **Option alias** | **Description**
|
|
1364
|
-
| ------------------------------- | :--------------: |
|
|
1365
|
-
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, or
|
|
1363
|
+
| **Option** | **Option alias** | **Description** |
|
|
1364
|
+
| ------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1365
|
+
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1366
1366
|
|
|
1367
1367
|
### lane remove-readme
|
|
1368
1368
|
|
|
@@ -1395,9 +1395,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1395
1395
|
|
|
1396
1396
|
**Description**: DEPRECATED. remove components when on a lane
|
|
1397
1397
|
|
|
1398
|
-
| **Arg** |
|
|
1399
|
-
| ------------------- |
|
|
1400
|
-
| `component-pattern` | component name, component id, or
|
|
1398
|
+
| **Arg** | **Description** |
|
|
1399
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1400
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1401
1401
|
|
|
1402
1402
|
| **Option** | **Option alias** | **Description** |
|
|
1403
1403
|
| ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
|
|
@@ -1423,9 +1423,9 @@ note, it does not save the remote lanes objects locally, only the refs
|
|
|
1423
1423
|
NOTE: unlike "bit eject" on main, this command doesn't only remove the component from the
|
|
1424
1424
|
workspace, but also mark it as deleted from the lane, so it won't be merged later on.
|
|
1425
1425
|
|
|
1426
|
-
| **Arg** |
|
|
1427
|
-
| ------------------- |
|
|
1428
|
-
| `component-pattern` | component name, component id, or
|
|
1426
|
+
| **Arg** | **Description** |
|
|
1427
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1428
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1429
1429
|
|
|
1430
1430
|
### lane current
|
|
1431
1431
|
|
|
@@ -1459,10 +1459,10 @@ with one argument - diff the given history entry against its predecessor
|
|
|
1459
1459
|
with two arguments - diff between two specific history entries (first=from, second=to), useful for comparing any two points in history
|
|
1460
1460
|
run "bit lane history" to find history-ids
|
|
1461
1461
|
|
|
1462
|
-
| **Option** | **Option alias** | **Description**
|
|
1463
|
-
| ------------------------------- | :--------------: |
|
|
1464
|
-
| `--lane <lane-name>` | `-l` | the name of the lane to diff. if not specified, the current lane is used
|
|
1465
|
-
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, or
|
|
1462
|
+
| **Option** | **Option alias** | **Description** |
|
|
1463
|
+
| ------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1464
|
+
| `--lane <lane-name>` | `-l` | the name of the lane to diff. if not specified, the current lane is used |
|
|
1465
|
+
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1466
1466
|
|
|
1467
1467
|
### lane checkout
|
|
1468
1468
|
|
|
@@ -1523,10 +1523,10 @@ this flag keeps the history of one end and saves a reference to the other end. t
|
|
|
1523
1523
|
3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".
|
|
1524
1524
|
so then the history (and the source-code) of the other lane will be kept.
|
|
1525
1525
|
|
|
1526
|
-
| **Arg** |
|
|
1527
|
-
| --------- |
|
|
1528
|
-
| `lane` |
|
|
1529
|
-
| `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: component name, component id, or
|
|
1526
|
+
| **Arg** | **Description** |
|
|
1527
|
+
| --------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1528
|
+
| `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
|
|
1529
|
+
| `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1530
1530
|
|
|
1531
1531
|
| **Option** | **Option alias** | **Description** |
|
|
1532
1532
|
| --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1628,9 +1628,9 @@ supports automatic fixing of certain issues with --fix flag.
|
|
|
1628
1628
|
|
|
1629
1629
|
`bit lint [component-pattern]`
|
|
1630
1630
|
|
|
1631
|
-
| **Arg** |
|
|
1632
|
-
| ------------------- |
|
|
1633
|
-
| `component-pattern` | component name, component id, or
|
|
1631
|
+
| **Arg** | **Description** |
|
|
1632
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1633
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1634
1634
|
|
|
1635
1635
|
| **Option** | **Option alias** | **Description** |
|
|
1636
1636
|
| ---------------------- | :--------------: | ----------------------------------------------------------------- |
|
|
@@ -1678,9 +1678,9 @@ these components remain in the workspace but won't be shared or versioned.
|
|
|
1678
1678
|
|
|
1679
1679
|
**Description**: set a component as local-only
|
|
1680
1680
|
|
|
1681
|
-
| **Arg** |
|
|
1682
|
-
| ------------------- |
|
|
1683
|
-
| `component-pattern` | component name, component id, or
|
|
1681
|
+
| **Arg** | **Description** |
|
|
1682
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1683
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1684
1684
|
|
|
1685
1685
|
### local-only unset
|
|
1686
1686
|
|
|
@@ -1688,9 +1688,9 @@ these components remain in the workspace but won't be shared or versioned.
|
|
|
1688
1688
|
|
|
1689
1689
|
**Description**: remove a component from local-only
|
|
1690
1690
|
|
|
1691
|
-
| **Arg** |
|
|
1692
|
-
| ------------------- |
|
|
1693
|
-
| `component-pattern` | component name, component id, or
|
|
1691
|
+
| **Arg** | **Description** |
|
|
1692
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1693
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1694
1694
|
|
|
1695
1695
|
### local-only list
|
|
1696
1696
|
|
|
@@ -1853,9 +1853,9 @@ for lane-to-lane merging, use 'bit lane merge' instead.
|
|
|
1853
1853
|
|
|
1854
1854
|
`bit merge [component-pattern]`
|
|
1855
1855
|
|
|
1856
|
-
| **Arg** |
|
|
1857
|
-
| ------------------- |
|
|
1858
|
-
| `component-pattern` | component name, component id, or
|
|
1856
|
+
| **Arg** | **Description** |
|
|
1857
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1858
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1859
1859
|
|
|
1860
1860
|
| **Option** | **Option alias** | **Description** |
|
|
1861
1861
|
| --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1973,9 +1973,9 @@ reverses the soft-deletion of components marked with "bit delete", restoring the
|
|
|
1973
1973
|
|
|
1974
1974
|
`bit recover <component-pattern>`
|
|
1975
1975
|
|
|
1976
|
-
| **Arg** |
|
|
1977
|
-
| ------------------- |
|
|
1978
|
-
| `component-pattern` | component name, component id, or
|
|
1976
|
+
| **Arg** | **Description** |
|
|
1977
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1978
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1979
1979
|
|
|
1980
1980
|
| **Option** | **Option alias** | **Description** |
|
|
1981
1981
|
| -------------------------------- | :--------------: | ---------------------------------------------------------------------- |
|
|
@@ -2059,9 +2059,9 @@ use --keep-files to preserve component files while only removing the tracking.
|
|
|
2059
2059
|
|
|
2060
2060
|
`bit remove <component-pattern>`
|
|
2061
2061
|
|
|
2062
|
-
| **Arg** |
|
|
2063
|
-
| ------------------- |
|
|
2064
|
-
| `component-pattern` | component name, component id, or
|
|
2062
|
+
| **Arg** | **Description** |
|
|
2063
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2064
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2065
2065
|
|
|
2066
2066
|
| **Option** | **Option alias** | **Description** |
|
|
2067
2067
|
| -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2108,9 +2108,9 @@ useful for undoing mistakes before exporting. exported versions cannot be reset.
|
|
|
2108
2108
|
|
|
2109
2109
|
`bit reset [component-pattern]`
|
|
2110
2110
|
|
|
2111
|
-
| **Arg** |
|
|
2112
|
-
| ------------------- |
|
|
2113
|
-
| `component-pattern` | component name, component id, or
|
|
2111
|
+
| **Arg** | **Description** |
|
|
2112
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2113
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2114
2114
|
|
|
2115
2115
|
| **Option** | **Option alias** | **Description** |
|
|
2116
2116
|
| ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2131,10 +2131,10 @@ useful for reverting file changes without changing the component's version histo
|
|
|
2131
2131
|
|
|
2132
2132
|
`bit revert <component-pattern> <to>`
|
|
2133
2133
|
|
|
2134
|
-
| **Arg** |
|
|
2135
|
-
| ------------------- |
|
|
2136
|
-
| `component-pattern` | component name, component id, or
|
|
2137
|
-
| `to` |
|
|
2134
|
+
| **Arg** | **Description** |
|
|
2135
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2136
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2137
|
+
| `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
|
|
2138
2138
|
|
|
2139
2139
|
| **Option** | **Option alias** | **Description** |
|
|
2140
2140
|
| -------------------------------- | :--------------: | -------------------------------------------------- |
|
|
@@ -2316,10 +2316,10 @@ use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' o
|
|
|
2316
2316
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
2317
2317
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
2318
2318
|
|
|
2319
|
-
| **Arg** |
|
|
2320
|
-
| ------------------- |
|
|
2321
|
-
| `scope-name` |
|
|
2322
|
-
| `component-pattern` | component name, component id, or
|
|
2319
|
+
| **Arg** | **Description** |
|
|
2320
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2321
|
+
| `scope-name` | name of the scope to set |
|
|
2322
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2323
2323
|
|
|
2324
2324
|
### scope rename
|
|
2325
2325
|
|
|
@@ -2364,11 +2364,11 @@ as a result of this change
|
|
|
2364
2364
|
**Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
|
|
2365
2365
|
optionally, provide [pattern] to limit the fork to specific components
|
|
2366
2366
|
|
|
2367
|
-
| **Arg** |
|
|
2368
|
-
| ---------------- |
|
|
2369
|
-
| `original-scope` |
|
|
2370
|
-
| `new-scope` |
|
|
2371
|
-
| `pattern` | component name, component id, or
|
|
2367
|
+
| **Arg** | **Description** |
|
|
2368
|
+
| ---------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2369
|
+
| `original-scope` | the original scope to fork |
|
|
2370
|
+
| `new-scope` | the new scope to fork to, default to the default-scope of the workspace |
|
|
2371
|
+
| `pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2372
2372
|
|
|
2373
2373
|
| **Option** | **Option alias** | **Description** |
|
|
2374
2374
|
| -------------------------------- | :--------------: | -------------------------------------------------- |
|
|
@@ -2444,9 +2444,9 @@ snapshots maintain component history and enable collaboration without formal rel
|
|
|
2444
2444
|
|
|
2445
2445
|
`bit snap [component-pattern]`
|
|
2446
2446
|
|
|
2447
|
-
| **Arg** |
|
|
2448
|
-
| ------------------- |
|
|
2449
|
-
| `component-pattern` | component name, component id, or
|
|
2447
|
+
| **Arg** | **Description** |
|
|
2448
|
+
| ------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2449
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, only new and modified components are snapped (add --unmodified to snap all components in the workspace). |
|
|
2450
2450
|
|
|
2451
2451
|
| **Option** | **Option alias** | **Description** |
|
|
2452
2452
|
| -------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2478,9 +2478,9 @@ includes hot module reloading for development.
|
|
|
2478
2478
|
|
|
2479
2479
|
`bit start [component-pattern]`
|
|
2480
2480
|
|
|
2481
|
-
| **Arg** |
|
|
2482
|
-
| ------------------- |
|
|
2483
|
-
| `component-pattern` | component name, component id, or
|
|
2481
|
+
| **Arg** | **Description** |
|
|
2482
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2483
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2484
2484
|
|
|
2485
2485
|
| **Option** | **Option alias** | **Description** |
|
|
2486
2486
|
| ----------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2511,11 +2511,11 @@ allows saving work-in-progress changes and switching context, then restoring cha
|
|
|
2511
2511
|
|
|
2512
2512
|
**Description**: stash modified components
|
|
2513
2513
|
|
|
2514
|
-
| **Option** | **Option alias** | **Description**
|
|
2515
|
-
| -------------------- | :--------------: |
|
|
2516
|
-
| `--pattern` | `-p` | component name, component id, or
|
|
2517
|
-
| `--include-new` | | EXPERIMENTAL. by default, only modified components are stashed. use this flag to include new components
|
|
2518
|
-
| `--message <string>` | `-m` | message to be attached to the stashed components
|
|
2514
|
+
| **Option** | **Option alias** | **Description** |
|
|
2515
|
+
| -------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2516
|
+
| `--pattern` | `-p` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2517
|
+
| `--include-new` | | EXPERIMENTAL. by default, only modified components are stashed. use this flag to include new components |
|
|
2518
|
+
| `--message <string>` | `-m` | message to be attached to the stashed components |
|
|
2519
2519
|
|
|
2520
2520
|
### stash load
|
|
2521
2521
|
|
|
@@ -2536,10 +2536,10 @@ allows saving work-in-progress changes and switching context, then restoring cha
|
|
|
2536
2536
|
|
|
2537
2537
|
**Description**: list stash
|
|
2538
2538
|
|
|
2539
|
-
| **Option** | **Option alias** | **Description**
|
|
2540
|
-
| -------------------- | :--------------: |
|
|
2541
|
-
| `--pattern` | `-p` | component name, component id, or
|
|
2542
|
-
| `--message <string>` | `-m` | message to be attached to the stashed components
|
|
2539
|
+
| **Option** | **Option alias** | **Description** |
|
|
2540
|
+
| -------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2541
|
+
| `--pattern` | `-p` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2542
|
+
| `--message <string>` | `-m` | message to be attached to the stashed components |
|
|
2543
2543
|
|
|
2544
2544
|
---
|
|
2545
2545
|
|
|
@@ -2602,9 +2602,9 @@ use for official releases. for development versions, use 'bit snap' instead.
|
|
|
2602
2602
|
|
|
2603
2603
|
`bit tag [component-patterns...]`
|
|
2604
2604
|
|
|
2605
|
-
| **Arg** |
|
|
2606
|
-
| ----------------------- |
|
|
2607
|
-
| `component-patterns...` | component name, component id, or
|
|
2605
|
+
| **Arg** | **Description** |
|
|
2606
|
+
| ----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2607
|
+
| `component-patterns...` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
|
|
2608
2608
|
|
|
2609
2609
|
| **Option** | **Option alias** | **Description** |
|
|
2610
2610
|
| ---------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2664,9 +2664,9 @@ supports watch mode, coverage reporting, and debug mode for development workflow
|
|
|
2664
2664
|
|
|
2665
2665
|
`bit test [component-pattern]`
|
|
2666
2666
|
|
|
2667
|
-
| **Arg** |
|
|
2668
|
-
| ------------------- |
|
|
2669
|
-
| `component-pattern` | component name, component id, or
|
|
2667
|
+
| **Arg** | **Description** |
|
|
2668
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2669
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2670
2670
|
|
|
2671
2671
|
| **Option** | **Option alias** | **Description** |
|
|
2672
2672
|
| ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
|
|
@@ -2754,9 +2754,9 @@ by default validates only new and modified components. use --all to validate all
|
|
|
2754
2754
|
|
|
2755
2755
|
`bit validate [component-pattern]`
|
|
2756
2756
|
|
|
2757
|
-
| **Arg** |
|
|
2758
|
-
| ------------------- |
|
|
2759
|
-
| `component-pattern` | component name, component id, or
|
|
2757
|
+
| **Arg** | **Description** |
|
|
2758
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2759
|
+
| `component-pattern` | component name, component id, component pattern, or relative directory path. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2760
2760
|
|
|
2761
2761
|
| **Option** | **Option alias** | **Description** |
|
|
2762
2762
|
| ----------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
|