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