@teambit/harmony.content.cli-reference 1.95.202 → 1.95.203
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 +242 -236
- package/cli-reference.mdx +423 -408
- package/dist/cli-reference.composition.d.ts +2 -2
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +242 -236
- package/dist/cli-reference.mdx.js +284 -244
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/preview-1692297727886.js +7 -0
- package/package-tar/teambit-harmony.content.cli-reference-1.95.203.tgz +0 -0
- package/package.json +2 -2
- package/dist/preview-1692282707573.js +0 -7
- package/package-tar/teambit-harmony.content.cli-reference-1.95.202.tgz +0 -0
package/cli-reference.mdx
CHANGED
|
@@ -26,15 +26,15 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
26
26
|
|
|
27
27
|
`bit add [path...]`
|
|
28
28
|
|
|
29
|
-
| **Option** | **Option alias** | **Description**
|
|
30
|
-
| ------------------------- | :--------------: |
|
|
31
|
-
| `--id <name>` | `-i` | manually set component id
|
|
32
|
-
| `--main <file>` | `-m` | define entry point
|
|
33
|
-
| `--namespace <namespace>` | `-n` | organize component in a namespace
|
|
34
|
-
| `--override <boolean>` | `-o` | override existing component if exists (default = false)
|
|
35
|
-
| `--scope <string>` | `-s` | sets the component's scope
|
|
36
|
-
| `--env <string>` | `-e` | set the component's environment. (overrides the env from variants if exists)
|
|
37
|
-
| `--json` | `-j` | output as json format
|
|
29
|
+
| **Option** | **Option alias** | **Description** |
|
|
30
|
+
| ------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
|
|
31
|
+
| `--id <name>` | `-i` | manually set component id |
|
|
32
|
+
| `--main <file>` | `-m` | define component entry point |
|
|
33
|
+
| `--namespace <namespace>` | `-n` | organize component in a namespace |
|
|
34
|
+
| `--override <boolean>` | `-o` | override existing component if exists (default = false) |
|
|
35
|
+
| `--scope <string>` | `-s` | sets the component's scope. if not entered, the default-scope from workspace.jsonc will be used |
|
|
36
|
+
| `--env <string>` | `-e` | set the component's environment. (overrides the env from variants if exists) |
|
|
37
|
+
| `--json` | `-j` | output as json format |
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -59,7 +59,7 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
59
59
|
|
|
60
60
|
**Usage**: `app run <app-name>`
|
|
61
61
|
|
|
62
|
-
**Description**: run an app (independent of bit's dev server)
|
|
62
|
+
**Description**: locally run an app component (independent of bit's dev server)
|
|
63
63
|
|
|
64
64
|
| **Arg** | **Description** |
|
|
65
65
|
| ---------- | :--------------------------------------------------------------------------------------------------: |
|
|
@@ -68,8 +68,8 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
68
68
|
| **Option** | **Option alias** | **Description** |
|
|
69
69
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------- |
|
|
70
70
|
| `--dev` | `-d` | start the application in dev mode. |
|
|
71
|
-
| `--port [port-number]` | `-p` | port
|
|
72
|
-
| `--verbose` | `-v` |
|
|
71
|
+
| `--port [port-number]` | `-p` | port to run the app on |
|
|
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
74
|
| `--ssr` | | run app in server side rendering mode. |
|
|
75
75
|
|
|
@@ -77,7 +77,7 @@ Learn the recommended workflow for tracking directories as components, in the li
|
|
|
77
77
|
|
|
78
78
|
## artifacts
|
|
79
79
|
|
|
80
|
-
**Description**: list and download
|
|
80
|
+
**Description**: list and download component artifacts
|
|
81
81
|
artifacts are created on isolated capsules during tag or snap commands.
|
|
82
82
|
example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
|
|
83
83
|
and a package.tgz file generated by pkg aspect.
|
|
@@ -113,24 +113,24 @@ and a package.tgz file generated by pkg aspect.
|
|
|
113
113
|
| --------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
114
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 |
|
|
115
115
|
|
|
116
|
-
| **Option** | **Option alias** | **Description**
|
|
117
|
-
| ---------- | :--------------: |
|
|
118
|
-
| `--debug` | `-d` | show the origins
|
|
116
|
+
| **Option** | **Option alias** | **Description** |
|
|
117
|
+
| ---------- | :--------------: | -------------------------------------------------- |
|
|
118
|
+
| `--debug` | `-d` | show the origins where the aspects were taken from |
|
|
119
119
|
|
|
120
120
|
### aspect get
|
|
121
121
|
|
|
122
122
|
**Usage**: `aspect get <component-name>`
|
|
123
123
|
|
|
124
|
-
**Description**: list the aspects set on a component, as well as their
|
|
124
|
+
**Description**: list the aspects set on a component, as well as their configs and data
|
|
125
125
|
|
|
126
|
-
| **Arg** |
|
|
127
|
-
| ---------------- |
|
|
128
|
-
| `component-name` | the component name or component id |
|
|
126
|
+
| **Arg** | **Description** |
|
|
127
|
+
| ---------------- | :-----------------------------------------------------: |
|
|
128
|
+
| `component-name` | the component name or component id to fetch aspects for |
|
|
129
129
|
|
|
130
|
-
| **Option** | **Option alias** | **Description**
|
|
131
|
-
| ---------- | :--------------: |
|
|
132
|
-
| `--debug` | `-d` | show the origins
|
|
133
|
-
| `--json` | `-j` | format as json
|
|
130
|
+
| **Option** | **Option alias** | **Description** |
|
|
131
|
+
| ---------- | :--------------: | -------------------------------------------------- |
|
|
132
|
+
| `--debug` | `-d` | show the origins where the aspects were taken from |
|
|
133
|
+
| `--json` | `-j` | format as json |
|
|
134
134
|
|
|
135
135
|
### aspect set
|
|
136
136
|
|
|
@@ -138,15 +138,15 @@ 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.
|
|
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. 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 ({}). |
|
|
146
146
|
|
|
147
|
-
| **Option** | **Option alias** | **Description**
|
|
148
|
-
| ---------- | :--------------: |
|
|
149
|
-
| `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces
|
|
147
|
+
| **Option** | **Option alias** | **Description** |
|
|
148
|
+
| ---------- | :--------------: | ---------------------------------------------------------------------------------------------- |
|
|
149
|
+
| `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces overlapping existing configs) |
|
|
150
150
|
|
|
151
151
|
### aspect unset
|
|
152
152
|
|
|
@@ -154,27 +154,28 @@ 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.
|
|
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. 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 |
|
|
161
161
|
|
|
162
162
|
### aspect update
|
|
163
163
|
|
|
164
164
|
**Usage**: `aspect update <aspect-id> [pattern]`
|
|
165
165
|
|
|
166
|
-
**Description**: update a version of an aspect
|
|
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).
|
|
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 |
|
|
172
172
|
|
|
173
173
|
---
|
|
174
174
|
|
|
175
175
|
## build
|
|
176
176
|
|
|
177
|
-
**Description**: run set of tasks for build
|
|
177
|
+
**Description**: run set of tasks for build.
|
|
178
|
+
by default, only new and modified components are built
|
|
178
179
|
|
|
179
180
|
`bit build [component-pattern]`
|
|
180
181
|
|
|
@@ -192,8 +193,8 @@ and a package.tgz file generated by pkg aspect.
|
|
|
192
193
|
| `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
|
|
193
194
|
| `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
|
|
194
195
|
| `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
|
|
195
|
-
| `--skip-tests` | | skip running component tests during
|
|
196
|
-
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its
|
|
196
|
+
| `--skip-tests` | | skip running component tests during build process |
|
|
197
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
197
198
|
|
|
198
199
|
---
|
|
199
200
|
|
|
@@ -276,7 +277,7 @@ with no args, only workspace's capsules are deleted
|
|
|
276
277
|
**Description**: switch between component versions or remove local changes
|
|
277
278
|
|
|
278
279
|
`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
|
|
279
|
-
`bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all
|
|
280
|
+
`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
|
|
280
281
|
`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
|
|
281
282
|
`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
|
|
282
283
|
|
|
@@ -287,18 +288,18 @@ with no args, only workspace's capsules are deleted
|
|
|
287
288
|
| `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
|
|
288
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 |
|
|
289
290
|
|
|
290
|
-
| **Option** | **Option alias** | **Description**
|
|
291
|
-
| --------------------------------------- | :--------------: |
|
|
292
|
-
| `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them
|
|
293
|
-
| `--ours` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will leave the current code intact
|
|
294
|
-
| `--theirs` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will override the current code with the incoming code
|
|
295
|
-
| `--manual` | | DEPRECATED. use --auto-merge-resolve
|
|
296
|
-
| `--auto-merge-resolve <merge-strategy>` | | in case of
|
|
297
|
-
| `--reset` | `-r` | revert changes that were not snapped/tagged
|
|
298
|
-
| `--all` | `-a` | all components
|
|
299
|
-
| `--workspace-only` | `-e` | when on a lane
|
|
300
|
-
| `--verbose` | `-v` | showing verbose output for inspection
|
|
301
|
-
| `--skip-dependency-installation` | `-x` | do not install
|
|
291
|
+
| **Option** | **Option alias** | **Description** |
|
|
292
|
+
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
293
|
+
| `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
|
|
294
|
+
| `--ours` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will leave the current code intact |
|
|
295
|
+
| `--theirs` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will override the current code with the incoming code |
|
|
296
|
+
| `--manual` | | DEPRECATED. use --auto-merge-resolve |
|
|
297
|
+
| `--auto-merge-resolve <merge-strategy>` | | in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
|
|
298
|
+
| `--reset` | `-r` | revert changes that were not snapped/tagged |
|
|
299
|
+
| `--all` | `-a` | all components |
|
|
300
|
+
| `--workspace-only` | `-e` | only relevant for 'bit checkout head' when on a lane. don't import components from the remote lane that are not already in the workspace |
|
|
301
|
+
| `--verbose` | `-v` | showing verbose output for inspection |
|
|
302
|
+
| `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
|
|
302
303
|
|
|
303
304
|
---
|
|
304
305
|
|
|
@@ -370,7 +371,7 @@ The following gets removed by this command:
|
|
|
370
371
|
## config
|
|
371
372
|
|
|
372
373
|
**Description**: global config management
|
|
373
|
-
https://bit.dev/
|
|
374
|
+
https://bit.dev/docs/config/bit-config
|
|
374
375
|
|
|
375
376
|
`bit config`
|
|
376
377
|
|
|
@@ -390,7 +391,7 @@ https://bit.dev/reference/config/bit-config
|
|
|
390
391
|
|
|
391
392
|
**Usage**: `config get <key>`
|
|
392
393
|
|
|
393
|
-
**Description**: get a global configuration
|
|
394
|
+
**Description**: get a value from global configuration
|
|
394
395
|
|
|
395
396
|
### config list
|
|
396
397
|
|
|
@@ -441,9 +442,9 @@ https://bit.dev/reference/config/bit-config
|
|
|
441
442
|
| ---------------- | :----------------------------: |
|
|
442
443
|
| `component-name` | component name or component id |
|
|
443
444
|
|
|
444
|
-
| **Option** | **Option alias** | **Description**
|
|
445
|
-
| ------------------- | :--------------: |
|
|
446
|
-
| `--new-id <string>` | | if replaced by another component, enter the new component id |
|
|
445
|
+
| **Option** | **Option alias** | **Description** |
|
|
446
|
+
| ------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------- |
|
|
447
|
+
| `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename" to do this automatically |
|
|
447
448
|
|
|
448
449
|
---
|
|
449
450
|
|
|
@@ -570,18 +571,18 @@ https://bit.dev/reference/config/bit-config
|
|
|
570
571
|
|
|
571
572
|
## diff
|
|
572
573
|
|
|
573
|
-
**Description**: show the diff between the components' source files and config
|
|
574
|
+
**Description**: show the diff between the components' current source files and config, and their latest snapshot or tag
|
|
574
575
|
bit diff => compare all modified components to their model version
|
|
575
576
|
bit diff [ids...] => compare the specified components against their modified states
|
|
576
|
-
bit diff [id] [version] => compare the specified version
|
|
577
|
-
bit diff [id] [version] [to_version] => compare the specified version
|
|
577
|
+
bit diff [id] [version] => compare component's current files and configs to the specified version of the component
|
|
578
|
+
bit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided
|
|
578
579
|
you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
579
580
|
|
|
580
581
|
`bit diff [values...]`
|
|
581
582
|
|
|
582
583
|
| **Option** | **Option alias** | **Description** |
|
|
583
584
|
| ----------- | :--------------: | ------------------------------------------------------- |
|
|
584
|
-
| `--verbose` | `-v` | show a more verbose output
|
|
585
|
+
| `--verbose` | `-v` | show a more verbose output where possible |
|
|
585
586
|
| `--table` | `-t` | show tables instead of plain text for dependencies diff |
|
|
586
587
|
|
|
587
588
|
---
|
|
@@ -604,7 +605,8 @@ you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the p
|
|
|
604
605
|
## eject
|
|
605
606
|
|
|
606
607
|
**Alias**: `E`
|
|
607
|
-
**Description**:
|
|
608
|
+
**Description**: remove component from the workspace and install it instead as a regular npm package.
|
|
609
|
+
By default the component files will be removed from the workspace
|
|
608
610
|
|
|
609
611
|
`bit eject <component-pattern>`
|
|
610
612
|
|
|
@@ -612,17 +614,18 @@ you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the p
|
|
|
612
614
|
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
613
615
|
| `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 |
|
|
614
616
|
|
|
615
|
-
| **Option** | **Option alias** | **Description**
|
|
616
|
-
| -------------- | :--------------: |
|
|
617
|
-
| `--force` | `-f` | ignore local
|
|
618
|
-
| `--json` | `-j` | print the results in JSON format
|
|
619
|
-
| `--keep-files` | | keep the component files in the workspace intact
|
|
617
|
+
| **Option** | **Option alias** | **Description** |
|
|
618
|
+
| -------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
619
|
+
| `--force` | `-f` | ignore local changes/versions. eject component/s even when they are staged or modified. Note: unexported tags/snaps will be lost |
|
|
620
|
+
| `--json` | `-j` | print the results in JSON format |
|
|
621
|
+
| `--keep-files` | | keep the component files in the workspace intact |
|
|
620
622
|
|
|
621
623
|
---
|
|
622
624
|
|
|
623
625
|
## eject-conf
|
|
624
626
|
|
|
625
627
|
**Description**: eject components configuration (create a `component.json` file)
|
|
628
|
+
note this can be reversed at any time by snapping/tagging changes and deleting the component.json file
|
|
626
629
|
you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
|
|
627
630
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
628
631
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
@@ -630,10 +633,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
630
633
|
|
|
631
634
|
`bit eject-conf <pattern>`
|
|
632
635
|
|
|
633
|
-
| **Option** | **Option alias** | **Description**
|
|
634
|
-
| ------------- | :--------------: |
|
|
635
|
-
| `--propagate` | `-p` | mark propagate true in the config file |
|
|
636
|
-
| `--override` | `-o` | override file if exist
|
|
636
|
+
| **Option** | **Option alias** | **Description** |
|
|
637
|
+
| ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------- |
|
|
638
|
+
| `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be merge with workspace configs |
|
|
639
|
+
| `--override` | `-o` | override file if exist |
|
|
637
640
|
|
|
638
641
|
---
|
|
639
642
|
|
|
@@ -648,17 +651,17 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
648
651
|
|
|
649
652
|
**Usage**: `envs list`
|
|
650
653
|
|
|
651
|
-
**Description**: list all envs
|
|
654
|
+
**Description**: list all envs currently used in the workspace
|
|
652
655
|
|
|
653
656
|
### envs get
|
|
654
657
|
|
|
655
658
|
**Usage**: `envs get <component-name>`
|
|
656
659
|
|
|
657
|
-
**Description**: show information
|
|
660
|
+
**Description**: show config information from a component's env
|
|
658
661
|
|
|
659
|
-
| **Arg** |
|
|
660
|
-
| ---------------- |
|
|
661
|
-
| `component-name` | the 'component name' or 'component id' of the component
|
|
662
|
+
| **Arg** | **Description** |
|
|
663
|
+
| ---------------- | :-------------------------------------------------------------------------------------: |
|
|
664
|
+
| `component-name` | the 'component name' or 'component id' of the component whose env you'd like to inspect |
|
|
662
665
|
|
|
663
666
|
| **Option** | **Option alias** | **Description** |
|
|
664
667
|
| --------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -668,21 +671,21 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
668
671
|
|
|
669
672
|
**Usage**: `envs set <component-pattern> <env>`
|
|
670
673
|
|
|
671
|
-
**Description**:
|
|
674
|
+
**Description**: Assigns one or more components a development environment (env)
|
|
672
675
|
|
|
673
676
|
| **Arg** | **Description** |
|
|
674
677
|
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
675
678
|
| `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 |
|
|
676
|
-
| `env` |
|
|
679
|
+
| `env` | the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`) |
|
|
677
680
|
|
|
678
681
|
### envs unset
|
|
679
682
|
|
|
680
683
|
**Usage**: `envs unset <component-pattern>`
|
|
681
684
|
|
|
682
685
|
**Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
|
|
683
|
-
keep in mind that this doesn't remove envs that are set
|
|
686
|
+
keep in mind that this doesn't remove envs that are set via variants.
|
|
684
687
|
in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
|
|
685
|
-
the purpose of this command is to
|
|
688
|
+
the purpose of this command is to reset previously assigned envs to either allow variants configure the env or use the base node env.
|
|
686
689
|
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
|
|
687
690
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
688
691
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
@@ -698,10 +701,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
698
701
|
|
|
699
702
|
**Description**: replace an existing env with another env for all components using the old env
|
|
700
703
|
|
|
701
|
-
| **Arg** |
|
|
702
|
-
| ------------- |
|
|
703
|
-
| `current-env` | the component id of the
|
|
704
|
-
| `new-env` |
|
|
704
|
+
| **Arg** | **Description** |
|
|
705
|
+
| ------------- | :----------------------------------------: |
|
|
706
|
+
| `current-env` | the component id of the env to be replaced |
|
|
707
|
+
| `new-env` | the component id of the new env |
|
|
705
708
|
|
|
706
709
|
### envs update
|
|
707
710
|
|
|
@@ -709,10 +712,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
709
712
|
|
|
710
713
|
**Description**: update a version of an env for all components using that env
|
|
711
714
|
|
|
712
|
-
| **Arg** |
|
|
713
|
-
| --------- |
|
|
714
|
-
| `env-id` |
|
|
715
|
-
| `pattern` | the components to update (defaults to all components).
|
|
715
|
+
| **Arg** | **Description** |
|
|
716
|
+
| --------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
717
|
+
| `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. |
|
|
718
|
+
| `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 |
|
|
716
719
|
|
|
717
720
|
---
|
|
718
721
|
|
|
@@ -720,19 +723,20 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
720
723
|
|
|
721
724
|
**Alias**: `e`
|
|
722
725
|
**Description**: export components from the workspace to remote scopes
|
|
723
|
-
bit export => export all staged components to their
|
|
724
|
-
`bit export [
|
|
725
|
-
|
|
726
|
+
bit export => export all staged snaps/tags of components to their remote scope. if checked out to a lane, export the lane as well
|
|
727
|
+
`bit export [pattern...]` => export components included by the pattern to their remote scope (we recommend not using a pattern in
|
|
728
|
+
most scenarios so that all changes are exported simultaneously)
|
|
729
|
+
you can use a pattern for multiple ids, such as bit export "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
726
730
|
|
|
727
731
|
`bit export [component-patterns...]`
|
|
728
732
|
|
|
729
|
-
| **Arg** |
|
|
730
|
-
| ----------------------- |
|
|
731
|
-
| `component-patterns...` | component
|
|
733
|
+
| **Arg** | **Description** |
|
|
734
|
+
| ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
735
|
+
| `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 |
|
|
732
736
|
|
|
733
737
|
| **Option** | **Option alias** | **Description** |
|
|
734
738
|
| ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
735
|
-
| `--eject` | `-e` |
|
|
739
|
+
| `--eject` | `-e` | remove component from the workspace and install it instead as a regular npm package |
|
|
736
740
|
| `--all` | `-a` | export all components, including non-staged (useful when components in the remote scope are corrupted or missing) |
|
|
737
741
|
| `--all-versions` | | export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing) |
|
|
738
742
|
| `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
|
|
@@ -745,25 +749,25 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
745
749
|
|
|
746
750
|
## fork
|
|
747
751
|
|
|
748
|
-
**Description**: create a new component
|
|
752
|
+
**Description**: create a new component forked from an existing one (copies source files and configs)
|
|
749
753
|
|
|
750
754
|
`bit fork <source-component-id> [target-component-name]`
|
|
751
755
|
|
|
752
|
-
| **Arg** |
|
|
753
|
-
| ----------------------- |
|
|
754
|
-
| `source-component-id` |
|
|
755
|
-
| `target-component-name` | the name for the new component (component name without scope). to set a different scope, use the '--scope' flag |
|
|
756
|
+
| **Arg** | **Description** |
|
|
757
|
+
| ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------: |
|
|
758
|
+
| `source-component-id` | the component id of the source component |
|
|
759
|
+
| `target-component-name` | the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag |
|
|
756
760
|
|
|
757
|
-
| **Option** | **Option alias** | **Description**
|
|
758
|
-
| -------------------------------- | :--------------: |
|
|
759
|
-
| `--scope <string>` | `-s` | default scope for the new component
|
|
760
|
-
| `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>`
|
|
761
|
-
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace)
|
|
762
|
-
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components
|
|
763
|
-
| `--env <string>` | `-e` | set the environment for the new component
|
|
764
|
-
| `--skip-config` | | do not copy the config (aspects-config) to the new component. helpful when it fails during aspect loading |
|
|
765
|
-
| `--preserve` | | avoid
|
|
766
|
-
| `--no-link` | | avoid saving a reference to the original component
|
|
761
|
+
| **Option** | **Option alias** | **Description** |
|
|
762
|
+
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
|
|
763
|
+
| `--scope <string>` | `-s` | default scope for the new component |
|
|
764
|
+
| `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
|
|
765
|
+
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
|
|
766
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
767
|
+
| `--env <string>` | `-e` | set the environment for the new component |
|
|
768
|
+
| `--skip-config` | | do not copy the config (aspects-config, env, etc) to the new component. helpful when it fails during aspect loading |
|
|
769
|
+
| `--preserve` | | avoid refactoring file and variable/class names according to the new component name |
|
|
770
|
+
| `--no-link` | | avoid saving a reference to the original component |
|
|
767
771
|
|
|
768
772
|
---
|
|
769
773
|
|
|
@@ -819,13 +823,13 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
819
823
|
|
|
820
824
|
## graph
|
|
821
825
|
|
|
822
|
-
**Description**: generate an image file with the dependencies graph
|
|
826
|
+
**Description**: generate an image file with the workspace components' dependencies graph
|
|
823
827
|
|
|
824
828
|
`bit graph [id]`
|
|
825
829
|
|
|
826
830
|
| **Option** | **Option alias** | **Description** |
|
|
827
831
|
| ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
|
|
828
|
-
| `--image <image>` | `-i` | image path. use one of the following extensions: [gif, png, svg, pdf]
|
|
832
|
+
| `--image <image>` | `-i` | image path and format. use one of the following extensions: [gif, png, svg, pdf] |
|
|
829
833
|
| `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
|
|
830
834
|
| `--all-versions` | | enter all components versions into the graph, not only latest |
|
|
831
835
|
| `--layout <name>` | | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
|
|
@@ -856,23 +860,22 @@ bit export => export all staged components to their current scope, if checked ou
|
|
|
856
860
|
| ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
857
861
|
| `component-patterns...` | component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., "utils/\*" (wrap with double quotes) |
|
|
858
862
|
|
|
859
|
-
| **Option** | **Option alias** | **Description**
|
|
860
|
-
| -------------------------------- | :--------------: |
|
|
861
|
-
| `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace)
|
|
862
|
-
| `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is
|
|
863
|
-
| `--
|
|
864
|
-
| `--
|
|
865
|
-
| `--
|
|
866
|
-
| `--
|
|
867
|
-
| `--
|
|
868
|
-
| `--
|
|
869
|
-
| `--
|
|
870
|
-
| `--
|
|
871
|
-
| `--
|
|
872
|
-
| `--
|
|
873
|
-
| `--
|
|
874
|
-
| `--
|
|
875
|
-
| `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
|
|
863
|
+
| **Option** | **Option alias** | **Description** |
|
|
864
|
+
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
865
|
+
| `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
|
|
866
|
+
| `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |
|
|
867
|
+
| `--override` | `-O` | override local changes |
|
|
868
|
+
| `--verbose` | `-v` | show verbose output for inspection |
|
|
869
|
+
| `--json` | `-j` | return the output as JSON |
|
|
870
|
+
| `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
|
|
871
|
+
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
|
|
872
|
+
| `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
|
|
873
|
+
| `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
|
|
874
|
+
| `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
|
|
875
|
+
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
876
|
+
| `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |
|
|
877
|
+
| `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
|
|
878
|
+
| `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
|
|
876
879
|
|
|
877
880
|
---
|
|
878
881
|
|
|
@@ -883,22 +886,22 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
|
|
|
883
886
|
|
|
884
887
|
`bit init [path]`
|
|
885
888
|
|
|
886
|
-
| **Option** | **Option alias** | **Description**
|
|
887
|
-
| ----------------------------------------- | :--------------: |
|
|
888
|
-
| `--bare [name]` | `-b` | initialize an empty bit bare scope
|
|
889
|
-
| `--shared <groupname>` | `-s` | add group write permissions to a scope properly
|
|
890
|
-
| `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json
|
|
891
|
-
| `--reset` | `-r` | write missing or damaged Bit files
|
|
892
|
-
| `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects)
|
|
893
|
-
| `--reset-lane-new` | | same as reset-new, but it only
|
|
894
|
-
| `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-
|
|
895
|
-
| `--reset-scope` | | removes local scope (.bit or .git/bit). snaps that
|
|
896
|
-
| `--default-directory <default-directory>` | `-d` | set
|
|
897
|
-
| `--default-scope <default-scope>` | | set
|
|
898
|
-
| `--package-manager <package-manager>` | `-p` | set
|
|
899
|
-
| `--force` | `-f` | force workspace initialization without clearing local objects
|
|
900
|
-
| `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now
|
|
901
|
-
| `--interactive` | `-I` | EXPERIMENTAL. start an interactive process
|
|
889
|
+
| **Option** | **Option alias** | **Description** |
|
|
890
|
+
| ----------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
891
|
+
| `--bare [name]` | `-b` | initialize an empty bit bare scope |
|
|
892
|
+
| `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
|
|
893
|
+
| `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
|
|
894
|
+
| `--reset` | `-r` | write missing or damaged Bit files |
|
|
895
|
+
| `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
|
|
896
|
+
| `--reset-lane-new` | | same as reset-new, but it only resets components belong to lanes. main components are left intact |
|
|
897
|
+
| `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch |
|
|
898
|
+
| `--reset-scope` | | removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact |
|
|
899
|
+
| `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
|
|
900
|
+
| `--default-scope <default-scope>` | | set the default scope for components in the workspace |
|
|
901
|
+
| `--package-manager <package-manager>` | `-p` | set the package manager (npm or yarn) to be used in the workspace |
|
|
902
|
+
| `--force` | `-f` | force workspace initialization without clearing local objects |
|
|
903
|
+
| `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
|
|
904
|
+
| `--interactive` | `-I` | EXPERIMENTAL. start an interactive process |
|
|
902
905
|
|
|
903
906
|
---
|
|
904
907
|
|
|
@@ -917,7 +920,7 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
917
920
|
| **Option** | **Option alias** | **Description** |
|
|
918
921
|
| --------------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
|
|
919
922
|
| `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
|
|
920
|
-
| `--update` | `-u` | update all dependencies
|
|
923
|
+
| `--update` | `-u` | update all dependencies to latest version according to their semver range |
|
|
921
924
|
| `--update-existing [updateExisting]` | | DEPRECATED (not needed anymore, it is the default now). update existing dependencies version and types |
|
|
922
925
|
| `--save-prefix [savePrefix]` | | set the prefix to use when adding dependency to workspace.jsonc |
|
|
923
926
|
| `--skip-dedupe [skipDedupe]` | | do not dedupe dependencies on installation |
|
|
@@ -933,42 +936,42 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
933
936
|
## lane
|
|
934
937
|
|
|
935
938
|
**Alias**: `l`
|
|
936
|
-
**Description**: manage lanes
|
|
939
|
+
**Description**: manage lanes - if no sub-command is used, runs "bit lane list"
|
|
937
940
|
|
|
938
|
-
`bit lane [
|
|
941
|
+
`bit lane [sub-command]`
|
|
939
942
|
|
|
940
943
|
### lane list
|
|
941
944
|
|
|
942
945
|
**Usage**: `lane list`
|
|
943
946
|
|
|
944
|
-
**Description**: list lanes
|
|
947
|
+
**Description**: list local lanes
|
|
945
948
|
|
|
946
949
|
| **Option** | **Option alias** | **Description** |
|
|
947
950
|
| ------------------------------ | :--------------: | ------------------------------------------------------------- |
|
|
948
951
|
| `--details` | `-d` | show more details on the state of each component in each lane |
|
|
949
|
-
| `--json` | `-j` | show lanes details in a json format
|
|
950
|
-
| `--remote <remote-scope-name>` | `-r` | show remote lanes
|
|
951
|
-
| `--merged` | |
|
|
952
|
-
| `--not-merged` | |
|
|
952
|
+
| `--json` | `-j` | show lanes' details in a json format |
|
|
953
|
+
| `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
|
|
954
|
+
| `--merged` | | list only merged lanes |
|
|
955
|
+
| `--not-merged` | | list only lanes that haven't been merged |
|
|
953
956
|
|
|
954
957
|
### lane switch
|
|
955
958
|
|
|
956
|
-
**Usage**: `lane switch <lane
|
|
959
|
+
**Usage**: `lane switch <lane>`
|
|
957
960
|
|
|
958
961
|
**Description**: switch to the specified lane
|
|
959
962
|
|
|
960
|
-
| **Arg** |
|
|
961
|
-
| ------- |
|
|
962
|
-
| `lane` | lane-name or lane-id (if not
|
|
963
|
+
| **Arg** | **Description** |
|
|
964
|
+
| ------- | :------------------------------------------------------: |
|
|
965
|
+
| `lane` | lane-name or lane-id (if lane is not local) to switch to |
|
|
963
966
|
|
|
964
|
-
| **Option** | **Option alias** | **Description**
|
|
965
|
-
| -------------------------------- | :--------------: |
|
|
966
|
-
| `--alias <string>` | `-n` | relevant when the specified lane is a remote
|
|
967
|
-
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual"
|
|
968
|
-
| `--get-all` | `-a` | checkout all components in a lane
|
|
969
|
-
| `--skip-dependency-installation` | `-x` | do not install
|
|
970
|
-
| `--pattern <component-pattern>` | `-p` | switch only the specified component-pattern. works
|
|
971
|
-
| `--json` | `-j` | return the output as JSON
|
|
967
|
+
| **Option** | **Option alias** | **Description** |
|
|
968
|
+
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
969
|
+
| `--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 |
|
|
970
|
+
| `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
|
|
971
|
+
| `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
|
|
972
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
973
|
+
| `--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 |
|
|
974
|
+
| `--json` | `-j` | return the output as JSON |
|
|
972
975
|
|
|
973
976
|
### lane show
|
|
974
977
|
|
|
@@ -976,10 +979,10 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
976
979
|
|
|
977
980
|
**Description**: show lane details. if no lane specified, show the current lane
|
|
978
981
|
|
|
979
|
-
| **Option** | **Option alias** | **Description**
|
|
980
|
-
| ---------- | :--------------: |
|
|
981
|
-
| `--json` | `-j` | show the lane details in json format
|
|
982
|
-
| `--remote` | `-r` | show the lane
|
|
982
|
+
| **Option** | **Option alias** | **Description** |
|
|
983
|
+
| ---------- | :--------------: | ---------------------------------------------------- |
|
|
984
|
+
| `--json` | `-j` | show the lane details in json format |
|
|
985
|
+
| `--remote` | `-r` | show details of the remote head of the provided lane |
|
|
983
986
|
|
|
984
987
|
### lane create
|
|
985
988
|
|
|
@@ -987,48 +990,49 @@ when no package is specified, all workspace dependencies are installed and all w
|
|
|
987
990
|
|
|
988
991
|
**Description**: creates a new lane and switches to it
|
|
989
992
|
a lane created from main (default-lane) is empty until components are snapped.
|
|
990
|
-
a lane created from another lane
|
|
993
|
+
a lane created from another lane contains all the components of the original lane.
|
|
991
994
|
|
|
992
995
|
| **Arg** | **Description** |
|
|
993
996
|
| ----------- | :-----------------------: |
|
|
994
997
|
| `lane-name` | the name for the new lane |
|
|
995
998
|
|
|
996
|
-
| **Option** | **Option alias** | **Description**
|
|
997
|
-
| ----------------------------- | :--------------: |
|
|
998
|
-
| `--scope <scope-name>` | `-s` | remote scope
|
|
999
|
-
| `--remote-scope <scope-name>` | | DEPRECATED. use --scope
|
|
1000
|
-
| `--alias <name>` | | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias")
|
|
1001
|
-
| `--fork-lane-new-scope` | |
|
|
999
|
+
| **Option** | **Option alias** | **Description** |
|
|
1000
|
+
| ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1001
|
+
| `--scope <scope-name>` | `-s` | remote scope to which this lane will be exported, default to the workspace.json's defaultScope (can be changed up to first export of the lane with "bit lane change-scope") |
|
|
1002
|
+
| `--remote-scope <scope-name>` | | DEPRECATED. use --scope |
|
|
1003
|
+
| `--alias <name>` | | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias") |
|
|
1004
|
+
| `--fork-lane-new-scope` | | create the new lane in a different scope than its parent lane (if created from another lane) |
|
|
1002
1005
|
|
|
1003
1006
|
### lane remove
|
|
1004
1007
|
|
|
1005
1008
|
**Usage**: `lane remove <lanes...>`
|
|
1006
1009
|
|
|
1007
|
-
**Description**: remove lanes
|
|
1010
|
+
**Description**: remove or delete lanes
|
|
1008
1011
|
|
|
1009
1012
|
| **Arg** | **Description** |
|
|
1010
1013
|
| ---------- | :---------------------------------------: |
|
|
1011
1014
|
| `lanes...` | A list of lane names, separated by spaces |
|
|
1012
1015
|
|
|
1013
|
-
| **Option** | **Option alias** | **Description**
|
|
1014
|
-
| ---------- | :--------------: |
|
|
1015
|
-
| `--remote` | `-r` |
|
|
1016
|
-
| `--force` | `-f` | removes the lane even when the lane
|
|
1017
|
-
| `--silent` | `-s` | skip confirmation
|
|
1016
|
+
| **Option** | **Option alias** | **Description** |
|
|
1017
|
+
| ---------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1018
|
+
| `--remote` | `-r` | delete a remote lane. use remote/lane-id syntax e.g. bit lane remove owner.org/my-lane --remote. Delete is immediate, no export required |
|
|
1019
|
+
| `--force` | `-f` | removes/deletes the lane even when the lane is not yet merged to main |
|
|
1020
|
+
| `--silent` | `-s` | skip confirmation |
|
|
1018
1021
|
|
|
1019
1022
|
### lane change-scope
|
|
1020
1023
|
|
|
1021
1024
|
**Usage**: `lane change-scope <lane-name> <remote-scope-name>`
|
|
1022
1025
|
|
|
1023
|
-
**Description**: changes the remote scope of a lane
|
|
1026
|
+
**Description**: changes the remote scope of a lane
|
|
1027
|
+
NOTE: available only before the lane is exported to the remote
|
|
1024
1028
|
|
|
1025
1029
|
### lane alias
|
|
1026
1030
|
|
|
1027
1031
|
**Usage**: `lane alias <lane-name> <alias>`
|
|
1028
1032
|
|
|
1029
1033
|
**Description**: adds an alias to a lane
|
|
1030
|
-
an alias is a name that can be used to refer to a lane. it is saved locally and never
|
|
1031
|
-
it is useful when having multiple lanes with the same name, but with different remote scopes.
|
|
1034
|
+
an alias is a name that can be used locally to refer to a lane. it is saved locally and never reaches the remote.
|
|
1035
|
+
it is useful e.g. when having multiple lanes with the same name, but with different remote scopes.
|
|
1032
1036
|
|
|
1033
1037
|
### lane rename
|
|
1034
1038
|
|
|
@@ -1045,15 +1049,20 @@ bit lane diff => diff between the current lane and default lane. (only inside wo
|
|
|
1045
1049
|
bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
|
|
1046
1050
|
bit lane diff from to => diff between "from" lane and "to" lane.
|
|
1047
1051
|
|
|
1048
|
-
| **
|
|
1049
|
-
|
|
|
1050
|
-
|
|
|
1052
|
+
| **Arg** | **Description** |
|
|
1053
|
+
| ------- | :------------------------------: |
|
|
1054
|
+
| `from` | base lane for comparison |
|
|
1055
|
+
| `to` | lane being compared to base lane |
|
|
1056
|
+
|
|
1057
|
+
| **Option** | **Option alias** | **Description** |
|
|
1058
|
+
| ------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1059
|
+
| `--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 |
|
|
1051
1060
|
|
|
1052
1061
|
### lane add-readme
|
|
1053
1062
|
|
|
1054
1063
|
**Usage**: `lane add-readme <component-name> [lane-name]`
|
|
1055
1064
|
|
|
1056
|
-
**Description**: EXPERIMENTAL.
|
|
1065
|
+
**Description**: EXPERIMENTAL. sets an existing component as the readme of a lane
|
|
1057
1066
|
|
|
1058
1067
|
| **Arg** | **Description** |
|
|
1059
1068
|
| -------------- | :-------------------------------------------------------------------: |
|
|
@@ -1070,95 +1079,96 @@ bit lane diff from to => diff between "from" lane and "to" lane.
|
|
|
1070
1079
|
|
|
1071
1080
|
**Usage**: `lane import <lane>`
|
|
1072
1081
|
|
|
1073
|
-
**Description**: import a remote lane to your workspace
|
|
1082
|
+
**Description**: import a remote lane to your workspace and switch to that lane
|
|
1074
1083
|
|
|
1075
1084
|
| **Arg** | **Description** |
|
|
1076
1085
|
| ------- | :------------------: |
|
|
1077
1086
|
| `lane` | the remote lane name |
|
|
1078
1087
|
|
|
1079
|
-
| **Option** | **Option alias** | **Description**
|
|
1080
|
-
| -------------------------------- | :--------------: |
|
|
1081
|
-
| `--skip-dependency-installation` | `-x` | do not install
|
|
1082
|
-
| `--pattern <component-pattern>` | `-p` |
|
|
1088
|
+
| **Option** | **Option alias** | **Description** |
|
|
1089
|
+
| -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1090
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1091
|
+
| `--pattern <component-pattern>` | `-p` | import only components from the lane that fit the specified component-pattern to the workspace. works only when the workspace is empty |
|
|
1083
1092
|
|
|
1084
1093
|
### lane remove-comp
|
|
1085
1094
|
|
|
1086
1095
|
**Usage**: `lane remove-comp <component-pattern>`
|
|
1087
1096
|
|
|
1088
1097
|
**Description**: remove components when on a lane
|
|
1089
|
-
in case the components are part of the lane and the lane is exported, it marks the components as
|
|
1090
|
-
and then after snap+export, the remote-lane gets updated as well.
|
|
1098
|
+
in case the components are part of the lane and the lane is exported, it marks the components as
|
|
1099
|
+
removed from the lane, and then after snap+export, the remote-lane gets updated as well.
|
|
1100
|
+
upon lane-merge, these removed components are skipped and any changes for removed components won't be merged to main.
|
|
1091
1101
|
|
|
1092
|
-
in case the components are not part of the lane or the lane is new, it simply removes the components from the workspace
|
|
1102
|
+
in case the components are not yet part of the lane or the lane is new, it simply removes the components from the workspace
|
|
1093
1103
|
|
|
1094
1104
|
| **Arg** | **Description** |
|
|
1095
1105
|
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1096
1106
|
| `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 |
|
|
1097
1107
|
|
|
1098
|
-
| **Option** | **Option alias** | **Description**
|
|
1099
|
-
| ------------------ | :--------------: |
|
|
1100
|
-
| `--workspace-only` | | do not mark the components as removed. instead, remove them from the workspace only |
|
|
1101
|
-
| `--update-main` | | EXPERIMENTAL.
|
|
1108
|
+
| **Option** | **Option alias** | **Description** |
|
|
1109
|
+
| ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
|
|
1110
|
+
| `--workspace-only` | | do not mark the components as removed from the lane. instead, remove them from the workspace only |
|
|
1111
|
+
| `--update-main` | | EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main |
|
|
1102
1112
|
|
|
1103
1113
|
### lane merge
|
|
1104
1114
|
|
|
1105
1115
|
**Usage**: `lane merge <lane> [pattern]`
|
|
1106
1116
|
|
|
1107
|
-
**Description**: merge a local or a remote lane
|
|
1117
|
+
**Description**: merge a local or a remote lane to the current lane
|
|
1108
1118
|
by default, the provided lane will be fetched from the remote before merging.
|
|
1109
1119
|
to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
|
|
1110
1120
|
|
|
1111
|
-
when the current and
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
| **Arg** |
|
|
1115
|
-
| --------- |
|
|
1116
|
-
| `lane` |
|
|
1117
|
-
| `pattern` |
|
|
1118
|
-
|
|
1119
|
-
| **Option** | **Option alias** | **Description**
|
|
1120
|
-
| --------------------------------------- | :--------------: |
|
|
1121
|
-
| `--ours` | | DEPRECATED. use --auto-merge-resolve.
|
|
1122
|
-
| `--theirs` | | DEPRECATED. use --auto-merge-resolve.
|
|
1123
|
-
| `--manual` | | DEPRECATED. use --auto-merge-resolve
|
|
1124
|
-
| `--auto-merge-resolve <merge-strategy>` | | in case of a conflict, resolve according to the strategy: [ours, theirs, manual]
|
|
1125
|
-
| `--workspace` | | merge only components
|
|
1126
|
-
| `--no-snap` | | do not auto snap
|
|
1127
|
-
| `--tag` | | tag all lane components after merging into main (
|
|
1128
|
-
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build)
|
|
1129
|
-
| `--message <message>` | `-m` | override the default message for the auto snap
|
|
1130
|
-
| `--keep-readme` | | skip deleting the lane readme component after merging
|
|
1131
|
-
| `--no-squash` | | relevant for merging lanes into main, which by default
|
|
1132
|
-
| `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash
|
|
1133
|
-
| `--ignore-config-changes` | | allow merging when
|
|
1134
|
-
| `--verbose` | | show details of components that were not merged
|
|
1135
|
-
| `--skip-dependency-installation` | `-x` | do not install
|
|
1136
|
-
| `--skip-fetch` | | use the
|
|
1137
|
-
| `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the
|
|
1138
|
-
| `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main
|
|
1139
|
-
| `--include-non-lane-comps` | | when merging main, include workspace components that are not on the lane (by default only lane components are merged)
|
|
1121
|
+
when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,
|
|
1122
|
+
these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
|
|
1123
|
+
|
|
1124
|
+
| **Arg** | **Description** |
|
|
1125
|
+
| --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1126
|
+
| `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
|
|
1127
|
+
| `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 |
|
|
1128
|
+
|
|
1129
|
+
| **Option** | **Option alias** | **Description** |
|
|
1130
|
+
| --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1131
|
+
| `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
|
|
1132
|
+
| `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
|
|
1133
|
+
| `--manual` | | DEPRECATED. use --auto-merge-resolve |
|
|
1134
|
+
| `--auto-merge-resolve <merge-strategy>` | | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
|
|
1135
|
+
| `--workspace` | | merge only lane components that are in the current workspace |
|
|
1136
|
+
| `--no-snap` | | do not auto snap after merge completed without conflicts |
|
|
1137
|
+
| `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
|
|
1138
|
+
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
1139
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
1140
|
+
| `--keep-readme` | | skip deleting the lane readme component after merging |
|
|
1141
|
+
| `--no-squash` | | relevant for merging lanes into main, which by default squashes all lane snaps |
|
|
1142
|
+
| `--squash` | | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash |
|
|
1143
|
+
| `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
|
|
1144
|
+
| `--verbose` | | show details of components that were not merged successfully |
|
|
1145
|
+
| `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
|
|
1146
|
+
| `--skip-fetch` | | use the local state of target-lane if exits locally, without updating it from the remote |
|
|
1147
|
+
| `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components |
|
|
1148
|
+
| `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
|
|
1149
|
+
| `--include-non-lane-comps` | | when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
|
|
1140
1150
|
|
|
1141
1151
|
### lane merge-abort
|
|
1142
1152
|
|
|
1143
1153
|
**Usage**: `lane merge-abort`
|
|
1144
1154
|
|
|
1145
1155
|
**Description**: abort the recent lane-merge. revert the lane object and checkout accordingly
|
|
1146
|
-
restore the lane-object
|
|
1147
|
-
also, checkout the workspace components according to the restored lane
|
|
1156
|
+
restore the lane-object to its state before the last "bit lane merge" command.
|
|
1157
|
+
also, checkout the workspace components according to the restored lane state
|
|
1148
1158
|
|
|
1149
|
-
| **Option** | **Option alias** | **Description**
|
|
1150
|
-
| -------------------------------- | :--------------: |
|
|
1151
|
-
| `--verbose` | | show details of components that
|
|
1152
|
-
| `--silent` | `-s` | skip confirmation
|
|
1153
|
-
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components
|
|
1159
|
+
| **Option** | **Option alias** | **Description** |
|
|
1160
|
+
| -------------------------------- | :--------------: | -------------------------------------------------------- |
|
|
1161
|
+
| `--verbose` | | show details of components that didn't need to be merged |
|
|
1162
|
+
| `--silent` | `-s` | skip confirmation |
|
|
1163
|
+
| `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
|
|
1154
1164
|
|
|
1155
|
-
| **Option**
|
|
1156
|
-
|
|
|
1157
|
-
| `--details`
|
|
1158
|
-
| `--json`
|
|
1159
|
-
| `--remote <
|
|
1160
|
-
| `--merged`
|
|
1161
|
-
| `--not-merged`
|
|
1165
|
+
| **Option** | **Option alias** | **Description** |
|
|
1166
|
+
| ------------------------------ | :--------------: | ------------------------------------------------------------- |
|
|
1167
|
+
| `--details` | `-d` | show more details on the state of each component in each lane |
|
|
1168
|
+
| `--json` | `-j` | show lanes details in json format |
|
|
1169
|
+
| `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
|
|
1170
|
+
| `--merged` | | list only merged lanes |
|
|
1171
|
+
| `--not-merged` | | list only lanes that haven't been merged |
|
|
1162
1172
|
|
|
1163
1173
|
---
|
|
1164
1174
|
|
|
@@ -1200,18 +1210,17 @@ also, checkout the workspace components according to the restored lane
|
|
|
1200
1210
|
## list
|
|
1201
1211
|
|
|
1202
1212
|
**Alias**: `ls`
|
|
1203
|
-
**Description**: list components on a workspace
|
|
1204
|
-
https://bit.dev/docs/reference/cli-reference#list
|
|
1213
|
+
**Description**: list components on a workspace or a remote scope (with flag).
|
|
1205
1214
|
|
|
1206
1215
|
`bit list [remote-scope]`
|
|
1207
1216
|
|
|
1208
|
-
| **Option** | **Option alias** | **Description**
|
|
1209
|
-
| ---------------------- | :--------------: |
|
|
1210
|
-
| `--ids` | `-i` | show only component ids unformatted
|
|
1211
|
-
| `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies
|
|
1212
|
-
| `--outdated` | `-o` |
|
|
1213
|
-
| `--json` | `-j` | show the output in JSON format
|
|
1214
|
-
| `--namespace <string>` | `-n` | show only specified namespace
|
|
1217
|
+
| **Option** | **Option alias** | **Description** |
|
|
1218
|
+
| ---------------------- | :--------------: | --------------------------------------------------------------------------------------------- |
|
|
1219
|
+
| `--ids` | `-i` | show only component ids, unformatted |
|
|
1220
|
+
| `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
|
|
1221
|
+
| `--outdated` | `-o` | highlight outdated components, in comparison with their latest remote version (if one exists) |
|
|
1222
|
+
| `--json` | `-j` | show the output in JSON format |
|
|
1223
|
+
| `--namespace <string>` | `-n` | show only components in the specified namespace/s e.g. '-n ui' or '\*/ui' |
|
|
1215
1224
|
|
|
1216
1225
|
---
|
|
1217
1226
|
|
|
@@ -1256,14 +1265,14 @@ https://bit.dev/docs/reference/cli-reference#list
|
|
|
1256
1265
|
|
|
1257
1266
|
`bit login`
|
|
1258
1267
|
|
|
1259
|
-
| **Option** | **Option alias** | **Description**
|
|
1260
|
-
| --------------------------- | :--------------: |
|
|
1261
|
-
| `--hub-domain-login <url>` | `-d` | hub domain login url (default https://bit.cloud)
|
|
1262
|
-
| `--port <port>` | `-p` | port number to open for localhost server (default 8085)
|
|
1263
|
-
| `--suppress-browser-launch` | | do not open a browser for authentication
|
|
1264
|
-
| `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry
|
|
1265
|
-
| `--skip-registry-config` | | don't configure bit.cloud registry
|
|
1266
|
-
| `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally
|
|
1268
|
+
| **Option** | **Option alias** | **Description** |
|
|
1269
|
+
| --------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
|
|
1270
|
+
| `--hub-domain-login <url>` | `-d` | hub domain login url (default https://bit.cloud) |
|
|
1271
|
+
| `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
|
|
1272
|
+
| `--suppress-browser-launch` | | do not open a browser for authentication |
|
|
1273
|
+
| `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
|
|
1274
|
+
| `--skip-registry-config` | | don't configure bit.cloud registry |
|
|
1275
|
+
| `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token) |
|
|
1267
1276
|
|
|
1268
1277
|
---
|
|
1269
1278
|
|
|
@@ -1277,27 +1286,28 @@ https://bit.dev/docs/reference/cli-reference#list
|
|
|
1277
1286
|
|
|
1278
1287
|
## merge
|
|
1279
1288
|
|
|
1280
|
-
**Description**: merge changes of the remote head into local
|
|
1281
|
-
merge changes of the remote head into local. when on a lane, merge the remote head of the lane into the local
|
|
1289
|
+
**Description**: merge changes of the remote head into local - auto-snaps all merged components
|
|
1290
|
+
merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local
|
|
1291
|
+
and creates snaps for merged components that have diverged, on the lane.
|
|
1282
1292
|
if no ids are specified, all pending-merge components will be merged. (run "bit status" to list them).
|
|
1283
1293
|
optionally use '--abort' to revert the last merge. to revert a lane merge, use "bit lane merge-abort" command.
|
|
1284
1294
|
you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
1285
1295
|
|
|
1286
1296
|
`bit merge [ids...]`
|
|
1287
1297
|
|
|
1288
|
-
| **Option** | **Option alias** | **Description**
|
|
1289
|
-
| --------------------------------------- | :--------------: |
|
|
1290
|
-
| `--ours` | | DEPRECATED. use --auto-merge-resolve.
|
|
1291
|
-
| `--theirs` | | DEPRECATED. use --auto-merge-resolve.
|
|
1292
|
-
| `--manual` | | DEPRECATED. use --auto-merge-resolve
|
|
1293
|
-
| `--auto-merge-resolve <merge-strategy>` | | in case of a conflict, resolve according to the strategy: [ours, theirs, manual]
|
|
1294
|
-
| `--abort` | | in case of an unresolved merge, revert to
|
|
1295
|
-
| `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes
|
|
1296
|
-
| `--no-snap` | | do not auto snap
|
|
1297
|
-
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build)
|
|
1298
|
-
| `--verbose` | | show details of components that were not merged
|
|
1299
|
-
| `--skip-dependency-installation` | `-x` | do not install
|
|
1300
|
-
| `--message <message>` | `-m` | override the default message for the auto snap
|
|
1298
|
+
| **Option** | **Option alias** | **Description** |
|
|
1299
|
+
| --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
|
|
1300
|
+
| `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep the local modification |
|
|
1301
|
+
| `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override the local modification with the specified version |
|
|
1302
|
+
| `--manual` | | DEPRECATED. use --auto-merge-resolve |
|
|
1303
|
+
| `--auto-merge-resolve <merge-strategy>` | | in case of a conflict, resolve according to the strategy: [ours, theirs, manual] |
|
|
1304
|
+
| `--abort` | | in case of an unresolved merge, revert to pre-merge state |
|
|
1305
|
+
| `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes |
|
|
1306
|
+
| `--no-snap` | | do not auto snap even if the merge completed without conflicts |
|
|
1307
|
+
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
1308
|
+
| `--verbose` | | show details of components that were not merged successfully |
|
|
1309
|
+
| `--skip-dependency-installation` | `-x` | do not install new dependencies resulting from the merge |
|
|
1310
|
+
| `--message <message>` | `-m` | override the default message for the auto snap |
|
|
1301
1311
|
|
|
1302
1312
|
---
|
|
1303
1313
|
|
|
@@ -1305,8 +1315,8 @@ you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the
|
|
|
1305
1315
|
|
|
1306
1316
|
**Alias**: `ms`
|
|
1307
1317
|
**Description**: EXPERIMENTAL. basic status for fast execution
|
|
1308
|
-
shows only modified/new components. for the full status, use "bit status".
|
|
1309
|
-
|
|
1318
|
+
shows only modified/new components with code changes. for the full status, use "bit status".
|
|
1319
|
+
this command only checks source code changes, it doesn't check for config/aspect/dependency changes
|
|
1310
1320
|
|
|
1311
1321
|
`bit mini-status [component-pattern]`
|
|
1312
1322
|
|
|
@@ -1324,16 +1334,15 @@ the modified are components that their source code have changed, it doesn't chec
|
|
|
1324
1334
|
## move
|
|
1325
1335
|
|
|
1326
1336
|
**Alias**: `mv`
|
|
1327
|
-
**Description**: move a component to a different filesystem path
|
|
1328
|
-
move files or directories of component(s)
|
|
1329
|
-
https://bit.dev/docs/workspace/moving-components
|
|
1337
|
+
**Description**: move a component to a different filesystem path (note: this does NOT affect the component's name or scope, just its location in the workspace)
|
|
1338
|
+
move files or directories of component(s)
|
|
1330
1339
|
|
|
1331
1340
|
`bit move <current-component-dir> <new-component-dir>`
|
|
1332
1341
|
|
|
1333
|
-
| **Arg** |
|
|
1334
|
-
| ----------------------- |
|
|
1335
|
-
| `current-component-dir` |
|
|
1336
|
-
| `new-component-dir` |
|
|
1342
|
+
| **Arg** | **Description** |
|
|
1343
|
+
| ----------------------- | :--------------------------------------------------------------------------------------------: |
|
|
1344
|
+
| `current-component-dir` | the component's current directory (relative to the workspace root) |
|
|
1345
|
+
| `new-component-dir` | the new directory (relative to the workspace root) to create and move the component's files to |
|
|
1337
1346
|
|
|
1338
1347
|
---
|
|
1339
1348
|
|
|
@@ -1343,21 +1352,21 @@ move files or directories of component(s)
|
|
|
1343
1352
|
|
|
1344
1353
|
`bit new <template-name> <workspace-name>`
|
|
1345
1354
|
|
|
1346
|
-
| **Arg** |
|
|
1347
|
-
| ---------------- |
|
|
1348
|
-
| `template-name` | the name of the workspace template (run 'bit templates'
|
|
1349
|
-
| `workspace-name` |
|
|
1355
|
+
| **Arg** | **Description** |
|
|
1356
|
+
| ---------------- | :----------------------------------------------------------------------------------------------------------------------------: |
|
|
1357
|
+
| `template-name` | the name of the workspace template (run 'bit templates' outside of a workspace to get a list of available workspace templates) |
|
|
1358
|
+
| `workspace-name` | the name for the new workspace and workspace directory that will be created |
|
|
1350
1359
|
|
|
1351
|
-
| **Option** | **Option alias** | **Description**
|
|
1352
|
-
| -------------------------------- | :--------------: |
|
|
1353
|
-
| `--aspect <aspect-id>` | `-a` |
|
|
1354
|
-
| `--template <env-id>` | `-t` | env-id of the template.
|
|
1355
|
-
| `--env <env-id>` | | env-id of the template
|
|
1356
|
-
| `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc
|
|
1357
|
-
| `--standalone` | | DEPRECATED. use --skip-git instead
|
|
1358
|
-
| `--skip-git` | `-s` | skip generation of Git repository
|
|
1359
|
-
| `--empty` | `-e` |
|
|
1360
|
-
| `--load-from <path-to-template>` | | path to the workspace containing the template.
|
|
1360
|
+
| **Option** | **Option alias** | **Description** |
|
|
1361
|
+
| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
|
|
1362
|
+
| `--aspect <aspect-id>` | `-a` | id of the aspect that registered the template, mandatory for non-core aspects. helpful for core aspects in case of a name collision |
|
|
1363
|
+
| `--template <env-id>` | `-t` | env-id of the template's owner. Alias for --env. |
|
|
1364
|
+
| `--env <env-id>` | | env-id of the template. Alias -t |
|
|
1365
|
+
| `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace's workspace.jsonc |
|
|
1366
|
+
| `--standalone` | | DEPRECATED. use --skip-git instead |
|
|
1367
|
+
| `--skip-git` | `-s` | skip generation of Git repository in the new workspace |
|
|
1368
|
+
| `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
|
|
1369
|
+
| `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during a development of a workspace-template |
|
|
1361
1370
|
|
|
1362
1371
|
---
|
|
1363
1372
|
|
|
@@ -1366,11 +1375,11 @@ move files or directories of component(s)
|
|
|
1366
1375
|
**Description**: list the component ids matching the given pattern
|
|
1367
1376
|
this command helps validating a pattern before using it in other commands.
|
|
1368
1377
|
a pattern can be a simple component-id or component-name. e.g. "ui/button".
|
|
1369
|
-
a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".
|
|
1378
|
+
a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**" or "**/utils/**" to capture all org/scopes.
|
|
1370
1379
|
to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"
|
|
1371
1380
|
to exclude, use "!". e.g. "ui/**, !ui/button"
|
|
1372
1381
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
1373
|
-
the matching algorithm is
|
|
1382
|
+
the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch)
|
|
1374
1383
|
|
|
1375
1384
|
`bit pattern <pattern>`
|
|
1376
1385
|
|
|
@@ -1382,7 +1391,7 @@ the matching algorithm is done by multimatch (@see https://github.com/sindresorh
|
|
|
1382
1391
|
|
|
1383
1392
|
## recover
|
|
1384
1393
|
|
|
1385
|
-
**Description**: EXPERIMENTAL. recover
|
|
1394
|
+
**Description**: EXPERIMENTAL. recover component(s) soft-deleted from the workspace, or a remote scope
|
|
1386
1395
|
|
|
1387
1396
|
`bit recover <component-name>`
|
|
1388
1397
|
|
|
@@ -1409,8 +1418,7 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
|
|
|
1409
1418
|
|
|
1410
1419
|
## remote
|
|
1411
1420
|
|
|
1412
|
-
**Description**: manage set of tracked bit scope(s)
|
|
1413
|
-
https://bit.dev/reference/scope/remote-scopes
|
|
1421
|
+
**Description**: manage set of tracked bit scope(s)
|
|
1414
1422
|
|
|
1415
1423
|
`bit remote`
|
|
1416
1424
|
|
|
@@ -1432,9 +1440,9 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
|
1432
1440
|
|
|
1433
1441
|
**Description**: remove a tracked bit remote
|
|
1434
1442
|
|
|
1435
|
-
| **Option** | **Option alias** | **Description**
|
|
1436
|
-
| ---------- | :--------------: |
|
|
1437
|
-
| `--global` | `-g` | remove a
|
|
1443
|
+
| **Option** | **Option alias** | **Description** |
|
|
1444
|
+
| ---------- | :--------------: | ----------------------------------------- |
|
|
1445
|
+
| `--global` | `-g` | remove a globally configured remote scope |
|
|
1438
1446
|
|
|
1439
1447
|
| **Option** | **Option alias** | **Description** |
|
|
1440
1448
|
| ---------- | :--------------: | ------------------------------- |
|
|
@@ -1445,13 +1453,13 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
|
1445
1453
|
## remove
|
|
1446
1454
|
|
|
1447
1455
|
**Alias**: `rm`
|
|
1448
|
-
**Description**: remove component(s) from the workspace, or a remote scope
|
|
1456
|
+
**Description**: remove component(s) from the workspace, or a remote scope (with a flag)
|
|
1449
1457
|
to remove components from your local workspace only, use "bit remove" (with no flags).
|
|
1450
1458
|
|
|
1451
1459
|
to remove a component from the remote scope, use "bit remove --delete", to mark the components as deleted.
|
|
1452
1460
|
once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.
|
|
1453
1461
|
|
|
1454
|
-
to remove components from
|
|
1462
|
+
to remove components from a lane, use "bit lane remove-comp".
|
|
1455
1463
|
|
|
1456
1464
|
`bit remove <component-pattern>`
|
|
1457
1465
|
|
|
@@ -1472,21 +1480,21 @@ to remove components from lanes, use "bit lane remove-comp".
|
|
|
1472
1480
|
|
|
1473
1481
|
## rename
|
|
1474
1482
|
|
|
1475
|
-
**Description**: rename component. if tagged/exported, create a new component and deprecate the original component
|
|
1483
|
+
**Description**: rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component
|
|
1476
1484
|
|
|
1477
1485
|
`bit rename <current-name> <new-name>`
|
|
1478
1486
|
|
|
1479
|
-
| **Arg** |
|
|
1480
|
-
| -------------- |
|
|
1481
|
-
| `current-name` |
|
|
1482
|
-
| `new-name` |
|
|
1487
|
+
| **Arg** | **Description** |
|
|
1488
|
+
| -------------- | :----------------------------------------------------------------------------------------------: |
|
|
1489
|
+
| `current-name` | the current component name (without its scope name) |
|
|
1490
|
+
| `new-name` | the new component name (without its scope name. use --scope to define the new component's scope) |
|
|
1483
1491
|
|
|
1484
|
-
| **Option** | **Option alias** | **Description**
|
|
1485
|
-
| ------------------------ | :--------------: |
|
|
1486
|
-
| `--scope <scope-name>` | `-s` |
|
|
1487
|
-
| `--path <relative-path>` | `-p` | relative path in the workspace. by default the
|
|
1488
|
-
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace)
|
|
1489
|
-
| `--preserve` | | avoid renaming files and variables/classes according to the new component name
|
|
1492
|
+
| **Option** | **Option alias** | **Description** |
|
|
1493
|
+
| ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1494
|
+
| `--scope <scope-name>` | `-s` | define the scope for the newly created component |
|
|
1495
|
+
| `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
|
|
1496
|
+
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
|
|
1497
|
+
| `--preserve` | | avoid renaming files and variables/classes according to the new component name |
|
|
1490
1498
|
|
|
1491
1499
|
---
|
|
1492
1500
|
|
|
@@ -1502,12 +1510,12 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1502
1510
|
| `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 |
|
|
1503
1511
|
| `component-version` | the version to untag (semver for tags. hash for snaps) |
|
|
1504
1512
|
|
|
1505
|
-
| **Option** | **Option alias** | **Description**
|
|
1506
|
-
| ---------- | :--------------: |
|
|
1507
|
-
| `--all` | `-a` | revert
|
|
1508
|
-
| `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted)
|
|
1509
|
-
| `--soft` | | revert only soft-tags (components tagged with --soft flag)
|
|
1510
|
-
| `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will
|
|
1513
|
+
| **Option** | **Option alias** | **Description** |
|
|
1514
|
+
| ---------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
1515
|
+
| `--all` | `-a` | revert all unexported tags/snaps for all components |
|
|
1516
|
+
| `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
|
|
1517
|
+
| `--soft` | | revert only soft-tags (components tagged with --soft flag) |
|
|
1518
|
+
| `--force` | `-f` | revert the tag even if it's used as a dependency. WARNING: components that depend on this tag will be corrupted |
|
|
1511
1519
|
|
|
1512
1520
|
---
|
|
1513
1521
|
|
|
@@ -1532,7 +1540,7 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1532
1540
|
## run
|
|
1533
1541
|
|
|
1534
1542
|
**Alias**: `c`
|
|
1535
|
-
**Description**: run an app (independent of bit's dev server)
|
|
1543
|
+
**Description**: locally run an app component (independent of bit's dev server)
|
|
1536
1544
|
|
|
1537
1545
|
`bit run <app-name>`
|
|
1538
1546
|
|
|
@@ -1543,8 +1551,8 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1543
1551
|
| **Option** | **Option alias** | **Description** |
|
|
1544
1552
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------- |
|
|
1545
1553
|
| `--dev` | `-d` | start the application in dev mode. |
|
|
1546
|
-
| `--port [port-number]` | `-p` | port
|
|
1547
|
-
| `--verbose` | `-v` |
|
|
1554
|
+
| `--port [port-number]` | `-p` | port to run the app on |
|
|
1555
|
+
| `--verbose` | `-v` | show verbose output for inspection and print stack trace |
|
|
1548
1556
|
| `--skip-watch` | | avoid running the watch process that compiles components in the background |
|
|
1549
1557
|
| `--ssr` | | run app in server side rendering mode. |
|
|
1550
1558
|
|
|
@@ -1552,7 +1560,7 @@ https://bit.dev/docs/components/tags#undoing-a-tag
|
|
|
1552
1560
|
|
|
1553
1561
|
## schema
|
|
1554
1562
|
|
|
1555
|
-
**Description**: shows the API schema of
|
|
1563
|
+
**Description**: shows the API schema of the specified component/s.
|
|
1556
1564
|
you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
|
|
1557
1565
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1558
1566
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
@@ -1560,9 +1568,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1560
1568
|
|
|
1561
1569
|
`bit schema <pattern>`
|
|
1562
1570
|
|
|
1563
|
-
| **Option** | **Option alias** | **Description**
|
|
1564
|
-
| ---------- | :--------------: |
|
|
1565
|
-
| `--json` | `-j` | return the component
|
|
1571
|
+
| **Option** | **Option alias** | **Description** |
|
|
1572
|
+
| ---------- | :--------------: | ------------------------------------------ |
|
|
1573
|
+
| `--json` | `-j` | return the component schema in json format |
|
|
1566
1574
|
|
|
1567
1575
|
---
|
|
1568
1576
|
|
|
@@ -1576,8 +1584,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1576
1584
|
|
|
1577
1585
|
**Usage**: `scope set <scope-name> [component-pattern]`
|
|
1578
1586
|
|
|
1579
|
-
**Description**: Sets
|
|
1580
|
-
default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
|
|
1587
|
+
**Description**: Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace
|
|
1588
|
+
default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
|
|
1589
|
+
a component is set with a scope (as oppose to default scope) only once it is versioned.'
|
|
1581
1590
|
|
|
1582
1591
|
you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
|
|
1583
1592
|
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
@@ -1586,23 +1595,26 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1586
1595
|
|
|
1587
1596
|
| **Arg** | **Description** |
|
|
1588
1597
|
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1589
|
-
| `scope-name` |
|
|
1598
|
+
| `scope-name` | name of the scope to set |
|
|
1590
1599
|
| `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 |
|
|
1591
1600
|
|
|
1592
1601
|
### scope rename
|
|
1593
1602
|
|
|
1594
1603
|
**Usage**: `scope rename <current-scope-name> <new-scope-name>`
|
|
1595
1604
|
|
|
1596
|
-
**Description**: Renames the scope name for all components with the specified 'current scope name'
|
|
1605
|
+
**Description**: Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged
|
|
1606
|
+
Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`
|
|
1607
|
+
as the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file
|
|
1608
|
+
as a result of this change
|
|
1597
1609
|
|
|
1598
1610
|
| **Arg** | **Description** |
|
|
1599
1611
|
| -------------------- | :-------------------------------------------------: |
|
|
1600
1612
|
| `current-scope-name` | the scope name to be replaced by another scope name |
|
|
1601
1613
|
| `new-scope-name` | a new scope name to replace the current scope name |
|
|
1602
1614
|
|
|
1603
|
-
| **Option** | **Option alias** | **Description**
|
|
1604
|
-
| ------------ | :--------------: |
|
|
1605
|
-
| `--refactor` | `-r` | update the import statements in all dependent components to the new package name (
|
|
1615
|
+
| **Option** | **Option alias** | **Description** |
|
|
1616
|
+
| ------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
1617
|
+
| `--refactor` | `-r` | update the import statements in all dependent components to the new package name (i.e. with the new scope name) |
|
|
1606
1618
|
|
|
1607
1619
|
### scope rename-owner
|
|
1608
1620
|
|
|
@@ -1623,7 +1635,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1623
1635
|
|
|
1624
1636
|
**Usage**: `scope fork <original-scope> <new-scope>`
|
|
1625
1637
|
|
|
1626
|
-
**Description**: fork all components of the original-scope and refactor the source-code to use the new
|
|
1638
|
+
**Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
|
|
1627
1639
|
|
|
1628
1640
|
---
|
|
1629
1641
|
|
|
@@ -1681,40 +1693,40 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1681
1693
|
| ---------------- | :----------------------------: |
|
|
1682
1694
|
| `component-name` | component name or component id |
|
|
1683
1695
|
|
|
1684
|
-
| **Option** | **Option alias** | **Description**
|
|
1685
|
-
| ----------- | :--------------: |
|
|
1686
|
-
| `--json` | `-j` | return the component data in
|
|
1687
|
-
| `--legacy` | `-l` | use the legacy bit show.
|
|
1688
|
-
| `--remote` | `-r` | show a remote component
|
|
1689
|
-
| `--compare` | `-c` | compare current file system component to
|
|
1696
|
+
| **Option** | **Option alias** | **Description** |
|
|
1697
|
+
| ----------- | :--------------: | ------------------------------------------------------------------------------------------------ |
|
|
1698
|
+
| `--json` | `-j` | return the component data in json format |
|
|
1699
|
+
| `--legacy` | `-l` | use the legacy bit show. |
|
|
1700
|
+
| `--remote` | `-r` | show data for a remote component |
|
|
1701
|
+
| `--compare` | `-c` | legacy-only. compare current file system component to its latest tagged version [default=latest] |
|
|
1690
1702
|
|
|
1691
1703
|
---
|
|
1692
1704
|
|
|
1693
1705
|
## snap
|
|
1694
1706
|
|
|
1695
|
-
**Description**: create an immutable and exportable component snapshot (
|
|
1707
|
+
**Description**: create an immutable and exportable component snapshot (non-release version)
|
|
1696
1708
|
|
|
1697
1709
|
`bit snap [component-pattern]`
|
|
1698
1710
|
|
|
1699
|
-
| **Arg** |
|
|
1700
|
-
| ------------------- |
|
|
1701
|
-
| `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,
|
|
1711
|
+
| **Arg** | **Description** |
|
|
1712
|
+
| ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1713
|
+
| `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). |
|
|
1702
1714
|
|
|
1703
1715
|
| **Option** | **Option alias** | **Description** |
|
|
1704
1716
|
| -------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1705
|
-
| `--message <message>` | `-m` |
|
|
1717
|
+
| `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
|
|
1706
1718
|
| `--unmodified` | | include unmodified components (by default, only new and modified components are snapped) |
|
|
1707
1719
|
| `--unmerged` | | complete a merge process by snapping the unmerged components |
|
|
1708
|
-
| `--build` | `-b` | not needed for now. run the build pipeline in case the feature-flag build-on-ci is enabled
|
|
1709
|
-
| `--editor [editor]` | | open an editor to write a
|
|
1720
|
+
| `--build` | `-b` | not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled |
|
|
1721
|
+
| `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
|
|
1710
1722
|
| `--skip-tests` | | skip running component tests during snap process |
|
|
1711
1723
|
| `--skip-auto-snap` | | skip auto snapping dependents |
|
|
1712
|
-
| `--disable-snap-pipeline` | | skip the snap pipeline
|
|
1724
|
+
| `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
|
|
1713
1725
|
| `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
|
|
1714
|
-
| `--ignore-build-errors` | |
|
|
1726
|
+
| `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
|
|
1715
1727
|
| `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
|
|
1716
|
-
| `--all` | `-a` | DEPRECATED (not needed anymore,
|
|
1717
|
-
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its
|
|
1728
|
+
| `--all` | `-a` | DEPRECATED (not needed anymore, now the default). snap all new and modified components |
|
|
1729
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
1718
1730
|
| `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-snap even if tests are failing and even when component has not changed |
|
|
1719
1731
|
|
|
1720
1732
|
---
|
|
@@ -1730,32 +1742,32 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
|
|
|
1730
1742
|
| ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1731
1743
|
| `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 |
|
|
1732
1744
|
|
|
1733
|
-
| **Option** | **Option alias** | **Description**
|
|
1734
|
-
| ----------------------- | :--------------: |
|
|
1735
|
-
| `--dev` | `-d` | start UI server in dev mode.
|
|
1736
|
-
| `--port [port-number]` | `-p` | port of the UI server.
|
|
1737
|
-
| `--rebuild` | `-r` | rebuild the UI
|
|
1738
|
-
| `--skip-ui-build` | | skip building UI
|
|
1739
|
-
| `--verbose` | `-v` | show verbose output for inspection and prints stack trace
|
|
1740
|
-
| `--no-browser` | `-n` | do not automatically open browser when ready
|
|
1741
|
-
| `--skip-compilation` | | skip the auto-compilation before starting the web-server
|
|
1742
|
-
| `--ui-root-name [type]` | `-u` | name of the ui root to use, e.g. "teambit.scope/scope" or "teambit.workspace/workspace"
|
|
1745
|
+
| **Option** | **Option alias** | **Description** |
|
|
1746
|
+
| ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
|
|
1747
|
+
| `--dev` | `-d` | start UI server in dev mode. |
|
|
1748
|
+
| `--port [port-number]` | `-p` | port of the UI server. |
|
|
1749
|
+
| `--rebuild` | `-r` | rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case) |
|
|
1750
|
+
| `--skip-ui-build` | | skip building UI |
|
|
1751
|
+
| `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
|
|
1752
|
+
| `--no-browser` | `-n` | do not automatically open browser when ready |
|
|
1753
|
+
| `--skip-compilation` | | skip the auto-compilation before starting the web-server |
|
|
1754
|
+
| `--ui-root-name [type]` | `-u` | name of the ui root to use, e.g. "teambit.scope/scope" or "teambit.workspace/workspace" |
|
|
1743
1755
|
|
|
1744
1756
|
---
|
|
1745
1757
|
|
|
1746
1758
|
## status
|
|
1747
1759
|
|
|
1748
1760
|
**Alias**: `s`
|
|
1749
|
-
**Description**: present the current status of components in the workspace,
|
|
1761
|
+
**Description**: present the current status of components in the workspace, including indication of detected issues
|
|
1750
1762
|
|
|
1751
1763
|
`bit status`
|
|
1752
1764
|
|
|
1753
|
-
| **Option** | **Option alias** | **Description**
|
|
1754
|
-
| ----------- | :--------------: |
|
|
1755
|
-
| `--json` | `-j` | return a json version of the component
|
|
1756
|
-
| `--verbose` | | show extra data: full snap hashes for staged and divergence point for lanes |
|
|
1757
|
-
| `--lanes` | `-l` | when on a lane, show updates from main and updates from forked lanes
|
|
1758
|
-
| `--strict` | | in case issues found, exit with code 1
|
|
1765
|
+
| **Option** | **Option alias** | **Description** |
|
|
1766
|
+
| ----------- | :--------------: | --------------------------------------------------------------------------------------- |
|
|
1767
|
+
| `--json` | `-j` | return a json version of the component |
|
|
1768
|
+
| `--verbose` | | show extra data: full snap hashes for staged components, and divergence point for lanes |
|
|
1769
|
+
| `--lanes` | `-l` | when on a lane, show updates from main and updates from forked lanes |
|
|
1770
|
+
| `--strict` | | in case issues found, exit with code 1 |
|
|
1759
1771
|
|
|
1760
1772
|
---
|
|
1761
1773
|
|
|
@@ -1782,9 +1794,9 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1782
1794
|
|
|
1783
1795
|
`bit tag [component-patterns...]`
|
|
1784
1796
|
|
|
1785
|
-
| **Arg** |
|
|
1786
|
-
| ----------------------- |
|
|
1787
|
-
| `component-patterns...` |
|
|
1797
|
+
| **Arg** | **Description** |
|
|
1798
|
+
| ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1799
|
+
| `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. |
|
|
1788
1800
|
|
|
1789
1801
|
| **Option** | **Option alias** | **Description** |
|
|
1790
1802
|
| ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1798,7 +1810,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1798
1810
|
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
1799
1811
|
| `--major` | | syntactic sugar for "--increment major" |
|
|
1800
1812
|
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
1801
|
-
| `--snapped` | | tag components
|
|
1813
|
+
| `--snapped` | | tag only components whose head is a snap (not a tag) |
|
|
1802
1814
|
| `--unmerged` | | complete a merge process by tagging the unmerged components |
|
|
1803
1815
|
| `--skip-tests` | | skip running component tests during tag process |
|
|
1804
1816
|
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
@@ -1806,22 +1818,22 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
|
|
|
1806
1818
|
| `--persist` | | persist the changes generated by --soft tag |
|
|
1807
1819
|
| `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
|
|
1808
1820
|
| `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
|
|
1809
|
-
| `--ignore-build-errors` | |
|
|
1821
|
+
| `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
|
|
1810
1822
|
| `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
|
|
1811
1823
|
| `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
|
|
1812
|
-
| `--ignore-newest-version` | `-I` |
|
|
1813
|
-
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its
|
|
1824
|
+
| `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) |
|
|
1825
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
1814
1826
|
| `--build` | `-b` | not needed for now. run the pipeline build and complete the tag |
|
|
1815
1827
|
| `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
|
|
1816
|
-
| `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the
|
|
1817
|
-
| `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed
|
|
1828
|
+
| `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the local scope |
|
|
1829
|
+
| `--force` | `-f` | DEPRECATED (use "--skip-tests", "--ignore-build-errors" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
|
|
1818
1830
|
| `--disable-deploy-pipeline` | | DEPRECATED. use --disable-tag-pipeline instead |
|
|
1819
1831
|
|
|
1820
1832
|
---
|
|
1821
1833
|
|
|
1822
1834
|
## templates
|
|
1823
1835
|
|
|
1824
|
-
**Description**: list templates for "bit create" and "bit new"
|
|
1836
|
+
**Description**: list available templates for "bit create" and "bit new"
|
|
1825
1837
|
list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
|
|
1826
1838
|
|
|
1827
1839
|
`bit templates`
|
|
@@ -1836,7 +1848,7 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1836
1848
|
## test
|
|
1837
1849
|
|
|
1838
1850
|
**Alias**: `at`
|
|
1839
|
-
**Description**: test components in the workspace
|
|
1851
|
+
**Description**: test components in the workspace. by default only runs tests for new and modified components
|
|
1840
1852
|
|
|
1841
1853
|
`bit test [component-pattern]`
|
|
1842
1854
|
|
|
@@ -1851,7 +1863,7 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1851
1863
|
| `--all` | `-a` | test all components, not only new and modified |
|
|
1852
1864
|
| `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
|
|
1853
1865
|
| `--coverage` | | show code coverage data |
|
|
1854
|
-
| `--env <id>` | `-e` | test only the given env
|
|
1866
|
+
| `--env <id>` | `-e` | test only components assigned the given env |
|
|
1855
1867
|
| `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
|
|
1856
1868
|
|
|
1857
1869
|
---
|
|
@@ -1880,16 +1892,16 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1880
1892
|
|
|
1881
1893
|
`bit update [package-patterns...]`
|
|
1882
1894
|
|
|
1883
|
-
| **Arg** |
|
|
1884
|
-
| --------------------- |
|
|
1885
|
-
| `package-patterns...` | a list of package names, or patterns (separated by space). The patterns should be in glob format. By default, all packages are selected. |
|
|
1895
|
+
| **Arg** | **Description** |
|
|
1896
|
+
| --------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
1897
|
+
| `package-patterns...` | a string list of package names, or patterns (separated by space), e.g. "@teambit/** @my-org/ui/**". The patterns should be in glob format. By default, all packages are selected. |
|
|
1886
1898
|
|
|
1887
|
-
| **Option** | **Option alias** | **Description**
|
|
1888
|
-
| ---------- | :--------------: |
|
|
1889
|
-
| `--yes` | `-y` | automatically update all outdated packages
|
|
1890
|
-
| `--patch` | | update to the latest patch version. Semver rules are ignored
|
|
1891
|
-
| `--minor` | | update to the latest minor version. Semver rules are ignored
|
|
1892
|
-
| `--major` | | update to the latest major version. Semver rules are ignored
|
|
1899
|
+
| **Option** | **Option alias** | **Description** |
|
|
1900
|
+
| ---------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1901
|
+
| `--yes` | `-y` | automatically update all outdated versions for packages specified in pattern (all if no pattern supplied) - use carefully as could result in breaking updates for dependencies |
|
|
1902
|
+
| `--patch` | | update to the latest patch version. Semver rules are ignored |
|
|
1903
|
+
| `--minor` | | update to the latest minor version. Semver rules are ignored |
|
|
1904
|
+
| `--major` | | update to the latest major version. Semver rules are ignored |
|
|
1893
1905
|
|
|
1894
1906
|
---
|
|
1895
1907
|
|
|
@@ -1907,14 +1919,17 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1907
1919
|
|
|
1908
1920
|
## watch
|
|
1909
1921
|
|
|
1910
|
-
**Description**: automatically recompile modified components (on save)
|
|
1922
|
+
**Description**: automatically recompile modified components (on save)
|
|
1923
|
+
by default, the watcher doesn't use polling, to keep the CPU idle.
|
|
1924
|
+
in some rare cases, this could result in missing file events. to fix it, try to prefix this command with CHOKIDAR_USEPOLLING=true
|
|
1925
|
+
alternatively, restarting the computer could also help.
|
|
1911
1926
|
|
|
1912
1927
|
`bit watch`
|
|
1913
1928
|
|
|
1914
1929
|
| **Option** | **Option alias** | **Description** |
|
|
1915
1930
|
| ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1916
|
-
| `--verbose` | `-v` | show
|
|
1917
|
-
| `--skip-pre-compilation` | | skip
|
|
1931
|
+
| `--verbose` | `-v` | show all watch events and compiler verbose output |
|
|
1932
|
+
| `--skip-pre-compilation` | | skip compilation step before starting to watch |
|
|
1918
1933
|
| `--check-types [string]` | `-t` | EXPERIMENTAL. show errors/warnings for types. options are [file, project] to investigate only changed file or entire project. defaults to project |
|
|
1919
1934
|
|
|
1920
1935
|
---
|
|
@@ -1939,7 +1954,7 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1939
1954
|
| `--silent` | `-s` | do not prompt for confirmation |
|
|
1940
1955
|
| `--no-dedupe` | | write configs inside each one of the component's dir, avoid deduping |
|
|
1941
1956
|
| `--dry-run` | | show the paths that configs will be written per env |
|
|
1942
|
-
| `--dry-run-with-content` | | use with --json flag. show the config content and the paths
|
|
1957
|
+
| `--dry-run-with-content` | | use with --json flag. show the config content and the paths that will be written per env |
|
|
1943
1958
|
| `--verbose` | `-v` | showing verbose output for writing |
|
|
1944
1959
|
| `--json` | `-j` | json format |
|
|
1945
1960
|
|
|
@@ -1952,8 +1967,8 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
|
|
|
1952
1967
|
| **Option** | **Option alias** | **Description** |
|
|
1953
1968
|
| --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
1954
1969
|
| `--silent` | `-s` | do not prompt for confirmation |
|
|
1955
|
-
| `--writers <writers>` | `-w` | only
|
|
1956
|
-
| `--dry-run` | | show the paths
|
|
1970
|
+
| `--writers <writers>` | `-w` | only clean config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
|
|
1971
|
+
| `--dry-run` | | show the paths of configs that will be cleaned |
|
|
1957
1972
|
| `--json` | `-j` | json format |
|
|
1958
1973
|
|
|
1959
1974
|
### ws-config list
|