@teambit/harmony.content.cli-reference 2.0.67 → 2.0.68
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 +74 -39
- package/cli-reference.mdx +128 -120
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +74 -39
- package/dist/cli-reference.mdx.js +230 -35
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1700623148304.js → preview-1700709510910.js} +2 -2
- package/package.json +2 -2
package/cli-reference.mdx
CHANGED
|
@@ -84,9 +84,9 @@ and a package.tgz file generated by pkg aspect.
|
|
|
84
84
|
|
|
85
85
|
`bit artifacts <component-pattern>`
|
|
86
86
|
|
|
87
|
-
| **Arg** |
|
|
88
|
-
| ------------------- |
|
|
89
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
87
|
+
| **Arg** | **Description** |
|
|
88
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
89
|
+
| `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. |
|
|
90
90
|
|
|
91
91
|
| **Option** | **Option alias** | **Description** |
|
|
92
92
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -109,9 +109,9 @@ and a package.tgz file generated by pkg aspect.
|
|
|
109
109
|
|
|
110
110
|
**Description**: list all aspects configured on component(s)
|
|
111
111
|
|
|
112
|
-
| **Arg** |
|
|
113
|
-
| --------- |
|
|
114
|
-
| `pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
112
|
+
| **Arg** | **Description** |
|
|
113
|
+
| --------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
114
|
+
| `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. |
|
|
115
115
|
|
|
116
116
|
| **Option** | **Option alias** | **Description** |
|
|
117
117
|
| ---------- | :--------------: | -------------------------------------------------- |
|
|
@@ -138,11 +138,11 @@ and a package.tgz file generated by pkg aspect.
|
|
|
138
138
|
|
|
139
139
|
**Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
|
|
140
140
|
|
|
141
|
-
| **Arg** |
|
|
142
|
-
| ----------- |
|
|
143
|
-
| `pattern` | the components to extend. component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
144
|
-
| `aspect-id` |
|
|
145
|
-
| `config` |
|
|
141
|
+
| **Arg** | **Description** |
|
|
142
|
+
| ----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
143
|
+
| `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. |
|
|
144
|
+
| `aspect-id` | the aspect's component id |
|
|
145
|
+
| `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 ({}). |
|
|
146
146
|
|
|
147
147
|
| **Option** | **Option alias** | **Description** |
|
|
148
148
|
| ---------- | :--------------: | ---------------------------------------------------------------------------------------------- |
|
|
@@ -154,10 +154,10 @@ and a package.tgz file generated by pkg aspect.
|
|
|
154
154
|
|
|
155
155
|
**Description**: unset an aspect from component(s).
|
|
156
156
|
|
|
157
|
-
| **Arg** |
|
|
158
|
-
| ----------- |
|
|
159
|
-
| `pattern` | the components to target. component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
160
|
-
| `aspect-id` |
|
|
157
|
+
| **Arg** | **Description** |
|
|
158
|
+
| ----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
159
|
+
| `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. |
|
|
160
|
+
| `aspect-id` | the aspect's component id |
|
|
161
161
|
|
|
162
162
|
### aspect update
|
|
163
163
|
|
|
@@ -165,10 +165,10 @@ and a package.tgz file generated by pkg aspect.
|
|
|
165
165
|
|
|
166
166
|
**Description**: update a version of an aspect for all or specified components
|
|
167
167
|
|
|
168
|
-
| **Arg** |
|
|
169
|
-
| ----------- |
|
|
170
|
-
| `aspect-id` |
|
|
171
|
-
| `pattern` | the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
168
|
+
| **Arg** | **Description** |
|
|
169
|
+
| ----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
170
|
+
| `aspect-id` | the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote |
|
|
171
|
+
| `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. |
|
|
172
172
|
|
|
173
173
|
---
|
|
174
174
|
|
|
@@ -179,9 +179,9 @@ by default, only new and modified components are built
|
|
|
179
179
|
|
|
180
180
|
`bit build [component-pattern]`
|
|
181
181
|
|
|
182
|
-
| **Arg** |
|
|
183
|
-
| ------------------- |
|
|
184
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
182
|
+
| **Arg** | **Description** |
|
|
183
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
184
|
+
| `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. |
|
|
185
185
|
|
|
186
186
|
| **Option** | **Option alias** | **Description** |
|
|
187
187
|
| ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -260,9 +260,9 @@ with no args, only workspace's capsules are deleted
|
|
|
260
260
|
|
|
261
261
|
`bit check-types [component-pattern]`
|
|
262
262
|
|
|
263
|
-
| **Arg** |
|
|
264
|
-
| ------------------- |
|
|
265
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
263
|
+
| **Arg** | **Description** |
|
|
264
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
265
|
+
| `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. |
|
|
266
266
|
|
|
267
267
|
| **Option** | **Option alias** | **Description** |
|
|
268
268
|
| ---------- | :--------------: | --------------------------------------------------------- |
|
|
@@ -283,10 +283,10 @@ with no args, only workspace's capsules are deleted
|
|
|
283
283
|
|
|
284
284
|
`bit checkout <to> [component-pattern]`
|
|
285
285
|
|
|
286
|
-
| **Arg** |
|
|
287
|
-
| ------------------- |
|
|
288
|
-
| `to` |
|
|
289
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
286
|
+
| **Arg** | **Description** |
|
|
287
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
288
|
+
| `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
|
|
289
|
+
| `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. |
|
|
290
290
|
|
|
291
291
|
| **Option** | **Option alias** | **Description** |
|
|
292
292
|
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -433,9 +433,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
433
433
|
|
|
434
434
|
`bit delete <component-pattern>`
|
|
435
435
|
|
|
436
|
-
| **Arg** |
|
|
437
|
-
| ------------------- |
|
|
438
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
436
|
+
| **Arg** | **Description** |
|
|
437
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
438
|
+
| `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. |
|
|
439
439
|
|
|
440
440
|
| **Option** | **Option alias** | **Description** |
|
|
441
441
|
| --------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -499,10 +499,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
499
499
|
|
|
500
500
|
**Description**: remove a dependency to component(s)
|
|
501
501
|
|
|
502
|
-
| **Arg** |
|
|
503
|
-
| ------------------- |
|
|
504
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
505
|
-
| `package...` |
|
|
502
|
+
| **Arg** | **Description** |
|
|
503
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
504
|
+
| `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. |
|
|
505
|
+
| `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 |
|
|
506
506
|
|
|
507
507
|
| **Option** | **Option alias** | **Description** |
|
|
508
508
|
| ---------- | :--------------: | ---------------------------- |
|
|
@@ -515,10 +515,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
515
515
|
|
|
516
516
|
**Description**: unset a dependency to component(s) that was previously set by "bit deps set"
|
|
517
517
|
|
|
518
|
-
| **Arg** |
|
|
519
|
-
| ------------------- |
|
|
520
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
521
|
-
| `package...` |
|
|
518
|
+
| **Arg** | **Description** |
|
|
519
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
520
|
+
| `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. |
|
|
521
|
+
| `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 |
|
|
522
522
|
|
|
523
523
|
| **Option** | **Option alias** | **Description** |
|
|
524
524
|
| ---------- | :--------------: | --------------------------- |
|
|
@@ -541,10 +541,10 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
541
541
|
|
|
542
542
|
**Description**: set a dependency to component(s)
|
|
543
543
|
|
|
544
|
-
| **Arg** |
|
|
545
|
-
| ------------------- |
|
|
546
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
547
|
-
| `package...` |
|
|
544
|
+
| **Arg** | **Description** |
|
|
545
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
546
|
+
| `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. |
|
|
547
|
+
| `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
|
|
548
548
|
|
|
549
549
|
| **Option** | **Option alias** | **Description** |
|
|
550
550
|
| ---------- | :--------------: | --------------------------- |
|
|
@@ -557,9 +557,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
557
557
|
|
|
558
558
|
**Description**: reset dependencies to the default values (revert any previously "bit deps set")
|
|
559
559
|
|
|
560
|
-
| **Arg** |
|
|
561
|
-
| ------------------- |
|
|
562
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
560
|
+
| **Arg** | **Description** |
|
|
561
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
562
|
+
| `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. |
|
|
563
563
|
|
|
564
564
|
### deps eject
|
|
565
565
|
|
|
@@ -567,9 +567,9 @@ this command marks the components as deleted, and after snap/tag and export they
|
|
|
567
567
|
|
|
568
568
|
**Description**: write dependencies that were previously set via "bit deps set" into .bitmap
|
|
569
569
|
|
|
570
|
-
| **Arg** |
|
|
571
|
-
| ------------------- |
|
|
572
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
570
|
+
| **Arg** | **Description** |
|
|
571
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
572
|
+
| `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. |
|
|
573
573
|
|
|
574
574
|
### deps blame
|
|
575
575
|
|
|
@@ -638,9 +638,9 @@ By default the component files will be removed from the workspace
|
|
|
638
638
|
|
|
639
639
|
`bit eject <component-pattern>`
|
|
640
640
|
|
|
641
|
-
| **Arg** |
|
|
642
|
-
| ------------------- |
|
|
643
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
641
|
+
| **Arg** | **Description** |
|
|
642
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
643
|
+
| `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. |
|
|
644
644
|
|
|
645
645
|
| **Option** | **Option alias** | **Description** |
|
|
646
646
|
| -------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -701,10 +701,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
701
701
|
|
|
702
702
|
**Description**: Assigns one or more components a development environment (env)
|
|
703
703
|
|
|
704
|
-
| **Arg** |
|
|
705
|
-
| ------------------- |
|
|
706
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
707
|
-
| `env` |
|
|
704
|
+
| **Arg** | **Description** |
|
|
705
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
706
|
+
| `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. |
|
|
707
|
+
| `env` | the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`) |
|
|
708
708
|
|
|
709
709
|
### envs unset
|
|
710
710
|
|
|
@@ -719,9 +719,9 @@ use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
|
719
719
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
720
720
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
721
721
|
|
|
722
|
-
| **Arg** |
|
|
723
|
-
| ------------------- |
|
|
724
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
722
|
+
| **Arg** | **Description** |
|
|
723
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
724
|
+
| `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. |
|
|
725
725
|
|
|
726
726
|
### envs replace
|
|
727
727
|
|
|
@@ -740,10 +740,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
740
740
|
|
|
741
741
|
**Description**: update a version of an env for all components using that env
|
|
742
742
|
|
|
743
|
-
| **Arg** |
|
|
744
|
-
| --------- |
|
|
745
|
-
| `env-id` |
|
|
746
|
-
| `pattern` | the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
743
|
+
| **Arg** | **Description** |
|
|
744
|
+
| --------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
745
|
+
| `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. |
|
|
746
|
+
| `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. |
|
|
747
747
|
|
|
748
748
|
---
|
|
749
749
|
|
|
@@ -758,9 +758,9 @@ bit export => export all staged snaps/tags of components to their remote scope.
|
|
|
758
758
|
|
|
759
759
|
`bit export [component-patterns...]`
|
|
760
760
|
|
|
761
|
-
| **Arg** |
|
|
762
|
-
| ----------------------- |
|
|
763
|
-
| `component-patterns...` | (not recommended) component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
761
|
+
| **Arg** | **Description** |
|
|
762
|
+
| ----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
763
|
+
| `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. |
|
|
764
764
|
|
|
765
765
|
| **Option** | **Option alias** | **Description** |
|
|
766
766
|
| ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -999,14 +999,14 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
999
999
|
| ------- | :------------------------------------------------------: |
|
|
1000
1000
|
| `lane` | lane-name or lane-id (if lane is not local) to switch to |
|
|
1001
1001
|
|
|
1002
|
-
| **Option** | **Option alias** | **Description**
|
|
1003
|
-
| -------------------------------- | :--------------: |
|
|
1004
|
-
| `--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
|
|
1005
|
-
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual"
|
|
1006
|
-
| `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace
|
|
1007
|
-
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components
|
|
1008
|
-
| `--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. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1009
|
-
| `--json` | `-j` | return the output as JSON
|
|
1002
|
+
| **Option** | **Option alias** | **Description** |
|
|
1003
|
+
| -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1004
|
+
| `--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 |
|
|
1005
|
+
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
1006
|
+
| `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
|
|
1007
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1008
|
+
| `--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. |
|
|
1009
|
+
| `--json` | `-j` | return the output as JSON |
|
|
1010
1010
|
|
|
1011
1011
|
### lane show
|
|
1012
1012
|
|
|
@@ -1098,9 +1098,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1098
1098
|
| `from` | base lane for comparison |
|
|
1099
1099
|
| `to` | lane being compared to base lane |
|
|
1100
1100
|
|
|
1101
|
-
| **Option** | **Option alias** | **Description**
|
|
1102
|
-
| ------------------------------- | :--------------: |
|
|
1103
|
-
| `--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. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1101
|
+
| **Option** | **Option alias** | **Description** |
|
|
1102
|
+
| ------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1103
|
+
| `--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. |
|
|
1104
1104
|
|
|
1105
1105
|
### lane add-readme
|
|
1106
1106
|
|
|
@@ -1140,9 +1140,9 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1140
1140
|
|
|
1141
1141
|
**Description**: DEPRECATED. remove components when on a lane
|
|
1142
1142
|
|
|
1143
|
-
| **Arg** |
|
|
1144
|
-
| ------------------- |
|
|
1145
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1143
|
+
| **Arg** | **Description** |
|
|
1144
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1145
|
+
| `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. |
|
|
1146
1146
|
|
|
1147
1147
|
| **Option** | **Option alias** | **Description** |
|
|
1148
1148
|
| ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
|
|
@@ -1170,10 +1170,10 @@ this flag keeps the history of one end and saves a reference to the other end. t
|
|
|
1170
1170
|
3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".
|
|
1171
1171
|
so then the history (and the source-code) of the other lane will be kept.
|
|
1172
1172
|
|
|
1173
|
-
| **Arg** |
|
|
1174
|
-
| --------- |
|
|
1175
|
-
| `lane` |
|
|
1176
|
-
| `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. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1173
|
+
| **Arg** | **Description** |
|
|
1174
|
+
| --------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1175
|
+
| `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
|
|
1176
|
+
| `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. |
|
|
1177
1177
|
|
|
1178
1178
|
| **Option** | **Option alias** | **Description** |
|
|
1179
1179
|
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1370,9 +1370,9 @@ this command only checks source code changes, it doesn't check for config/aspect
|
|
|
1370
1370
|
|
|
1371
1371
|
`bit mini-status [component-pattern]`
|
|
1372
1372
|
|
|
1373
|
-
| **Arg** |
|
|
1374
|
-
| ------------------- |
|
|
1375
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1373
|
+
| **Arg** | **Description** |
|
|
1374
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1375
|
+
| `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. |
|
|
1376
1376
|
|
|
1377
1377
|
| **Option** | **Option alias** | **Description** |
|
|
1378
1378
|
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
@@ -1510,9 +1510,9 @@ to mark components as deleted on the remote scope, use "bit delete".
|
|
|
1510
1510
|
|
|
1511
1511
|
`bit remove <component-pattern>`
|
|
1512
1512
|
|
|
1513
|
-
| **Arg** |
|
|
1514
|
-
| ------------------- |
|
|
1515
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1513
|
+
| **Arg** | **Description** |
|
|
1514
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1515
|
+
| `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. |
|
|
1516
1516
|
|
|
1517
1517
|
| **Option** | **Option alias** | **Description** |
|
|
1518
1518
|
| -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1551,10 +1551,10 @@ https://bit.dev/components/tags#undoing-a-tag
|
|
|
1551
1551
|
|
|
1552
1552
|
`bit reset [component-pattern]`
|
|
1553
1553
|
|
|
1554
|
-
| **Arg** |
|
|
1555
|
-
| ------------------- |
|
|
1556
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1557
|
-
| `component-version` |
|
|
1554
|
+
| **Arg** | **Description** |
|
|
1555
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1556
|
+
| `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. |
|
|
1557
|
+
| `component-version` | the version to untag (semver for tags. hash for snaps) |
|
|
1558
1558
|
|
|
1559
1559
|
| **Option** | **Option alias** | **Description** |
|
|
1560
1560
|
| ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1572,10 +1572,10 @@ https://bit.dev/components/tags#undoing-a-tag
|
|
|
1572
1572
|
|
|
1573
1573
|
`bit revert <component-pattern> <to>`
|
|
1574
1574
|
|
|
1575
|
-
| **Arg** |
|
|
1576
|
-
| ------------------- |
|
|
1577
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1578
|
-
| `to` |
|
|
1575
|
+
| **Arg** | **Description** |
|
|
1576
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1577
|
+
| `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. |
|
|
1578
|
+
| `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
|
|
1579
1579
|
|
|
1580
1580
|
| **Option** | **Option alias** | **Description** |
|
|
1581
1581
|
| -------------------------------- | :--------------: | -------------------------------------------------- |
|
|
@@ -1640,10 +1640,10 @@ use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
|
|
|
1640
1640
|
always wrap the pattern with single quotes to avoid collision with shell commands.
|
|
1641
1641
|
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
1642
1642
|
|
|
1643
|
-
| **Arg** |
|
|
1644
|
-
| ------------------- |
|
|
1645
|
-
| `scope-name` |
|
|
1646
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1643
|
+
| **Arg** | **Description** |
|
|
1644
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1645
|
+
| `scope-name` | name of the scope to set |
|
|
1646
|
+
| `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. |
|
|
1647
1647
|
|
|
1648
1648
|
### scope rename
|
|
1649
1649
|
|
|
@@ -1681,13 +1681,21 @@ as a result of this change
|
|
|
1681
1681
|
|
|
1682
1682
|
### scope fork
|
|
1683
1683
|
|
|
1684
|
-
**Usage**: `scope fork <original-scope> <new-scope
|
|
1684
|
+
**Usage**: `scope fork <original-scope> <new-scope> [pattern]`
|
|
1685
1685
|
|
|
1686
|
-
**Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
|
|
1686
|
+
**Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
|
|
1687
|
+
optionally, provide [pattern] to limit the fork to specific components
|
|
1687
1688
|
|
|
1688
|
-
| **
|
|
1689
|
-
|
|
|
1690
|
-
|
|
|
1689
|
+
| **Arg** | **Description** |
|
|
1690
|
+
| ---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1691
|
+
| `original-scope` | the original scope to fork |
|
|
1692
|
+
| `new-scope` | the new scope to fork to |
|
|
1693
|
+
| `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. |
|
|
1694
|
+
|
|
1695
|
+
| **Option** | **Option alias** | **Description** |
|
|
1696
|
+
| -------------------------------- | :--------------: | --------------------------------------------------------- |
|
|
1697
|
+
| `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
|
|
1698
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
1691
1699
|
|
|
1692
1700
|
---
|
|
1693
1701
|
|
|
@@ -1761,9 +1769,9 @@ as a result of this change
|
|
|
1761
1769
|
|
|
1762
1770
|
`bit snap [component-pattern]`
|
|
1763
1771
|
|
|
1764
|
-
| **Arg** |
|
|
1765
|
-
| ------------------- |
|
|
1766
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1772
|
+
| **Arg** | **Description** |
|
|
1773
|
+
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1774
|
+
| `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). |
|
|
1767
1775
|
|
|
1768
1776
|
| **Option** | **Option alias** | **Description** |
|
|
1769
1777
|
| -------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1791,9 +1799,9 @@ as a result of this change
|
|
|
1791
1799
|
|
|
1792
1800
|
`bit start [component-pattern]`
|
|
1793
1801
|
|
|
1794
|
-
| **Arg** |
|
|
1795
|
-
| ------------------- |
|
|
1796
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1802
|
+
| **Arg** | **Description** |
|
|
1803
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1804
|
+
| `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. |
|
|
1797
1805
|
|
|
1798
1806
|
| **Option** | **Option alias** | **Description** |
|
|
1799
1807
|
| ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
|
|
@@ -1848,9 +1856,9 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1848
1856
|
|
|
1849
1857
|
`bit tag [component-patterns...]`
|
|
1850
1858
|
|
|
1851
|
-
| **Arg** |
|
|
1852
|
-
| ----------------------- |
|
|
1853
|
-
| `component-patterns...` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1859
|
+
| **Arg** | **Description** |
|
|
1860
|
+
| ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1861
|
+
| `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. |
|
|
1854
1862
|
|
|
1855
1863
|
| **Option** | **Option alias** | **Description** |
|
|
1856
1864
|
| ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1906,9 +1914,9 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1906
1914
|
|
|
1907
1915
|
`bit test [component-pattern]`
|
|
1908
1916
|
|
|
1909
|
-
| **Arg** |
|
|
1910
|
-
| ------------------- |
|
|
1911
|
-
| `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1917
|
+
| **Arg** | **Description** |
|
|
1918
|
+
| ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1919
|
+
| `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. |
|
|
1912
1920
|
|
|
1913
1921
|
| **Option** | **Option alias** | **Description** |
|
|
1914
1922
|
| ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
|