@teambit/harmony.content.cli-reference 1.95.65 → 1.95.66
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.json +1755 -1261
- package/cli-reference.mdx +344 -285
- package/dist/cli-reference.json +1755 -1261
- package/dist/cli-reference.mdx.js +805 -525
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.66.tgz +0 -0
- package/package.json +3 -3
- package/preview-1662069881993.js +5 -0
- package/package-tar/teambit-harmony.content.cli-reference-1.95.65.tgz +0 -0
- package/preview-1662060174180.js +0 -5
package/cli-reference.mdx
CHANGED
|
@@ -1,8 +1,3 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: cli-all
|
|
3
|
-
title: CLI Commands
|
|
4
|
-
---
|
|
5
|
-
|
|
6
1
|
# CLI Reference
|
|
7
2
|
|
|
8
3
|
Commands that are marked as workspace only must be executed inside a workspace. Commands that are marked as not workspace only, can be executed from anywhere and will run on a remote server.
|
|
@@ -11,27 +6,26 @@ Commands that are marked as workspace only must be executed inside a workspace.
|
|
|
11
6
|
|
|
12
7
|
**Alias**: `a`
|
|
13
8
|
**Workspace only**: yes
|
|
14
|
-
**Description**:
|
|
15
|
-
|
|
9
|
+
**Description**: Add any subset of files to be tracked as a component(s).
|
|
10
|
+
all flags support glob patterns and {PARENT} {FILE_NAME} annotations
|
|
16
11
|
https://bit.dev/docs/components/adding-components
|
|
17
12
|
|
|
18
13
|
`bit add [path...]`
|
|
19
14
|
|
|
20
|
-
| **Option**
|
|
21
|
-
|
|
|
22
|
-
| `--id <name>`
|
|
23
|
-
| `--main <file>`
|
|
24
|
-
| `--
|
|
25
|
-
| `--
|
|
26
|
-
| `--
|
|
27
|
-
| `--override <boolean>` | `-o` | override existing component if exists (default = false) |
|
|
15
|
+
| **Option** | **Option alias** | **Description** |
|
|
16
|
+
| ------------------------- | :--------------: | ------------------------------------------------------------------------------- |
|
|
17
|
+
| `--id <name>` | `-i` | manually set component id |
|
|
18
|
+
| `--main <file>` | `-m` | define entry point for the components |
|
|
19
|
+
| `--namespace <namespace>` | `-n` | organize component in a namespace |
|
|
20
|
+
| `--override <boolean>` | `-o` | override existing component if exists (default = false) |
|
|
21
|
+
| `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
|
|
28
22
|
|
|
29
23
|
---
|
|
30
24
|
|
|
31
25
|
## app
|
|
32
26
|
|
|
33
27
|
**Workspace only**: yes
|
|
34
|
-
**Description**:
|
|
28
|
+
**Description**: Manages apps
|
|
35
29
|
|
|
36
30
|
`bit app <sub-command>`
|
|
37
31
|
|
|
@@ -39,23 +33,36 @@ Commands that are marked as workspace only must be executed inside a workspace.
|
|
|
39
33
|
|
|
40
34
|
**Usage**: `app list`
|
|
41
35
|
|
|
42
|
-
**Description**: list all registered
|
|
36
|
+
**Description**: list all registered apps
|
|
43
37
|
|
|
44
38
|
| **Option** | **Option alias** | **Description** |
|
|
45
39
|
| ---------- | :--------------: | ---------------------------------------- |
|
|
46
40
|
| `--json` | `-j` | return the component data in json format |
|
|
47
41
|
|
|
42
|
+
### app run
|
|
43
|
+
|
|
44
|
+
**Usage**: `app run <app-name>`
|
|
45
|
+
|
|
46
|
+
**Description**: run an app (independent of bit's dev server)
|
|
47
|
+
|
|
48
|
+
| **Option** | **Option alias** | **Description** |
|
|
49
|
+
| -------------- | :--------------: | -------------------------------------------------------------------------- |
|
|
50
|
+
| `--dev` | `-d` | start the application in dev mode. |
|
|
51
|
+
| `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
|
|
52
|
+
| `--skip-watch` | | avoid running the watch process that compiles components in the background |
|
|
53
|
+
| `--ssr` | | run app in server side rendering mode. |
|
|
54
|
+
|
|
48
55
|
---
|
|
49
56
|
|
|
50
57
|
## artifacts
|
|
51
58
|
|
|
52
59
|
**Workspace only**: yes
|
|
53
|
-
**Description**: EXPERIMENTAL. list and download components artifacts
|
|
60
|
+
**Description**: EXPERIMENTAL. list and download components artifacts
|
|
54
61
|
artifacts are created on isolated capsules during tag or snap commands.
|
|
55
62
|
example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
|
|
56
63
|
and a package.tgz file generated by pkg aspect.
|
|
57
64
|
|
|
58
|
-
`bit artifacts <pattern
|
|
65
|
+
`bit artifacts <component-pattern>`
|
|
59
66
|
|
|
60
67
|
| **Option** | **Option alias** | **Description** |
|
|
61
68
|
| ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -77,10 +84,7 @@ and a package.tgz file generated by pkg aspect.
|
|
|
77
84
|
|
|
78
85
|
**Usage**: `aspect list [pattern]`
|
|
79
86
|
|
|
80
|
-
**Description**: list all aspects configured on component(s)
|
|
81
|
-
you can use a `<pattern>` for multiple component ids, such as `bit aspect list "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
82
|
-
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
83
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
87
|
+
**Description**: list all aspects configured on component(s)
|
|
84
88
|
|
|
85
89
|
| **Option** | **Option alias** | **Description** |
|
|
86
90
|
| ---------- | :--------------: | ------------------------------------------------- |
|
|
@@ -88,9 +92,9 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
88
92
|
|
|
89
93
|
### aspect get
|
|
90
94
|
|
|
91
|
-
**Usage**: `aspect get <component-
|
|
95
|
+
**Usage**: `aspect get <component-name>`
|
|
92
96
|
|
|
93
|
-
**Description**:
|
|
97
|
+
**Description**: list the aspects set on a component, as well as their config and data
|
|
94
98
|
|
|
95
99
|
| **Option** | **Option alias** | **Description** |
|
|
96
100
|
| ---------- | :--------------: | ------------------------------------------------- |
|
|
@@ -101,35 +105,23 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
101
105
|
|
|
102
106
|
**Usage**: `aspect set <pattern> <aspect-id> [config]`
|
|
103
107
|
|
|
104
|
-
**Description**: set an aspect to
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
108
|
+
**Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
|
|
109
|
+
|
|
110
|
+
| **Option** | **Option alias** | **Description** |
|
|
111
|
+
| ---------- | :--------------: | ---------------------------------------------------------------------------- |
|
|
112
|
+
| `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces the config) |
|
|
110
113
|
|
|
111
114
|
### aspect unset
|
|
112
115
|
|
|
113
116
|
**Usage**: `aspect unset <pattern> <aspect-id>`
|
|
114
117
|
|
|
115
|
-
**Description**: unset an aspect from component(s).
|
|
116
|
-
you can use a `<pattern>` for multiple component ids, such as `bit aspect unset "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
117
|
-
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
118
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
118
|
+
**Description**: unset an aspect from component(s).
|
|
119
119
|
|
|
120
120
|
### aspect update
|
|
121
121
|
|
|
122
122
|
**Usage**: `aspect update <aspect-id> [pattern]`
|
|
123
123
|
|
|
124
|
-
**Description**: update a version of an aspect
|
|
125
|
-
default to all components using the aspect, unless "pattern" is provided.
|
|
126
|
-
you can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
127
|
-
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
128
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
129
|
-
|
|
130
|
-
examples:
|
|
131
|
-
"bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version
|
|
132
|
-
"bit aspect update scope.org/aspect@2.0.0" - updates all components using scope.org/aspect to version 2.0.0.
|
|
124
|
+
**Description**: update a version of an aspect
|
|
133
125
|
|
|
134
126
|
---
|
|
135
127
|
|
|
@@ -138,7 +130,7 @@ examples:
|
|
|
138
130
|
**Workspace only**: yes
|
|
139
131
|
**Description**: run set of tasks for build
|
|
140
132
|
|
|
141
|
-
`bit build [pattern]`
|
|
133
|
+
`bit build [component-pattern]`
|
|
142
134
|
|
|
143
135
|
| **Option** | **Option alias** | **Description** |
|
|
144
136
|
| ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
|
|
@@ -156,8 +148,8 @@ examples:
|
|
|
156
148
|
## capsule
|
|
157
149
|
|
|
158
150
|
**Workspace only**: yes
|
|
159
|
-
**Description**: manage capsules
|
|
160
|
-
a capsule is a directory
|
|
151
|
+
**Description**: manage capsules
|
|
152
|
+
a capsule is a directory containing the component code, isolated from the workspace.
|
|
161
153
|
normally, capsules are created during the build process, the component files are copied and the packages are installed
|
|
162
154
|
via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for
|
|
163
155
|
other users after publishing/exporting them.
|
|
@@ -168,7 +160,7 @@ other users after publishing/exporting them.
|
|
|
168
160
|
|
|
169
161
|
**Usage**: `capsule list`
|
|
170
162
|
|
|
171
|
-
**Description**: list
|
|
163
|
+
**Description**: list the capsules generated for this workspace
|
|
172
164
|
|
|
173
165
|
| **Option** | **Option alias** | **Description** |
|
|
174
166
|
| ---------- | :--------------: | --------------- |
|
|
@@ -176,9 +168,9 @@ other users after publishing/exporting them.
|
|
|
176
168
|
|
|
177
169
|
### capsule create
|
|
178
170
|
|
|
179
|
-
**Usage**: `capsule create [
|
|
171
|
+
**Usage**: `capsule create [component-id...]`
|
|
180
172
|
|
|
181
|
-
**Description**: create capsules
|
|
173
|
+
**Description**: create capsules for components
|
|
182
174
|
|
|
183
175
|
| **Option** | **Option alias** | **Description** |
|
|
184
176
|
| -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
|
|
@@ -195,7 +187,8 @@ other users after publishing/exporting them.
|
|
|
195
187
|
|
|
196
188
|
**Usage**: `capsule delete`
|
|
197
189
|
|
|
198
|
-
**Description**: delete capsules
|
|
190
|
+
**Description**: delete capsules
|
|
191
|
+
with no args, only workspace's capsules are deleted
|
|
199
192
|
|
|
200
193
|
| **Option** | **Option alias** | **Description** |
|
|
201
194
|
| ----------------- | :--------------: | ------------------------------------------------- |
|
|
@@ -209,7 +202,7 @@ other users after publishing/exporting them.
|
|
|
209
202
|
**Workspace only**: yes
|
|
210
203
|
**Description**: check typescript types
|
|
211
204
|
|
|
212
|
-
`bit check-types [pattern]`
|
|
205
|
+
`bit check-types [component-pattern]`
|
|
213
206
|
|
|
214
207
|
| **Option** | **Option alias** | **Description** |
|
|
215
208
|
| ---------- | :--------------: | --------------------------------------------------------- |
|
|
@@ -222,9 +215,11 @@ other users after publishing/exporting them.
|
|
|
222
215
|
|
|
223
216
|
**Alias**: `U`
|
|
224
217
|
**Workspace only**: yes
|
|
225
|
-
**Description**: switch between component versions or remove local changes
|
|
226
|
-
|
|
227
|
-
|
|
218
|
+
**Description**: switch between component versions or remove local changes
|
|
219
|
+
|
|
220
|
+
`bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version
|
|
221
|
+
`bit checkout head` => checkout all components to their latest versions
|
|
222
|
+
`bit checkout head [ids...]` => checkout the specified ids to their latest versions
|
|
228
223
|
`bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)
|
|
229
224
|
you can use a pattern for multiple ids, such as bit checkout 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
230
225
|
|
|
@@ -236,7 +231,7 @@ other users after publishing/exporting them.
|
|
|
236
231
|
| `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
|
|
237
232
|
| `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
|
|
238
233
|
| `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
239
|
-
| `--reset` | `-r` |
|
|
234
|
+
| `--reset` | `-r` | revert changes that were not snapped/tagged |
|
|
240
235
|
| `--all` | `-a` | all components |
|
|
241
236
|
| `--verbose` | `-v` | showing verbose output for inspection |
|
|
242
237
|
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
|
|
@@ -283,15 +278,16 @@ The following gets removed by this command:
|
|
|
283
278
|
| **Option** | **Option alias** | **Description** |
|
|
284
279
|
| ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
285
280
|
| `--metadata` | | metadata/front-matter to place at the top of the .md file, enter as an object e.g. --metadata.id=cli --metadata.title=commands |
|
|
281
|
+
| `--json` | `-j` | output the commands info as JSON |
|
|
286
282
|
|
|
287
283
|
---
|
|
288
284
|
|
|
289
285
|
## compile
|
|
290
286
|
|
|
291
287
|
**Workspace only**: yes
|
|
292
|
-
**Description**: compile components in the
|
|
288
|
+
**Description**: compile components in the workspace
|
|
293
289
|
|
|
294
|
-
`bit compile [component...]`
|
|
290
|
+
`bit compile [component-names...]`
|
|
295
291
|
|
|
296
292
|
| **Option** | **Option alias** | **Description** |
|
|
297
293
|
| ------------------- | :--------------: | ------------------------------------------------------------- |
|
|
@@ -327,8 +323,8 @@ The following gets removed by this command:
|
|
|
327
323
|
## config
|
|
328
324
|
|
|
329
325
|
**Workspace only**: yes
|
|
330
|
-
**Description**: global config management
|
|
331
|
-
|
|
326
|
+
**Description**: global config management
|
|
327
|
+
https://bit.dev/docs/config/bit-config
|
|
332
328
|
|
|
333
329
|
`bit config`
|
|
334
330
|
|
|
@@ -361,9 +357,9 @@ The following gets removed by this command:
|
|
|
361
357
|
## create
|
|
362
358
|
|
|
363
359
|
**Workspace only**: yes
|
|
364
|
-
**Description**: create a new component
|
|
360
|
+
**Description**: create a new component (source files and config) using a template.
|
|
365
361
|
|
|
366
|
-
`bit create <
|
|
362
|
+
`bit create <template-name> <component-names...>`
|
|
367
363
|
|
|
368
364
|
| **Option** | **Option alias** | **Description** |
|
|
369
365
|
| ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
|
|
@@ -377,14 +373,44 @@ The following gets removed by this command:
|
|
|
377
373
|
|
|
378
374
|
## dependencies
|
|
379
375
|
|
|
376
|
+
**Alias**: `deps`
|
|
380
377
|
**Workspace only**: yes
|
|
381
|
-
**Description**:
|
|
378
|
+
**Description**: manage dependencies
|
|
379
|
+
|
|
380
|
+
`bit dependencies <sub-command>`
|
|
381
|
+
|
|
382
|
+
### dependencies get
|
|
383
|
+
|
|
384
|
+
**Usage**: `dependencies get <component-name>`
|
|
385
|
+
|
|
386
|
+
**Description**: show direct and indirect dependencies of the given component
|
|
387
|
+
|
|
388
|
+
| **Option** | **Option alias** | **Description** |
|
|
389
|
+
| ---------- | :--------------: | ---------------------------------------------------------------- |
|
|
390
|
+
| `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
|
|
391
|
+
|
|
392
|
+
### dependencies remove
|
|
393
|
+
|
|
394
|
+
**Usage**: `dependencies remove <component-pattern> <package...>`
|
|
395
|
+
|
|
396
|
+
**Description**: remove a dependency to component(s)
|
|
382
397
|
|
|
383
|
-
|
|
398
|
+
### dependencies debug
|
|
384
399
|
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
400
|
+
**Usage**: `dependencies debug <component-name>`
|
|
401
|
+
|
|
402
|
+
**Description**: show the immediate dependencies and how their versions were determined
|
|
403
|
+
|
|
404
|
+
### dependencies set
|
|
405
|
+
|
|
406
|
+
**Usage**: `dependencies set <component-pattern> <package...>`
|
|
407
|
+
|
|
408
|
+
**Description**: set a dependency to component(s)
|
|
409
|
+
|
|
410
|
+
| **Option** | **Option alias** | **Description** |
|
|
411
|
+
| ---------- | :--------------: | --------------------------- |
|
|
412
|
+
| `--dev` | `-d` | add to the devDependencies |
|
|
413
|
+
| `--peer` | `-p` | add to the peerDependencies |
|
|
388
414
|
|
|
389
415
|
---
|
|
390
416
|
|
|
@@ -393,7 +419,7 @@ The following gets removed by this command:
|
|
|
393
419
|
**Workspace only**: yes
|
|
394
420
|
**Description**: EXPERIMENTAL. show dependents of the given component
|
|
395
421
|
|
|
396
|
-
`bit dependents <
|
|
422
|
+
`bit dependents <component-name>`
|
|
397
423
|
|
|
398
424
|
---
|
|
399
425
|
|
|
@@ -403,7 +429,7 @@ The following gets removed by this command:
|
|
|
403
429
|
**Workspace only**: no
|
|
404
430
|
**Description**: deprecate a component
|
|
405
431
|
|
|
406
|
-
`bit deprecate <
|
|
432
|
+
`bit deprecate <component-name>`
|
|
407
433
|
|
|
408
434
|
| **Option** | **Option alias** | **Description** |
|
|
409
435
|
| ------------------- | :--------------: | ------------------------------------------------------------ |
|
|
@@ -414,8 +440,8 @@ The following gets removed by this command:
|
|
|
414
440
|
## diff
|
|
415
441
|
|
|
416
442
|
**Workspace only**: yes
|
|
417
|
-
**Description**: show diff between components files
|
|
418
|
-
|
|
443
|
+
**Description**: show the diff between the components' source files and config
|
|
444
|
+
bit diff => compare all modified components to their model version
|
|
419
445
|
bit diff [ids...] => compare the specified components against their modified states
|
|
420
446
|
bit diff [id] [version] => compare the specified version to used or modified files
|
|
421
447
|
bit diff [id] [version] [to_version] => compare the specified version files to to_version files
|
|
@@ -449,12 +475,9 @@ The following gets removed by this command:
|
|
|
449
475
|
|
|
450
476
|
**Alias**: `E`
|
|
451
477
|
**Workspace only**: yes
|
|
452
|
-
**Description**:
|
|
453
|
-
you can use a `<pattern>` for multiple component ids, such as `bit eject "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
454
|
-
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
455
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
478
|
+
**Description**: replace components maintained in the workspace with their corresponding packages
|
|
456
479
|
|
|
457
|
-
`bit eject <pattern>`
|
|
480
|
+
`bit eject <component-pattern>`
|
|
458
481
|
|
|
459
482
|
| **Option** | **Option alias** | **Description** |
|
|
460
483
|
| -------------- | :--------------: | --------------------------------------------------------------------------------- |
|
|
@@ -468,9 +491,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
468
491
|
|
|
469
492
|
**Workspace only**: yes
|
|
470
493
|
**Description**: eject components configuration (create a `component.json` file)
|
|
471
|
-
you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
|
|
494
|
+
you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
|
|
495
|
+
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
472
496
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
473
|
-
|
|
497
|
+
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
474
498
|
|
|
475
499
|
`bit eject-conf <pattern>`
|
|
476
500
|
|
|
@@ -485,7 +509,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
485
509
|
|
|
486
510
|
**Alias**: `env`
|
|
487
511
|
**Workspace only**: yes
|
|
488
|
-
**Description**: list all components envs
|
|
512
|
+
**Description**: list all components maintained by the workspace and their corresponding envs
|
|
489
513
|
|
|
490
514
|
`bit envs`
|
|
491
515
|
|
|
@@ -497,31 +521,32 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
497
521
|
|
|
498
522
|
### envs get
|
|
499
523
|
|
|
500
|
-
**Usage**: `envs get <name>`
|
|
524
|
+
**Usage**: `envs get <component-name>`
|
|
501
525
|
|
|
502
|
-
**Description**: show component's env
|
|
526
|
+
**Description**: show information about a component's env
|
|
503
527
|
|
|
504
528
|
### envs set
|
|
505
529
|
|
|
506
|
-
**Usage**: `envs set <pattern> <env>`
|
|
530
|
+
**Usage**: `envs set <component-pattern> <env>`
|
|
507
531
|
|
|
508
|
-
**Description**:
|
|
509
|
-
you can use a `<pattern>` for multiple component ids, such as `bit env set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
510
|
-
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
511
|
-
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
532
|
+
**Description**: Sets one or more components with a development environment (env)
|
|
512
533
|
|
|
513
534
|
### envs unset
|
|
514
535
|
|
|
515
|
-
**Usage**: `envs unset <component>`
|
|
536
|
+
**Usage**: `envs unset <component-pattern>`
|
|
516
537
|
|
|
517
|
-
**Description**:
|
|
518
|
-
|
|
538
|
+
**Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
|
|
539
|
+
keep in mind that this doesn't remove envs that are set in the variants.
|
|
540
|
+
in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
|
|
541
|
+
the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
|
|
542
|
+
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
|
|
543
|
+
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
519
544
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
520
|
-
|
|
545
|
+
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
521
546
|
|
|
522
547
|
### envs replace
|
|
523
548
|
|
|
524
|
-
**Usage**: `envs replace <
|
|
549
|
+
**Usage**: `envs replace <current-env> <new-env>`
|
|
525
550
|
|
|
526
551
|
**Description**: replace an existing env with another env for all components using the old env
|
|
527
552
|
|
|
@@ -531,44 +556,38 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
531
556
|
|
|
532
557
|
**Alias**: `e`
|
|
533
558
|
**Workspace only**: yes
|
|
534
|
-
**Description**: export components to
|
|
559
|
+
**Description**: export components from the workspace to remote scopes
|
|
535
560
|
bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well
|
|
536
|
-
`bit export [id...]` => export the given ids to their current scope
|
|
537
|
-
|
|
538
|
-
https://bit.dev/docs/components/exporting-components
|
|
539
|
-
you can use a pattern for multiple ids, such as bit export remote-scope "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
561
|
+
`bit export [id...]` => export the given ids to their current scope
|
|
562
|
+
you can use a pattern for multiple ids, such as bit export remote-scope "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
540
563
|
|
|
541
|
-
`bit export [
|
|
564
|
+
`bit export [component-patterns...]`
|
|
542
565
|
|
|
543
566
|
| **Option** | **Option alias** | **Description** |
|
|
544
567
|
| ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
545
|
-
| `--eject` | `-e` |
|
|
546
|
-
| `--all` | `-a` | export all components
|
|
547
|
-
| `--
|
|
548
|
-
| `--
|
|
549
|
-
| `--rewire` | `-r` | LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope |
|
|
550
|
-
| `--force` | `-f` | force changing a component remote without asking for a confirmation |
|
|
551
|
-
| `--all-versions` | | export not only staged versions but all of them |
|
|
552
|
-
| `--origin-directly` | | HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
|
|
568
|
+
| `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
|
|
569
|
+
| `--all` | `-a` | export all components, including non-staged (useful when components in the remote scope are corrupted or missing) |
|
|
570
|
+
| `--all-versions` | | export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing) |
|
|
571
|
+
| `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
|
|
553
572
|
| `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
|
|
554
573
|
| `--ignore-missing-artifacts` | | EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote |
|
|
574
|
+
| `--json` | `-j` | show output in json format |
|
|
555
575
|
|
|
556
576
|
---
|
|
557
577
|
|
|
558
578
|
## fork
|
|
559
579
|
|
|
560
580
|
**Workspace only**: no
|
|
561
|
-
**Description**: EXPERIMENTAL. create a new component out of an existing one
|
|
562
|
-
note that [target-name] is the name only without the scope.
|
|
563
|
-
to set the default-scope, please use --scope flag
|
|
581
|
+
**Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
|
|
564
582
|
|
|
565
|
-
`bit fork <source-id> [target-name]`
|
|
583
|
+
`bit fork <source-component-id> [target-component-name]`
|
|
566
584
|
|
|
567
|
-
| **Option**
|
|
568
|
-
|
|
|
569
|
-
| `--scope <string>`
|
|
570
|
-
| `--path <string>`
|
|
571
|
-
| `--refactor`
|
|
585
|
+
| **Option** | **Option alias** | **Description** |
|
|
586
|
+
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------- |
|
|
587
|
+
| `--scope <string>` | `-s` | default scope for the new component |
|
|
588
|
+
| `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
|
|
589
|
+
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
|
|
590
|
+
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
572
591
|
|
|
573
592
|
---
|
|
574
593
|
|
|
@@ -629,35 +648,35 @@ to set the default-scope, please use --scope flag
|
|
|
629
648
|
## import
|
|
630
649
|
|
|
631
650
|
**Workspace only**: yes
|
|
632
|
-
**Description**: import components
|
|
651
|
+
**Description**: import components from their remote scopes to the local workspace
|
|
633
652
|
https://bit.dev/docs/components/importing-components
|
|
634
653
|
you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
635
654
|
|
|
636
|
-
`bit import [
|
|
655
|
+
`bit import [component-patterns...]`
|
|
637
656
|
|
|
638
|
-
| **Option** | **Option alias** | **Description**
|
|
639
|
-
| -------------------------------- | :--------------: |
|
|
640
|
-
| `--path <path>` | `-p` | import components into a specific directory |
|
|
641
|
-
| `--objects` | `-o` | import components objects
|
|
642
|
-
| `--display-dependencies` | `-d` | display the imported dependencies
|
|
643
|
-
| `--override` | `-O` | override local changes
|
|
644
|
-
| `--verbose` | `-v` |
|
|
645
|
-
| `--json` | `-j` | return the output as JSON
|
|
646
|
-
| `--conf` | | write the configuration file (component.json) of the component
|
|
647
|
-
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead
|
|
648
|
-
| `--skip-dependency-installation` | | do not install packages of the imported components
|
|
649
|
-
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual"
|
|
650
|
-
| `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace
|
|
651
|
-
| `--dependents` | | EXPERIMENTAL. import
|
|
652
|
-
| `--
|
|
653
|
-
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always
|
|
657
|
+
| **Option** | **Option alias** | **Description** |
|
|
658
|
+
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
659
|
+
| `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
|
|
660
|
+
| `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument |
|
|
661
|
+
| `--display-dependencies` | `-d` | display the imported dependencies |
|
|
662
|
+
| `--override` | `-O` | override local changes |
|
|
663
|
+
| `--verbose` | `-v` | show verbose output for inspection |
|
|
664
|
+
| `--json` | `-j` | return the output as JSON |
|
|
665
|
+
| `--conf` | | write the configuration file (component.json) of the component |
|
|
666
|
+
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
|
|
667
|
+
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
668
|
+
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
|
|
669
|
+
| `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
|
|
670
|
+
| `--dependents` | | EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents |
|
|
671
|
+
| `--save-in-lane` | | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
|
|
672
|
+
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
654
673
|
|
|
655
674
|
---
|
|
656
675
|
|
|
657
676
|
## init
|
|
658
677
|
|
|
659
678
|
**Workspace only**: no
|
|
660
|
-
**Description**:
|
|
679
|
+
**Description**: create or reinitialize an empty workspace
|
|
661
680
|
https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
|
|
662
681
|
|
|
663
682
|
`bit init [path]`
|
|
@@ -670,7 +689,9 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
|
|
|
670
689
|
| `--reset` | `-r` | write missing or damaged Bit files |
|
|
671
690
|
| `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
|
|
672
691
|
| `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-start using Bit from scratch |
|
|
692
|
+
| `--reset-scope` | | removes local scope (.bit or .git/bit). snaps that were not exported will be lost. workspace left intact |
|
|
673
693
|
| `--default-directory <default-directory>` | `-d` | set up default directory to import components into |
|
|
694
|
+
| `--default-scope <default-scope>` | | set up default scope for all components in the workspace |
|
|
674
695
|
| `--package-manager <package-manager>` | `-p` | set up package manager (npm or yarn) |
|
|
675
696
|
| `--force` | `-f` | force workspace initialization without clearing local objects |
|
|
676
697
|
| `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
|
|
@@ -682,7 +703,8 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
|
|
|
682
703
|
|
|
683
704
|
**Alias**: `in`
|
|
684
705
|
**Workspace only**: yes
|
|
685
|
-
**Description**:
|
|
706
|
+
**Description**: installs workspace dependencies
|
|
707
|
+
when no package is specified, all workspace dependencies are installed and all workspace components are imported.
|
|
686
708
|
|
|
687
709
|
`bit install [packages...]`
|
|
688
710
|
|
|
@@ -701,10 +723,10 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
|
|
|
701
723
|
## link
|
|
702
724
|
|
|
703
725
|
**Workspace only**: yes
|
|
704
|
-
**Description**:
|
|
726
|
+
**Description**: create links in the node_modules directory, to core aspects and to components in the workspace
|
|
705
727
|
https://bit.dev/docs/workspace/component-links
|
|
706
728
|
|
|
707
|
-
`bit link [
|
|
729
|
+
`bit link [component-names...]`
|
|
708
730
|
|
|
709
731
|
| **Option** | **Option alias** | **Description** |
|
|
710
732
|
| ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
|
|
@@ -736,8 +758,8 @@ https://bit.dev/docs/workspace/component-links
|
|
|
736
758
|
|
|
737
759
|
**Alias**: `ls`
|
|
738
760
|
**Workspace only**: no
|
|
739
|
-
**Description**: list components on a local or a remote scope.
|
|
740
|
-
|
|
761
|
+
**Description**: list components on a workspace, local scope or a remote scope.
|
|
762
|
+
https://bit.dev/docs/reference/cli-reference#list
|
|
741
763
|
|
|
742
764
|
`bit list [remote-scope]`
|
|
743
765
|
|
|
@@ -745,8 +767,6 @@ https://bit.dev/docs/workspace/component-links
|
|
|
745
767
|
| ---------------------- | :--------------: | ------------------------------------------------------------------------------- |
|
|
746
768
|
| `--ids` | `-i` | show only component ids unformatted |
|
|
747
769
|
| `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
|
|
748
|
-
| `--bare` | `-b` | DEPRECATED. use --raw instead |
|
|
749
|
-
| `--raw` | `-r` | show raw output (only components ids, no styling) |
|
|
750
770
|
| `--outdated` | `-o` | show latest versions from remotes |
|
|
751
771
|
| `--json` | `-j` | show the output in JSON format |
|
|
752
772
|
| `--namespace <string>` | `-n` | show only specified namespace by using wildcards |
|
|
@@ -756,8 +776,8 @@ https://bit.dev/docs/workspace/component-links
|
|
|
756
776
|
## log
|
|
757
777
|
|
|
758
778
|
**Workspace only**: no
|
|
759
|
-
**Description**: show components(s)
|
|
760
|
-
|
|
779
|
+
**Description**: show components(s) version history
|
|
780
|
+
https://bit.dev/docs/reference/cli-reference#log
|
|
761
781
|
|
|
762
782
|
`bit log <id>`
|
|
763
783
|
|
|
@@ -765,13 +785,14 @@ https://bit.dev/docs/workspace/component-links
|
|
|
765
785
|
| ----------- | :--------------: | ----------------------------------------- |
|
|
766
786
|
| `--remote` | `-r` | show log of a remote component |
|
|
767
787
|
| `--parents` | | EXPERIMENTAL. show parents and lanes data |
|
|
788
|
+
| `--json` | `-j` | json format |
|
|
768
789
|
|
|
769
790
|
---
|
|
770
791
|
|
|
771
792
|
## login
|
|
772
793
|
|
|
773
794
|
**Workspace only**: no
|
|
774
|
-
**Description**: log
|
|
795
|
+
**Description**: log in to Bit cloud
|
|
775
796
|
|
|
776
797
|
`bit login`
|
|
777
798
|
|
|
@@ -781,7 +802,7 @@ https://bit.dev/docs/workspace/component-links
|
|
|
781
802
|
| `--suppress-browser-launch` | | do not open a browser for authentication |
|
|
782
803
|
| `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
|
|
783
804
|
| `--skip-registry-config` | | don't configure bit.cloud registry |
|
|
784
|
-
| `--machine-name <
|
|
805
|
+
| `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
|
|
785
806
|
|
|
786
807
|
---
|
|
787
808
|
|
|
@@ -798,22 +819,25 @@ https://bit.dev/docs/workspace/component-links
|
|
|
798
819
|
|
|
799
820
|
**Workspace only**: yes
|
|
800
821
|
**Description**: merge changes of different component versions
|
|
822
|
+
merge changes of different component versions
|
|
801
823
|
`bit merge <version> [ids...]` => merge changes of the given version into the checked out version
|
|
802
824
|
`bit merge [ids...]` => EXPERIMENTAL. merge changes of the remote head into local, optionally use '--abort' or '--resolve'
|
|
803
825
|
you can use a pattern for multiple ids, such as bit merge 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
804
826
|
|
|
805
827
|
`bit merge [values...]`
|
|
806
828
|
|
|
807
|
-
| **Option**
|
|
808
|
-
|
|
|
809
|
-
| `--ours`
|
|
810
|
-
| `--theirs`
|
|
811
|
-
| `--manual`
|
|
812
|
-
| `--abort`
|
|
813
|
-
| `--resolve`
|
|
814
|
-
| `--no-snap`
|
|
815
|
-
| `--build`
|
|
816
|
-
| `--
|
|
829
|
+
| **Option** | **Option alias** | **Description** |
|
|
830
|
+
| -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
|
|
831
|
+
| `--ours` | | in case of a conflict, override the used version with the current modification |
|
|
832
|
+
| `--theirs` | | in case of a conflict, override the current modification with the specified version |
|
|
833
|
+
| `--manual` | | in case of a conflict, leave the files with a conflict state to resolve them manually later |
|
|
834
|
+
| `--abort` | | EXPERIMENTAL. in case of an unresolved merge, revert to the state before the merge began |
|
|
835
|
+
| `--resolve` | | EXPERIMENTAL. mark an unresolved merge as resolved and create a new snap with the changes |
|
|
836
|
+
| `--no-snap` | | EXPERIMENTAL. do not auto snap in case the merge completed without conflicts |
|
|
837
|
+
| `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
|
|
838
|
+
| `--verbose` | | show details of components that were not merged legitimately |
|
|
839
|
+
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
840
|
+
| `--message <message>` | `-m` | EXPERIMENTAL. override the default message for the auto snap |
|
|
817
841
|
|
|
818
842
|
---
|
|
819
843
|
|
|
@@ -821,32 +845,29 @@ https://bit.dev/docs/workspace/component-links
|
|
|
821
845
|
|
|
822
846
|
**Alias**: `mv`
|
|
823
847
|
**Workspace only**: yes
|
|
824
|
-
**Description**: move
|
|
848
|
+
**Description**: move a component to a different filesystem path
|
|
849
|
+
move files or directories of component(s)
|
|
825
850
|
https://bit.dev/docs/workspace/moving-components
|
|
826
851
|
|
|
827
|
-
`bit move <
|
|
828
|
-
|
|
829
|
-
| **Option** | **Option alias** | **Description** |
|
|
830
|
-
| ------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
831
|
-
| `--component` | `-c` | move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
|
|
852
|
+
`bit move <current-component-dir> <new-component-dir>`
|
|
832
853
|
|
|
833
854
|
---
|
|
834
855
|
|
|
835
856
|
## new
|
|
836
857
|
|
|
837
858
|
**Workspace only**: yes
|
|
838
|
-
**Description**:
|
|
859
|
+
**Description**: create a new workspace from a template
|
|
839
860
|
|
|
840
|
-
`bit new <
|
|
861
|
+
`bit new <template-name> <workspace-name>`
|
|
841
862
|
|
|
842
|
-
| **Option**
|
|
843
|
-
|
|
|
844
|
-
| `--aspect <
|
|
845
|
-
| `--default-scope <
|
|
846
|
-
| `--standalone`
|
|
847
|
-
| `--skip-git`
|
|
848
|
-
| `--empty`
|
|
849
|
-
| `--load-from <
|
|
863
|
+
| **Option** | **Option alias** | **Description** |
|
|
864
|
+
| -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
|
|
865
|
+
| `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
|
|
866
|
+
| `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc |
|
|
867
|
+
| `--standalone` | | DEPRECATED. use --skip-git instead |
|
|
868
|
+
| `--skip-git` | `-s` | skip generation of Git repository |
|
|
869
|
+
| `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
|
|
870
|
+
| `--load-from <path-to-template>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
|
|
850
871
|
|
|
851
872
|
---
|
|
852
873
|
|
|
@@ -870,7 +891,14 @@ https://bit.dev/docs/workspace/component-links
|
|
|
870
891
|
## pattern
|
|
871
892
|
|
|
872
893
|
**Workspace only**: yes
|
|
873
|
-
**Description**: list the component ids matching the given pattern
|
|
894
|
+
**Description**: list the component ids matching the given pattern
|
|
895
|
+
this command helps validating a pattern before using it in other commands.
|
|
896
|
+
a pattern can be a simple component-id or component-name. e.g. "ui/button".
|
|
897
|
+
a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".
|
|
898
|
+
to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"
|
|
899
|
+
to exclude, use "!". e.g. "ui/**, !ui/button"
|
|
900
|
+
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
901
|
+
the matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)
|
|
874
902
|
|
|
875
903
|
`bit pattern <pattern>`
|
|
876
904
|
|
|
@@ -900,7 +928,7 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
|
|
|
900
928
|
|
|
901
929
|
**Workspace only**: yes
|
|
902
930
|
**Description**: manage set of tracked bit scope(s)
|
|
903
|
-
|
|
931
|
+
https://bit.dev/docs/scope/remote-scopes
|
|
904
932
|
|
|
905
933
|
`bit remote`
|
|
906
934
|
|
|
@@ -908,9 +936,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
|
|
|
908
936
|
|
|
909
937
|
**Usage**: `remote add <url>`
|
|
910
938
|
|
|
911
|
-
**Description**: add a bare-scope as a remote
|
|
912
|
-
|
|
913
|
-
|
|
939
|
+
**Description**: add a bare-scope as a remote
|
|
940
|
+
supported protocols are [file, http].
|
|
941
|
+
for example: "http://localhost:3000", "file:///tmp/local-scope"
|
|
914
942
|
|
|
915
943
|
| **Option** | **Option alias** | **Description** |
|
|
916
944
|
| ---------- | :--------------: | ---------------------------- |
|
|
@@ -936,17 +964,17 @@ Legacy support [file, ssh]. Harmony supports [file, http].
|
|
|
936
964
|
|
|
937
965
|
**Alias**: `rm`
|
|
938
966
|
**Workspace only**: no
|
|
939
|
-
**Description**: remove a
|
|
940
|
-
https://bit.dev/docs/components/removing-components
|
|
941
|
-
you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
967
|
+
**Description**: remove component(s) from the workspace, or a remote scope
|
|
942
968
|
|
|
943
|
-
`bit remove <
|
|
969
|
+
`bit remove <component-pattern>`
|
|
944
970
|
|
|
945
971
|
| **Option** | **Option alias** | **Description** |
|
|
946
972
|
| ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
947
|
-
| `--
|
|
948
|
-
| `--
|
|
949
|
-
| `--
|
|
973
|
+
| `--soft` | | EXPERIMENTAL. mark the component as deleted. after tag/snap and export the remote will be updated |
|
|
974
|
+
| `--remote` | `-r` | remove a component completely from a remote scope (Careful! this is a permanent change. prefer --soft and tag+export) |
|
|
975
|
+
| `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
|
|
976
|
+
| `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
|
|
977
|
+
| `--keep-files` | | keep component files (just untrack the component) |
|
|
950
978
|
| `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
|
|
951
979
|
| `--silent` | `-s` | skip confirmation |
|
|
952
980
|
|
|
@@ -955,28 +983,32 @@ Legacy support [file, ssh]. Harmony supports [file, http].
|
|
|
955
983
|
## rename
|
|
956
984
|
|
|
957
985
|
**Workspace only**: no
|
|
958
|
-
**Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the
|
|
959
|
-
the `<target-name>` should include the component-name only, without the scope-name.
|
|
960
|
-
to assign a default-scope to this component, please use "--scope" flag
|
|
986
|
+
**Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
|
|
961
987
|
|
|
962
|
-
`bit rename <
|
|
988
|
+
`bit rename <current-name> <new-name>`
|
|
963
989
|
|
|
964
|
-
| **Option**
|
|
965
|
-
|
|
|
966
|
-
| `--scope <
|
|
967
|
-
| `--path <
|
|
968
|
-
| `--refactor`
|
|
990
|
+
| **Option** | **Option alias** | **Description** |
|
|
991
|
+
| ------------------------ | :--------------: | ---------------------------------------------------------------------------------------- |
|
|
992
|
+
| `--scope <scope-name>` | `-s` | default scope for the newly created component |
|
|
993
|
+
| `--path <relative-path>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
|
|
994
|
+
| `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
|
|
969
995
|
|
|
970
996
|
---
|
|
971
997
|
|
|
972
|
-
##
|
|
998
|
+
## reset
|
|
973
999
|
|
|
974
1000
|
**Workspace only**: yes
|
|
975
|
-
**Description**:
|
|
976
|
-
|
|
977
|
-
alternatively, exporting to any one of the failed scopes, throws server-is-busy error with the export-id
|
|
1001
|
+
**Description**: revert tagged or snapped versions for component(s)
|
|
1002
|
+
https://bit.dev/docs/components/tags#undoing-a-tag
|
|
978
1003
|
|
|
979
|
-
`bit
|
|
1004
|
+
`bit reset [component-pattern]`
|
|
1005
|
+
|
|
1006
|
+
| **Option** | **Option alias** | **Description** |
|
|
1007
|
+
| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
|
|
1008
|
+
| `--all` | `-a` | revert tag/snap for all tagged/snapped components |
|
|
1009
|
+
| `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
|
|
1010
|
+
| `--soft` | | revert only soft-tags (components tagged with --soft flag) |
|
|
1011
|
+
| `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
|
|
980
1012
|
|
|
981
1013
|
---
|
|
982
1014
|
|
|
@@ -984,24 +1016,29 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
984
1016
|
|
|
985
1017
|
**Alias**: `c`
|
|
986
1018
|
**Workspace only**: yes
|
|
987
|
-
**Description**: run an
|
|
1019
|
+
**Description**: run an app (independent of bit's dev server)
|
|
988
1020
|
|
|
989
|
-
`bit run <app>`
|
|
1021
|
+
`bit run <app-name>`
|
|
990
1022
|
|
|
991
1023
|
| **Option** | **Option alias** | **Description** |
|
|
992
1024
|
| -------------- | :--------------: | -------------------------------------------------------------------------- |
|
|
993
1025
|
| `--dev` | `-d` | start the application in dev mode. |
|
|
994
1026
|
| `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
|
|
995
1027
|
| `--skip-watch` | | avoid running the watch process that compiles components in the background |
|
|
1028
|
+
| `--ssr` | | run app in server side rendering mode. |
|
|
996
1029
|
|
|
997
1030
|
---
|
|
998
1031
|
|
|
999
1032
|
## schema
|
|
1000
1033
|
|
|
1001
1034
|
**Workspace only**: yes
|
|
1002
|
-
**Description**: shows the API schema of a certain component.
|
|
1035
|
+
**Description**: shows the API schema of a certain component.
|
|
1036
|
+
you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
|
|
1037
|
+
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1038
|
+
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
1039
|
+
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
1003
1040
|
|
|
1004
|
-
`bit schema <
|
|
1041
|
+
`bit schema <pattern>`
|
|
1005
1042
|
|
|
1006
1043
|
| **Option** | **Option alias** | **Description** |
|
|
1007
1044
|
| ---------- | :--------------: | ---------------------------------------- |
|
|
@@ -1009,6 +1046,43 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
1009
1046
|
|
|
1010
1047
|
---
|
|
1011
1048
|
|
|
1049
|
+
## scope
|
|
1050
|
+
|
|
1051
|
+
**Workspace only**: yes
|
|
1052
|
+
**Description**: EXPERIMENTAL. manage the scope-name for components
|
|
1053
|
+
|
|
1054
|
+
`bit scope <sub-command>`
|
|
1055
|
+
|
|
1056
|
+
### scope set
|
|
1057
|
+
|
|
1058
|
+
**Usage**: `scope set <scope-name> [component-pattern]`
|
|
1059
|
+
|
|
1060
|
+
**Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope
|
|
1061
|
+
default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'
|
|
1062
|
+
|
|
1063
|
+
you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
|
|
1064
|
+
use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
1065
|
+
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
1066
|
+
use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
|
|
1067
|
+
|
|
1068
|
+
### scope rename
|
|
1069
|
+
|
|
1070
|
+
**Usage**: `scope rename <current-scope-name> <new-scope-name>`
|
|
1071
|
+
|
|
1072
|
+
**Description**: Renames the scope name for all components with the specified 'current scope name'
|
|
1073
|
+
|
|
1074
|
+
| **Option** | **Option alias** | **Description** |
|
|
1075
|
+
| ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
|
|
1076
|
+
| `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new scope name) |
|
|
1077
|
+
|
|
1078
|
+
### scope fork
|
|
1079
|
+
|
|
1080
|
+
**Usage**: `scope fork <original-scope> <new-scope>`
|
|
1081
|
+
|
|
1082
|
+
**Description**: fork all components of the original-scope and refactor the source-code to use the new package names
|
|
1083
|
+
|
|
1084
|
+
---
|
|
1085
|
+
|
|
1012
1086
|
## scope-config
|
|
1013
1087
|
|
|
1014
1088
|
**Workspace only**: yes
|
|
@@ -1045,16 +1119,16 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
1045
1119
|
## show
|
|
1046
1120
|
|
|
1047
1121
|
**Workspace only**: yes
|
|
1048
|
-
**Description**:
|
|
1122
|
+
**Description**: display the component's essential information
|
|
1049
1123
|
|
|
1050
|
-
`bit show <
|
|
1124
|
+
`bit show <component-name>`
|
|
1051
1125
|
|
|
1052
|
-
| **Option** | **Option alias** | **Description**
|
|
1053
|
-
| ----------- | :--------------: |
|
|
1054
|
-
| `--json` | `-j` | return the component data in json format
|
|
1055
|
-
| `--legacy` | `-l` | use the legacy bit show.
|
|
1056
|
-
| `--remote` | `-r` | show a remote component
|
|
1057
|
-
| `--compare` | `-c` | compare current file system component to latest tagged component [default=latest]. only works in legacy. |
|
|
1126
|
+
| **Option** | **Option alias** | **Description** |
|
|
1127
|
+
| ----------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
|
|
1128
|
+
| `--json` | `-j` | return the component data in a json format |
|
|
1129
|
+
| `--legacy` | `-l` | use the legacy bit show. |
|
|
1130
|
+
| `--remote` | `-r` | show a remote component |
|
|
1131
|
+
| `--compare` | `-c` | compare current file system component to the latest tagged component [default=latest]. only works in legacy. |
|
|
1058
1132
|
|
|
1059
1133
|
---
|
|
1060
1134
|
|
|
@@ -1062,18 +1136,18 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
1062
1136
|
|
|
1063
1137
|
**Alias**: `c`
|
|
1064
1138
|
**Workspace only**: yes
|
|
1065
|
-
**Description**:
|
|
1139
|
+
**Description**: run the ui/development server
|
|
1066
1140
|
|
|
1067
1141
|
`bit start [type] [pattern]`
|
|
1068
1142
|
|
|
1069
|
-
| **Option**
|
|
1070
|
-
|
|
|
1071
|
-
| `--dev`
|
|
1072
|
-
| `--port [number]`
|
|
1073
|
-
| `--rebuild`
|
|
1074
|
-
| `--verbose`
|
|
1075
|
-
| `--no-browser`
|
|
1076
|
-
| `--skip-compilation`
|
|
1143
|
+
| **Option** | **Option alias** | **Description** |
|
|
1144
|
+
| ---------------------- | :--------------: | --------------------------------------------------------- |
|
|
1145
|
+
| `--dev` | `-d` | start UI server in dev mode. |
|
|
1146
|
+
| `--port [port-number]` | `-p` | port of the UI server. |
|
|
1147
|
+
| `--rebuild` | `-r` | rebuild the UI |
|
|
1148
|
+
| `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
|
|
1149
|
+
| `--no-browser` | | do not automatically open browser when ready |
|
|
1150
|
+
| `--skip-compilation` | | skip the auto-compilation before starting the web-server |
|
|
1077
1151
|
|
|
1078
1152
|
---
|
|
1079
1153
|
|
|
@@ -1081,15 +1155,15 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
1081
1155
|
|
|
1082
1156
|
**Alias**: `s`
|
|
1083
1157
|
**Workspace only**: yes
|
|
1084
|
-
**Description**:
|
|
1085
|
-
https://bit.dev/docs/workspace/workspace-status
|
|
1158
|
+
**Description**: present the current status of components in the workspace, and notifies when issues are detected
|
|
1086
1159
|
|
|
1087
1160
|
`bit status`
|
|
1088
1161
|
|
|
1089
|
-
| **Option**
|
|
1090
|
-
|
|
|
1091
|
-
| `--json`
|
|
1092
|
-
| `--
|
|
1162
|
+
| **Option** | **Option alias** | **Description** |
|
|
1163
|
+
| ----------- | :--------------: | -------------------------------------- |
|
|
1164
|
+
| `--json` | `-j` | return a json version of the component |
|
|
1165
|
+
| `--verbose` | | show full snap hashes |
|
|
1166
|
+
| `--strict` | | in case issues found, exit with code 1 |
|
|
1093
1167
|
|
|
1094
1168
|
---
|
|
1095
1169
|
|
|
@@ -1097,35 +1171,36 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
|
|
|
1097
1171
|
|
|
1098
1172
|
**Alias**: `t`
|
|
1099
1173
|
**Workspace only**: yes
|
|
1100
|
-
**Description**:
|
|
1101
|
-
if no
|
|
1102
|
-
if
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
|
1109
|
-
|
|
|
1110
|
-
| `--
|
|
1111
|
-
| `--
|
|
1112
|
-
| `--
|
|
1113
|
-
| `--
|
|
1114
|
-
| `--patch` | `-p` |
|
|
1115
|
-
| `--minor` | |
|
|
1116
|
-
| `--major` | |
|
|
1117
|
-
| `--
|
|
1118
|
-
| `--
|
|
1119
|
-
| `--
|
|
1120
|
-
| `--skip-
|
|
1121
|
-
| `--
|
|
1122
|
-
| `--
|
|
1123
|
-
| `--
|
|
1124
|
-
| `--
|
|
1125
|
-
| `--
|
|
1126
|
-
| `--
|
|
1127
|
-
|
|
1128
|
-
|
|
1174
|
+
**Description**: create an immutable and exportable component snapshot, tagged with a release version.
|
|
1175
|
+
if no patterns are provided, it will tag all new and modified components.
|
|
1176
|
+
if patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
|
|
1177
|
+
|
|
1178
|
+
`bit tag [component-patterns...]`
|
|
1179
|
+
|
|
1180
|
+
| **Option** | **Option alias** | **Description** |
|
|
1181
|
+
| ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
1182
|
+
| `--message <message>` | `-m` | a log message describing latest changes |
|
|
1183
|
+
| `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
|
|
1184
|
+
| `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
1185
|
+
| `--ver <version>` | `-v` | tag with the given version |
|
|
1186
|
+
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
1187
|
+
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
1188
|
+
| `--patch` | `-p` | syntactic sugar for "--increment patch" |
|
|
1189
|
+
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
1190
|
+
| `--major` | | syntactic sugar for "--increment major" |
|
|
1191
|
+
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
1192
|
+
| `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
|
|
1193
|
+
| `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
|
|
1194
|
+
| `--skip-tests` | | skip running component tests during tag process |
|
|
1195
|
+
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
1196
|
+
| `--soft` | | do not persist. only keep note of the changes to be made |
|
|
1197
|
+
| `--persist` | | persist the changes generated by --soft tag |
|
|
1198
|
+
| `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
|
|
1199
|
+
| `--force-deploy` | | run the tag pipeline although the build failed |
|
|
1200
|
+
| `--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. |
|
|
1201
|
+
| `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
|
|
1202
|
+
|
|
1203
|
+
[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
|
|
1129
1204
|
to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
|
|
1130
1205
|
|`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
|
|
1131
1206
|
|`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|
|
|
@@ -1139,7 +1214,8 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
|
|
|
1139
1214
|
## templates
|
|
1140
1215
|
|
|
1141
1216
|
**Workspace only**: yes
|
|
1142
|
-
**Description**: list
|
|
1217
|
+
**Description**: list templates for "bit create" and "bit new"
|
|
1218
|
+
list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
|
|
1143
1219
|
|
|
1144
1220
|
`bit templates`
|
|
1145
1221
|
|
|
@@ -1153,19 +1229,19 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
|
|
|
1153
1229
|
|
|
1154
1230
|
**Alias**: `at`
|
|
1155
1231
|
**Workspace only**: yes
|
|
1156
|
-
**Description**: test
|
|
1232
|
+
**Description**: test components in the workspace
|
|
1157
1233
|
|
|
1158
|
-
`bit test [pattern]`
|
|
1234
|
+
`bit test [component-pattern]`
|
|
1159
1235
|
|
|
1160
|
-
| **Option**
|
|
1161
|
-
|
|
|
1162
|
-
| `--watch`
|
|
1163
|
-
| `--debug`
|
|
1164
|
-
| `--all`
|
|
1165
|
-
| `--junit <filepath>`
|
|
1166
|
-
| `--coverage`
|
|
1167
|
-
| `--env <id>`
|
|
1168
|
-
| `--scope <scope>`
|
|
1236
|
+
| **Option** | **Option alias** | **Description** |
|
|
1237
|
+
| ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
|
|
1238
|
+
| `--watch` | `-w` | start the tester in watch mode. |
|
|
1239
|
+
| `--debug` | `-d` | start the tester in debug mode. |
|
|
1240
|
+
| `--all` | `-a` | test all components, not only new and modified |
|
|
1241
|
+
| `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
|
|
1242
|
+
| `--coverage` | | show code coverage data |
|
|
1243
|
+
| `--env <id>` | `-e` | test only the given env |
|
|
1244
|
+
| `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
|
|
1169
1245
|
|
|
1170
1246
|
---
|
|
1171
1247
|
|
|
@@ -1198,23 +1274,6 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
|
|
|
1198
1274
|
|
|
1199
1275
|
---
|
|
1200
1276
|
|
|
1201
|
-
## untag
|
|
1202
|
-
|
|
1203
|
-
**Workspace only**: yes
|
|
1204
|
-
**Description**: revert version(s) tagged for component(s)
|
|
1205
|
-
https://bit.dev/docs/components/tags#undoing-a-tag
|
|
1206
|
-
you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
|
|
1207
|
-
|
|
1208
|
-
`bit untag [id] [version]`
|
|
1209
|
-
|
|
1210
|
-
| **Option** | **Option alias** | **Description** |
|
|
1211
|
-
| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
|
|
1212
|
-
| `--all` | `-a` | revert tag for all tagged components |
|
|
1213
|
-
| `--soft` | | harmony - revert only soft-tags (components tagged with --soft flag) |
|
|
1214
|
-
| `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
|
|
1215
|
-
|
|
1216
|
-
---
|
|
1217
|
-
|
|
1218
1277
|
## update
|
|
1219
1278
|
|
|
1220
1279
|
**Alias**: `up`
|
|
@@ -1232,22 +1291,22 @@ to ignore multiple issues, separate them by a comma and wrap with quotes. to ign
|
|
|
1232
1291
|
## use
|
|
1233
1292
|
|
|
1234
1293
|
**Workspace only**: yes
|
|
1235
|
-
**Description**: set
|
|
1294
|
+
**Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
|
|
1236
1295
|
|
|
1237
|
-
`bit use
|
|
1296
|
+
`bit use <component-id>`
|
|
1238
1297
|
|
|
1239
1298
|
---
|
|
1240
1299
|
|
|
1241
1300
|
## watch
|
|
1242
1301
|
|
|
1243
1302
|
**Workspace only**: yes
|
|
1244
|
-
**Description**:
|
|
1303
|
+
**Description**: automatically recompile modified components (on save)
|
|
1245
1304
|
|
|
1246
1305
|
`bit watch`
|
|
1247
1306
|
|
|
1248
1307
|
| **Option** | **Option alias** | **Description** |
|
|
1249
1308
|
| ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1250
|
-
| `--verbose` | `-v` |
|
|
1309
|
+
| `--verbose` | `-v` | show npm verbose output for inspection and print the stack trace |
|
|
1251
1310
|
| `--skip-pre-compilation` | | skip the compilation step before starting to watch |
|
|
1252
1311
|
| `--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 |
|
|
1253
1312
|
|