@teambit/harmony.content.cli-reference 2.0.67 → 2.0.69

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