@teambit/harmony.content.cli-reference 2.0.191 → 2.0.193
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 +50 -44
- package/cli-reference.mdx +143 -139
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +50 -44
- package/dist/cli-reference.mdx.js +46 -38
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1709627282589.js → preview-1709781440634.js} +2 -2
- package/package.json +2 -2
package/cli-reference.mdx
CHANGED
|
@@ -83,9 +83,9 @@ and a package.tgz file generated by pkg aspect.
|
|
|
83
83
|
|
|
84
84
|
`bit artifacts <component-pattern>`
|
|
85
85
|
|
|
86
|
-
| **Arg** |
|
|
87
|
-
| ------------------- |
|
|
88
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
86
|
+
| **Arg** | **Description** |
|
|
87
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
88
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
89
89
|
|
|
90
90
|
| **Option** | **Option alias** | **Description** |
|
|
91
91
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -108,9 +108,9 @@ and a package.tgz file generated by pkg aspect.
|
|
|
108
108
|
|
|
109
109
|
**Description**: list all aspects configured on component(s)
|
|
110
110
|
|
|
111
|
-
| **Arg** |
|
|
112
|
-
| --------- |
|
|
113
|
-
| `pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
111
|
+
| **Arg** | **Description** |
|
|
112
|
+
| --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
113
|
+
| `pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
114
114
|
|
|
115
115
|
| **Option** | **Option alias** | **Description** |
|
|
116
116
|
| ---------- | :--------------: | -------------------------------------------------- |
|
|
@@ -137,11 +137,11 @@ and a package.tgz file generated by pkg aspect.
|
|
|
137
137
|
|
|
138
138
|
**Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
|
|
139
139
|
|
|
140
|
-
| **Arg** |
|
|
141
|
-
| ----------- |
|
|
142
|
-
| `pattern` | the components to extend. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
143
|
-
| `aspect-id` |
|
|
144
|
-
| `config` |
|
|
140
|
+
| **Arg** | **Description** |
|
|
141
|
+
| ----------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
142
|
+
| `pattern` | the components to extend. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
143
|
+
| `aspect-id` | the aspect's component id |
|
|
144
|
+
| `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 ({}). |
|
|
145
145
|
|
|
146
146
|
| **Option** | **Option alias** | **Description** |
|
|
147
147
|
| ---------- | :--------------: | ---------------------------------------------------------------------------------------------- |
|
|
@@ -153,10 +153,10 @@ and a package.tgz file generated by pkg aspect.
|
|
|
153
153
|
|
|
154
154
|
**Description**: unset an aspect from component(s).
|
|
155
155
|
|
|
156
|
-
| **Arg** |
|
|
157
|
-
| ----------- |
|
|
158
|
-
| `pattern` | the components to target. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
159
|
-
| `aspect-id` |
|
|
156
|
+
| **Arg** | **Description** |
|
|
157
|
+
| ----------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
158
|
+
| `pattern` | the components to target. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
159
|
+
| `aspect-id` | the aspect's component id |
|
|
160
160
|
|
|
161
161
|
### aspect update
|
|
162
162
|
|
|
@@ -164,10 +164,10 @@ and a package.tgz file generated by pkg aspect.
|
|
|
164
164
|
|
|
165
165
|
**Description**: update a version of an aspect for all or specified components
|
|
166
166
|
|
|
167
|
-
| **Arg** |
|
|
168
|
-
| ----------- |
|
|
169
|
-
| `aspect-id` |
|
|
170
|
-
| `pattern` | the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
167
|
+
| **Arg** | **Description** |
|
|
168
|
+
| ----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
169
|
+
| `aspect-id` | the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote |
|
|
170
|
+
| `pattern` | the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
171
171
|
|
|
172
172
|
---
|
|
173
173
|
|
|
@@ -178,9 +178,9 @@ by default, only new and modified components are built
|
|
|
178
178
|
|
|
179
179
|
`bit build [component-pattern]`
|
|
180
180
|
|
|
181
|
-
| **Arg** |
|
|
182
|
-
| ------------------- |
|
|
183
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
181
|
+
| **Arg** | **Description** |
|
|
182
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
183
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
184
184
|
|
|
185
185
|
| **Option** | **Option alias** | **Description** |
|
|
186
186
|
| ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -261,9 +261,9 @@ with no args, only workspace's capsules are deleted
|
|
|
261
261
|
|
|
262
262
|
`bit check-types [component-pattern]`
|
|
263
263
|
|
|
264
|
-
| **Arg** |
|
|
265
|
-
| ------------------- |
|
|
266
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
264
|
+
| **Arg** | **Description** |
|
|
265
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
266
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
267
267
|
|
|
268
268
|
| **Option** | **Option alias** | **Description** |
|
|
269
269
|
| ---------- | :--------------: | --------------------------------------------------------- |
|
|
@@ -285,10 +285,10 @@ when on a lane, "checkout head" only checks out components on this lane. to upda
|
|
|
285
285
|
|
|
286
286
|
`bit checkout <to> [component-pattern]`
|
|
287
287
|
|
|
288
|
-
| **Arg** |
|
|
289
|
-
| ------------------- |
|
|
290
|
-
| `to` |
|
|
291
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
288
|
+
| **Arg** | **Description** |
|
|
289
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
290
|
+
| `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
|
|
291
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
292
292
|
|
|
293
293
|
| **Option** | **Option alias** | **Description** |
|
|
294
294
|
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -434,9 +434,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
434
434
|
|
|
435
435
|
`bit delete <component-pattern>`
|
|
436
436
|
|
|
437
|
-
| **Arg** |
|
|
438
|
-
| ------------------- |
|
|
439
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
437
|
+
| **Arg** | **Description** |
|
|
438
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
439
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
440
440
|
|
|
441
441
|
| **Option** | **Option alias** | **Description** |
|
|
442
442
|
| --------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -502,10 +502,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
502
502
|
|
|
503
503
|
**Description**: remove a dependency to component(s)
|
|
504
504
|
|
|
505
|
-
| **Arg** |
|
|
506
|
-
| ------------------- |
|
|
507
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
508
|
-
| `package...` |
|
|
505
|
+
| **Arg** | **Description** |
|
|
506
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
507
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
508
|
+
| `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 |
|
|
509
509
|
|
|
510
510
|
| **Option** | **Option alias** | **Description** |
|
|
511
511
|
| ---------- | :--------------: | ---------------------------- |
|
|
@@ -518,10 +518,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
518
518
|
|
|
519
519
|
**Description**: unset a dependency to component(s) that was previously set by "bit deps set"
|
|
520
520
|
|
|
521
|
-
| **Arg** |
|
|
522
|
-
| ------------------- |
|
|
523
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
524
|
-
| `package...` |
|
|
521
|
+
| **Arg** | **Description** |
|
|
522
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
523
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
524
|
+
| `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 |
|
|
525
525
|
|
|
526
526
|
| **Option** | **Option alias** | **Description** |
|
|
527
527
|
| ---------- | :--------------: | --------------------------- |
|
|
@@ -544,10 +544,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
544
544
|
|
|
545
545
|
**Description**: set a dependency to component(s)
|
|
546
546
|
|
|
547
|
-
| **Arg** |
|
|
548
|
-
| ------------------- |
|
|
549
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
550
|
-
| `package...` |
|
|
547
|
+
| **Arg** | **Description** |
|
|
548
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
549
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
550
|
+
| `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
|
|
551
551
|
|
|
552
552
|
| **Option** | **Option alias** | **Description** |
|
|
553
553
|
| ------------ | :--------------: | ------------------------------- |
|
|
@@ -561,9 +561,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
561
561
|
|
|
562
562
|
**Description**: reset dependencies to the default values (revert any previously "bit deps set")
|
|
563
563
|
|
|
564
|
-
| **Arg** |
|
|
565
|
-
| ------------------- |
|
|
566
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
564
|
+
| **Arg** | **Description** |
|
|
565
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
566
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
567
567
|
|
|
568
568
|
### deps eject
|
|
569
569
|
|
|
@@ -571,9 +571,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
571
571
|
|
|
572
572
|
**Description**: write dependencies that were previously set via "bit deps set" into .bitmap
|
|
573
573
|
|
|
574
|
-
| **Arg** |
|
|
575
|
-
| ------------------- |
|
|
576
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
574
|
+
| **Arg** | **Description** |
|
|
575
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
576
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
577
577
|
|
|
578
578
|
### deps blame
|
|
579
579
|
|
|
@@ -607,11 +607,11 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
607
607
|
|
|
608
608
|
`bit diff [component-pattern] [version] [to-version]`
|
|
609
609
|
|
|
610
|
-
| **Arg** |
|
|
611
|
-
| ------------------- |
|
|
612
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
613
|
-
| `version` |
|
|
614
|
-
| `to-version` |
|
|
610
|
+
| **Arg** | **Description** |
|
|
611
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
612
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
613
|
+
| `version` | specific version to compare against |
|
|
614
|
+
| `to-version` | specific version to compare to |
|
|
615
615
|
|
|
616
616
|
| **Option** | **Option alias** | **Description** |
|
|
617
617
|
| ----------- | :--------------: | ------------------------------------------------------- |
|
|
@@ -643,9 +643,9 @@ By default the component files will be removed from the workspace
|
|
|
643
643
|
|
|
644
644
|
`bit eject <component-pattern>`
|
|
645
645
|
|
|
646
|
-
| **Arg** |
|
|
647
|
-
| ------------------- |
|
|
648
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
646
|
+
| **Arg** | **Description** |
|
|
647
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
648
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
649
649
|
|
|
650
650
|
| **Option** | **Option alias** | **Description** |
|
|
651
651
|
| -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -662,6 +662,7 @@ By default the component files will be removed from the workspace
|
|
|
662
662
|
note this can be reversed at any time by snapping/tagging changes and deleting the component.json file
|
|
663
663
|
you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
|
|
664
664
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
665
|
+
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
665
666
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
666
667
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
667
668
|
|
|
@@ -707,10 +708,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
707
708
|
|
|
708
709
|
**Description**: Assigns one or more components a development environment (env)
|
|
709
710
|
|
|
710
|
-
| **Arg** |
|
|
711
|
-
| ------------------- |
|
|
712
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
713
|
-
| `env` |
|
|
711
|
+
| **Arg** | **Description** |
|
|
712
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
713
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
714
|
+
| `env` | the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`) |
|
|
714
715
|
|
|
715
716
|
### envs unset
|
|
716
717
|
|
|
@@ -722,12 +723,13 @@ in only removes envs that appear in the .bitmap file, which were previously conf
|
|
|
722
723
|
the purpose of this command is to reset previously assigned envs to either allow variants configure the env or use the base node env.
|
|
723
724
|
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
|
|
724
725
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
726
|
+
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
725
727
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
726
728
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
727
729
|
|
|
728
|
-
| **Arg** |
|
|
729
|
-
| ------------------- |
|
|
730
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
730
|
+
| **Arg** | **Description** |
|
|
731
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
732
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
731
733
|
|
|
732
734
|
### envs replace
|
|
733
735
|
|
|
@@ -746,10 +748,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
746
748
|
|
|
747
749
|
**Description**: update a version of an env for all components using that env
|
|
748
750
|
|
|
749
|
-
| **Arg** |
|
|
750
|
-
| --------- |
|
|
751
|
-
| `env-id` |
|
|
752
|
-
| `pattern` | the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
751
|
+
| **Arg** | **Description** |
|
|
752
|
+
| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
753
|
+
| `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. |
|
|
754
|
+
| `pattern` | the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
753
755
|
|
|
754
756
|
---
|
|
755
757
|
|
|
@@ -764,9 +766,9 @@ bit export => export all staged snaps/tags of components to their remote scope.
|
|
|
764
766
|
|
|
765
767
|
`bit export [component-patterns...]`
|
|
766
768
|
|
|
767
|
-
| **Arg** |
|
|
768
|
-
| ----------------------- |
|
|
769
|
-
| `component-patterns...` | (not recommended) 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
769
|
+
| **Arg** | **Description** |
|
|
770
|
+
| ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
771
|
+
| `component-patterns...` | (not recommended) 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
770
772
|
|
|
771
773
|
| **Option** | **Option alias** | **Description** |
|
|
772
774
|
| ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -814,9 +816,9 @@ bit export => export all staged snaps/tags of components to their remote scope.
|
|
|
814
816
|
|
|
815
817
|
`bit format [component-pattern]`
|
|
816
818
|
|
|
817
|
-
| **Arg** |
|
|
818
|
-
| ------------------- |
|
|
819
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
819
|
+
| **Arg** | **Description** |
|
|
820
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
821
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
820
822
|
|
|
821
823
|
| **Option** | **Option alias** | **Description** |
|
|
822
824
|
| ----------- | :--------------: | ---------------------------------------------------------------------------- |
|
|
@@ -1012,14 +1014,14 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
1012
1014
|
| ------- | :------------------------------------------------------: |
|
|
1013
1015
|
| `lane` | lane-name or lane-id (if lane is not local) to switch to |
|
|
1014
1016
|
|
|
1015
|
-
| **Option** | **Option alias** | **Description**
|
|
1016
|
-
| -------------------------------- | :--------------: |
|
|
1017
|
-
| `--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
|
|
1018
|
-
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual"
|
|
1019
|
-
| `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace
|
|
1020
|
-
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components
|
|
1021
|
-
| `--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 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1022
|
-
| `--json` | `-j` | return the output as JSON
|
|
1017
|
+
| **Option** | **Option alias** | **Description** |
|
|
1018
|
+
| -------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1019
|
+
| `--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 |
|
|
1020
|
+
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
1021
|
+
| `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
|
|
1022
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1023
|
+
| `--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 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1024
|
+
| `--json` | `-j` | return the output as JSON |
|
|
1023
1025
|
|
|
1024
1026
|
### lane show
|
|
1025
1027
|
|
|
@@ -1111,9 +1113,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1111
1113
|
| `from` | base lane for comparison |
|
|
1112
1114
|
| `to` | lane being compared to base lane |
|
|
1113
1115
|
|
|
1114
|
-
| **Option** | **Option alias** | **Description**
|
|
1115
|
-
| ------------------------------- | :--------------: |
|
|
1116
|
-
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1116
|
+
| **Option** | **Option alias** | **Description** |
|
|
1117
|
+
| ------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1118
|
+
| `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1117
1119
|
|
|
1118
1120
|
### lane add-readme
|
|
1119
1121
|
|
|
@@ -1153,9 +1155,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1153
1155
|
|
|
1154
1156
|
**Description**: DEPRECATED. remove components when on a lane
|
|
1155
1157
|
|
|
1156
|
-
| **Arg** |
|
|
1157
|
-
| ------------------- |
|
|
1158
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1158
|
+
| **Arg** | **Description** |
|
|
1159
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1160
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1159
1161
|
|
|
1160
1162
|
| **Option** | **Option alias** | **Description** |
|
|
1161
1163
|
| ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
|
|
@@ -1183,10 +1185,10 @@ this flag keeps the history of one end and saves a reference to the other end. t
|
|
|
1183
1185
|
3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".
|
|
1184
1186
|
so then the history (and the source-code) of the other lane will be kept.
|
|
1185
1187
|
|
|
1186
|
-
| **Arg** |
|
|
1187
|
-
| --------- |
|
|
1188
|
-
| `lane` |
|
|
1189
|
-
| `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1188
|
+
| **Arg** | **Description** |
|
|
1189
|
+
| --------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1190
|
+
| `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
|
|
1191
|
+
| `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1190
1192
|
|
|
1191
1193
|
| **Option** | **Option alias** | **Description** |
|
|
1192
1194
|
| --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1262,9 +1264,9 @@ also, checkout the workspace components according to the restored lane state
|
|
|
1262
1264
|
|
|
1263
1265
|
`bit lint [component-pattern]`
|
|
1264
1266
|
|
|
1265
|
-
| **Arg** |
|
|
1266
|
-
| ------------------- |
|
|
1267
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1267
|
+
| **Arg** | **Description** |
|
|
1268
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1269
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1268
1270
|
|
|
1269
1271
|
| **Option** | **Option alias** | **Description** |
|
|
1270
1272
|
| ---------------------- | :--------------: | ----------------------------------------------------------------- |
|
|
@@ -1389,9 +1391,9 @@ this command only checks source code changes, it doesn't check for config/aspect
|
|
|
1389
1391
|
|
|
1390
1392
|
`bit mini-status [component-pattern]`
|
|
1391
1393
|
|
|
1392
|
-
| **Arg** |
|
|
1393
|
-
| ------------------- |
|
|
1394
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1394
|
+
| **Arg** | **Description** |
|
|
1395
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1396
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1395
1397
|
|
|
1396
1398
|
| **Option** | **Option alias** | **Description** |
|
|
1397
1399
|
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
@@ -1555,9 +1557,9 @@ to mark components as deleted on the remote scope, use "bit delete".
|
|
|
1555
1557
|
|
|
1556
1558
|
`bit remove <component-pattern>`
|
|
1557
1559
|
|
|
1558
|
-
| **Arg** |
|
|
1559
|
-
| ------------------- |
|
|
1560
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1560
|
+
| **Arg** | **Description** |
|
|
1561
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1562
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1561
1563
|
|
|
1562
1564
|
| **Option** | **Option alias** | **Description** |
|
|
1563
1565
|
| -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1598,10 +1600,10 @@ https://bit.dev/components/tags#undoing-a-tag
|
|
|
1598
1600
|
|
|
1599
1601
|
`bit reset [component-pattern]`
|
|
1600
1602
|
|
|
1601
|
-
| **Arg** |
|
|
1602
|
-
| ------------------- |
|
|
1603
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1604
|
-
| `component-version` |
|
|
1603
|
+
| **Arg** | **Description** |
|
|
1604
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1605
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1606
|
+
| `component-version` | the version to untag (semver for tags. hash for snaps) |
|
|
1605
1607
|
|
|
1606
1608
|
| **Option** | **Option alias** | **Description** |
|
|
1607
1609
|
| ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1619,10 +1621,10 @@ https://bit.dev/components/tags#undoing-a-tag
|
|
|
1619
1621
|
|
|
1620
1622
|
`bit revert <component-pattern> <to>`
|
|
1621
1623
|
|
|
1622
|
-
| **Arg** |
|
|
1623
|
-
| ------------------- |
|
|
1624
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1625
|
-
| `to` |
|
|
1624
|
+
| **Arg** | **Description** |
|
|
1625
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1626
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1627
|
+
| `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
|
|
1626
1628
|
|
|
1627
1629
|
| **Option** | **Option alias** | **Description** |
|
|
1628
1630
|
| -------------------------------- | :--------------: | -------------------------------------------------- |
|
|
@@ -1656,6 +1658,7 @@ https://bit.dev/components/tags#undoing-a-tag
|
|
|
1656
1658
|
**Description**: shows the API schema of the specified component/s.
|
|
1657
1659
|
you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
|
|
1658
1660
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
1661
|
+
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
1659
1662
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
1660
1663
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
1661
1664
|
|
|
@@ -1683,13 +1686,14 @@ a component is set with a scope (as oppose to default scope) only once it is ver
|
|
|
1683
1686
|
|
|
1684
1687
|
you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
|
|
1685
1688
|
use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
1689
|
+
use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.
|
|
1686
1690
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
1687
1691
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
1688
1692
|
|
|
1689
|
-
| **Arg** |
|
|
1690
|
-
| ------------------- |
|
|
1691
|
-
| `scope-name` |
|
|
1692
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1693
|
+
| **Arg** | **Description** |
|
|
1694
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1695
|
+
| `scope-name` | name of the scope to set |
|
|
1696
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1693
1697
|
|
|
1694
1698
|
### scope rename
|
|
1695
1699
|
|
|
@@ -1733,11 +1737,11 @@ as a result of this change
|
|
|
1733
1737
|
**Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
|
|
1734
1738
|
optionally, provide [pattern] to limit the fork to specific components
|
|
1735
1739
|
|
|
1736
|
-
| **Arg** |
|
|
1737
|
-
| ---------------- |
|
|
1738
|
-
| `original-scope` |
|
|
1739
|
-
| `new-scope` |
|
|
1740
|
-
| `pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1740
|
+
| **Arg** | **Description** |
|
|
1741
|
+
| ---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1742
|
+
| `original-scope` | the original scope to fork |
|
|
1743
|
+
| `new-scope` | the new scope to fork to |
|
|
1744
|
+
| `pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1741
1745
|
|
|
1742
1746
|
| **Option** | **Option alias** | **Description** |
|
|
1743
1747
|
| -------------------------------- | :--------------: | --------------------------------------------------------- |
|
|
@@ -1829,9 +1833,9 @@ optionally, provide [pattern] to limit the fork to specific components
|
|
|
1829
1833
|
|
|
1830
1834
|
`bit snap [component-pattern]`
|
|
1831
1835
|
|
|
1832
|
-
| **Arg** |
|
|
1833
|
-
| ------------------- |
|
|
1834
|
-
| `component-pattern` | 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 `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). |
|
|
1836
|
+
| **Arg** | **Description** |
|
|
1837
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1838
|
+
| `component-pattern` | 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 `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). |
|
|
1835
1839
|
|
|
1836
1840
|
| **Option** | **Option alias** | **Description** |
|
|
1837
1841
|
| -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1858,9 +1862,9 @@ optionally, provide [pattern] to limit the fork to specific components
|
|
|
1858
1862
|
|
|
1859
1863
|
`bit start [component-pattern]`
|
|
1860
1864
|
|
|
1861
|
-
| **Arg** |
|
|
1862
|
-
| ------------------- |
|
|
1863
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1865
|
+
| **Arg** | **Description** |
|
|
1866
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1867
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1864
1868
|
|
|
1865
1869
|
| **Option** | **Option alias** | **Description** |
|
|
1866
1870
|
| ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
|
|
@@ -1887,10 +1891,10 @@ optionally, provide [pattern] to limit the fork to specific components
|
|
|
1887
1891
|
|
|
1888
1892
|
**Description**: stash modified components
|
|
1889
1893
|
|
|
1890
|
-
| **Option** | **Option alias** | **Description**
|
|
1891
|
-
| -------------------- | :--------------: |
|
|
1892
|
-
| `--pattern` | `-p` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1893
|
-
| `--message <string>` | `-m` | message to be attached to the stashed components
|
|
1894
|
+
| **Option** | **Option alias** | **Description** |
|
|
1895
|
+
| -------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1896
|
+
| `--pattern` | `-p` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1897
|
+
| `--message <string>` | `-m` | message to be attached to the stashed components |
|
|
1894
1898
|
|
|
1895
1899
|
### stash load
|
|
1896
1900
|
|
|
@@ -1911,10 +1915,10 @@ optionally, provide [pattern] to limit the fork to specific components
|
|
|
1911
1915
|
|
|
1912
1916
|
**Description**: list stash
|
|
1913
1917
|
|
|
1914
|
-
| **Option** | **Option alias** | **Description**
|
|
1915
|
-
| -------------------- | :--------------: |
|
|
1916
|
-
| `--pattern` | `-p` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1917
|
-
| `--message <string>` | `-m` | message to be attached to the stashed components
|
|
1918
|
+
| **Option** | **Option alias** | **Description** |
|
|
1919
|
+
| -------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1920
|
+
| `--pattern` | `-p` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
1921
|
+
| `--message <string>` | `-m` | message to be attached to the stashed components |
|
|
1918
1922
|
|
|
1919
1923
|
---
|
|
1920
1924
|
|
|
@@ -1958,9 +1962,9 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1958
1962
|
|
|
1959
1963
|
`bit tag [component-patterns...]`
|
|
1960
1964
|
|
|
1961
|
-
| **Arg** |
|
|
1962
|
-
| ----------------------- |
|
|
1963
|
-
| `component-patterns...` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
|
|
1965
|
+
| **Arg** | **Description** |
|
|
1966
|
+
| ----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1967
|
+
| `component-patterns...` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
|
|
1964
1968
|
|
|
1965
1969
|
| **Option** | **Option alias** | **Description** |
|
|
1966
1970
|
| ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -2014,9 +2018,9 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
2014
2018
|
|
|
2015
2019
|
`bit test [component-pattern]`
|
|
2016
2020
|
|
|
2017
|
-
| **Arg** |
|
|
2018
|
-
| ------------------- |
|
|
2019
|
-
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2021
|
+
| **Arg** | **Description** |
|
|
2022
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2023
|
+
| `component-pattern` | 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
|
|
2020
2024
|
|
|
2021
2025
|
| **Option** | **Option alias** | **Description** |
|
|
2022
2026
|
| ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
|