@teambit/harmony.content.cli-reference 2.0.30 → 2.0.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/cli-reference.docs.mdx +4 -3
  2. package/cli-reference.json +1486 -3205
  3. package/cli-reference.mdx +544 -1318
  4. package/dist/cli-reference.docs.mdx +4 -3
  5. package/dist/cli-reference.json +1486 -3205
  6. package/dist/cli-reference.mdx.js +1885 -6637
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/preview-1697836073970.js +7 -0
  9. package/package.json +3 -3
  10. package/dist/preview-1697628054879.js +0 -7
package/cli-reference.mdx CHANGED
@@ -1,47 +1,37 @@
1
- # CLI Reference
2
-
3
- Run the following to list all available Bit commands (alternatively, use the `-h` alias, instead of `--help`):
4
-
5
- ```sh
6
- bit --help
7
- ```
8
-
9
- Run the following to get help on a specific command:
10
-
11
- ```sh
12
- bit COMMAND --help
13
- ```
1
+ ---
2
+ id: cli-all
3
+ title: CLI Commands
4
+ ---
14
5
 
15
- Run the following to get help on a specific sub-command:
6
+ # CLI Reference
16
7
 
17
- ```sh
18
- bit COMMAND SUB_COMMAND --help
19
- ```
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.
20
9
 
21
10
  ## add
22
11
 
23
12
  **Alias**: `a`
24
- **Description**: Add any subset of files to be tracked as a component(s).
25
- Learn the recommended workflow for tracking directories as components, in the link below.
13
+ **Workspace only**: yes
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
16
+ https://bit.dev/reference/components/adding-components
26
17
 
27
18
  `bit add [path...]`
28
19
 
29
- | **Option** | **Option alias** | **Description** |
30
- | ------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
31
- | `--id <name>` | `-i` | manually set component id |
32
- | `--main <file>` | `-m` | define component entry point |
33
- | `--namespace <namespace>` | `-n` | organize component in a namespace |
34
- | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
35
- | `--scope <string>` | `-s` | sets the component's scope. if not entered, the default-scope from workspace.jsonc will be used |
36
- | `--env <string>` | `-e` | set the component's environment. (overrides the env from variants if exists) |
37
- | `--json` | `-j` | output as json format |
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) |
38
28
 
39
29
  ---
40
30
 
41
31
  ## app
42
32
 
43
- **Alias**: `apps`
44
- **Description**: Manages apps
33
+ **Workspace only**: yes
34
+ **Description**: manage applications
45
35
 
46
36
  `bit app <sub-command>`
47
37
 
@@ -49,44 +39,23 @@ Learn the recommended workflow for tracking directories as components, in the li
49
39
 
50
40
  **Usage**: `app list`
51
41
 
52
- **Description**: list all registered apps
42
+ **Description**: list all registered applications
53
43
 
54
44
  | **Option** | **Option alias** | **Description** |
55
45
  | ---------- | :--------------: | ---------------------------------------- |
56
46
  | `--json` | `-j` | return the component data in json format |
57
47
 
58
- ### app run
59
-
60
- **Usage**: `app run <app-name>`
61
-
62
- **Description**: locally run an app component (independent of bit's dev server)
63
-
64
- | **Arg** | **Description** |
65
- | ---------- | :--------------------------------------------------------------------------------------------------: |
66
- | `app-name` | the app's name is registered by the app (run 'bit app list' to list the names of the available apps) |
67
-
68
- | **Option** | **Option alias** | **Description** |
69
- | ---------------------- | :--------------: | -------------------------------------------------------------------------- |
70
- | `--dev` | `-d` | start the application in dev mode. |
71
- | `--port [port-number]` | `-p` | port to run the app on |
72
- | `--verbose` | `-v` | show verbose output for inspection and print stack trace |
73
- | `--skip-watch` | | avoid running the watch process that compiles components in the background |
74
- | `--ssr` | | run app in server side rendering mode. |
75
-
76
48
  ---
77
49
 
78
50
  ## artifacts
79
51
 
80
- **Description**: list and download component artifacts
52
+ **Workspace only**: yes
53
+ **Description**: EXPERIMENTAL. list and download components artifacts.
81
54
  artifacts are created on isolated capsules during tag or snap commands.
82
55
  example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
83
56
  and a package.tgz file generated by pkg aspect.
84
57
 
85
- `bit artifacts <component-pattern>`
86
-
87
- | **Arg** | **Description** |
88
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
89
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
58
+ `bit artifacts <pattern...>`
90
59
 
91
60
  | **Option** | **Option alias** | **Description** |
92
61
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
@@ -99,7 +68,8 @@ and a package.tgz file generated by pkg aspect.
99
68
 
100
69
  ## aspect
101
70
 
102
- **Description**: manage aspects
71
+ **Workspace only**: yes
72
+ **Description**: EXPERIMENTAL. manage aspects
103
73
 
104
74
  `bit aspect <sub-command>`
105
75
 
@@ -107,112 +77,98 @@ and a package.tgz file generated by pkg aspect.
107
77
 
108
78
  **Usage**: `aspect list [pattern]`
109
79
 
110
- **Description**: list all aspects configured on component(s)
111
-
112
- | **Arg** | **Description** |
113
- | --------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
114
- | `pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
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>`.
115
84
 
116
- | **Option** | **Option alias** | **Description** |
117
- | ---------- | :--------------: | -------------------------------------------------- |
118
- | `--debug` | `-d` | show the origins where the aspects were taken from |
85
+ | **Option** | **Option alias** | **Description** |
86
+ | ---------- | :--------------: | ------------------------------------------------- |
87
+ | `--debug` | `-d` | show the origins were the aspects were taken from |
119
88
 
120
89
  ### aspect get
121
90
 
122
- **Usage**: `aspect get <component-name>`
91
+ **Usage**: `aspect get <component-id>`
123
92
 
124
- **Description**: list the aspects set on a component, as well as their configs and data
93
+ **Description**: show aspects' data and configuration of the given component
125
94
 
126
- | **Arg** | **Description** |
127
- | ---------------- | :-----------------------------------------------------: |
128
- | `component-name` | the component name or component id to fetch aspects for |
129
-
130
- | **Option** | **Option alias** | **Description** |
131
- | ---------- | :--------------: | -------------------------------------------------- |
132
- | `--debug` | `-d` | show the origins where the aspects were taken from |
133
- | `--json` | `-j` | format as json |
95
+ | **Option** | **Option alias** | **Description** |
96
+ | ---------- | :--------------: | ------------------------------------------------- |
97
+ | `--debug` | `-d` | show the origins were the aspects were taken from |
98
+ | `--json` | `-j` | format as json |
134
99
 
135
100
  ### aspect set
136
101
 
137
102
  **Usage**: `aspect set <pattern> <aspect-id> [config]`
138
103
 
139
- **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
140
-
141
- | **Arg** | **Description** |
142
- | ----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
143
- | `pattern` | the components to extend. component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
144
- | `aspect-id` | the aspect's component id |
145
- | `config` | the aspect config. enter the config as a stringified JSON (e.g. '{"foo":"bar"}' ). when no config is provided, an aspect is set with an empty config ({}). |
146
-
147
- | **Option** | **Option alias** | **Description** |
148
- | ---------- | :--------------: | ---------------------------------------------------------------------------------------------- |
149
- | `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces overlapping existing configs) |
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>`.
150
110
 
151
111
  ### aspect unset
152
112
 
153
113
  **Usage**: `aspect unset <pattern> <aspect-id>`
154
114
 
155
- **Description**: unset an aspect from component(s).
156
-
157
- | **Arg** | **Description** |
158
- | ----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
159
- | `pattern` | the components to target. component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
160
- | `aspect-id` | the aspect's component id |
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>`.
161
119
 
162
120
  ### aspect update
163
121
 
164
122
  **Usage**: `aspect update <aspect-id> [pattern]`
165
123
 
166
- **Description**: update a version of an aspect for all or specified components
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>`.
167
129
 
168
- | **Arg** | **Description** |
169
- | ----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
170
- | `aspect-id` | the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote |
171
- | `pattern` | the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
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.
172
133
 
173
134
  ---
174
135
 
175
136
  ## build
176
137
 
177
- **Description**: run set of tasks for build.
178
- by default, only new and modified components are built
179
-
180
- `bit build [component-pattern]`
138
+ **Workspace only**: yes
139
+ **Description**: run set of tasks for build
181
140
 
182
- | **Arg** | **Description** |
183
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
184
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
141
+ `bit build [pattern]`
185
142
 
186
- | **Option** | **Option alias** | **Description** |
187
- | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
188
- | `--all` | `-a` | DEPRECATED. use --unmodified |
189
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are built) |
190
- | `--dev` | `-d` | run the pipeline in dev mode |
191
- | `--install` | | install core aspects in capsules |
192
- | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
193
- | `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
194
- | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
195
- | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
196
- | `--skip-tests` | | skip running component tests during build process |
197
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
143
+ | **Option** | **Option alias** | **Description** |
144
+ | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
145
+ | `--all` | `-a` | build all components, not only modified and new |
146
+ | `--dev` | `-d` | run the pipeline in dev mode |
147
+ | `--install` | | install core aspects in capsules |
148
+ | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
149
+ | `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. |
150
+ | specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
151
+ | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
152
+ | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
198
153
 
199
154
  ---
200
155
 
201
156
  ## capsule
202
157
 
203
- **Description**: manage capsules
204
- a capsule is a directory containing the component code, isolated from the workspace.
158
+ **Workspace only**: yes
159
+ **Description**: manage capsules.
160
+ a capsule is a directory contains the component code, isolated from the workspace.
205
161
  normally, capsules are created during the build process, the component files are copied and the packages are installed
206
162
  via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for
207
163
  other users after publishing/exporting them.
208
164
 
209
- `bit capsule`
165
+ `bit capsule <sub-command>`
210
166
 
211
167
  ### capsule list
212
168
 
213
169
  **Usage**: `capsule list`
214
170
 
215
- **Description**: list the capsules generated for this workspace
171
+ **Description**: list all capsules
216
172
 
217
173
  | **Option** | **Option alias** | **Description** |
218
174
  | ---------- | :--------------: | --------------- |
@@ -220,9 +176,9 @@ other users after publishing/exporting them.
220
176
 
221
177
  ### capsule create
222
178
 
223
- **Usage**: `capsule create [component-id...]`
179
+ **Usage**: `capsule create [componentIds...]`
224
180
 
225
- **Description**: create capsules for components
181
+ **Description**: create capsules
226
182
 
227
183
  | **Option** | **Option alias** | **Description** |
228
184
  | -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
@@ -231,7 +187,6 @@ other users after publishing/exporting them.
231
187
  | `--always-new` | `-a` | create new environment for capsule |
232
188
  | `--seeders-only` | `-s` | create capsules for the seeders only (not for the entire graph) |
233
189
  | `--id <name>` | `-i` | reuse capsule of certain name |
234
- | `--use-hash` | | whether to use hash function (of base dir) as capsules root dir name |
235
190
  | `--json` | `-j` | json format |
236
191
  | `--install-packages` | `-d` | install packages by the package-manager |
237
192
  | `--package-manager <name>` | `-p` | npm, yarn or pnpm, default to npm |
@@ -240,29 +195,21 @@ other users after publishing/exporting them.
240
195
 
241
196
  **Usage**: `capsule delete`
242
197
 
243
- **Description**: delete capsules
244
- with no args, only workspace's capsules are deleted
198
+ **Description**: delete capsules. with no args, only workspace's capsules are deleted
245
199
 
246
200
  | **Option** | **Option alias** | **Description** |
247
201
  | ----------------- | :--------------: | ------------------------------------------------- |
248
202
  | `--scope-aspects` | | delete scope-aspects capsules |
249
203
  | `--all` | `-a` | delete all capsules for all workspaces and scopes |
250
204
 
251
- | **Option** | **Option alias** | **Description** |
252
- | ---------- | :--------------: | --------------- |
253
- | `--json` | `-j` | json format |
254
-
255
205
  ---
256
206
 
257
207
  ## check-types
258
208
 
209
+ **Workspace only**: yes
259
210
  **Description**: check typescript types
260
211
 
261
- `bit check-types [component-pattern]`
262
-
263
- | **Arg** | **Description** |
264
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
265
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
212
+ `bit check-types [pattern]`
266
213
 
267
214
  | **Option** | **Option alias** | **Description** |
268
215
  | ---------- | :--------------: | --------------------------------------------------------- |
@@ -274,44 +221,43 @@ with no args, only workspace's capsules are deleted
274
221
  ## checkout
275
222
 
276
223
  **Alias**: `U`
277
- **Description**: switch between component versions or remove local changes
278
-
279
- `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
280
- `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
281
- `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
282
- `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
283
-
284
- `bit checkout <to> [component-pattern]`
285
-
286
- | **Arg** | **Description** |
287
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
288
- | `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
289
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
290
-
291
- | **Option** | **Option alias** | **Description** |
292
- | --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
293
- | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
294
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will leave the current code intact |
295
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. In the future, this flag will override the current code with the incoming code |
296
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
297
- | `--auto-merge-resolve <merge-strategy>` | | in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
298
- | `--reset` | `-r` | revert changes that were not snapped/tagged |
299
- | `--all` | `-a` | all components |
300
- | `--workspace-only` | `-e` | only relevant for 'bit checkout head' when on a lane. don't import components from the remote lane that are not already in the workspace |
301
- | `--verbose` | `-v` | showing verbose output for inspection |
302
- | `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
224
+ **Workspace only**: yes
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
228
+ `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)
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)
230
+
231
+ `bit checkout [values...]`
232
+
233
+ | **Option** | **Option alias** | **Description** |
234
+ | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
235
+ | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
236
+ | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
237
+ | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
238
+ | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
239
+ | `--reset` | `-r` | remove local changes |
240
+ | `--all` | `-a` | all components |
241
+ | `--verbose` | `-v` | showing verbose output for inspection |
242
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
243
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
244
+ | `--ignore-package-json` | | do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags) |
245
+ | `--conf [path]` | | write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir) |
246
+ | `--ignore-dist` | | do not write dist files (when exist) |
303
247
 
304
248
  ---
305
249
 
306
250
  ## clear-cache
307
251
 
308
252
  **Alias**: `cc`
253
+ **Workspace only**: no
309
254
  **Description**: clears Bit's cache from current working machine
310
255
  The following gets removed by this command:
311
256
 
312
257
  1. V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)
313
- 2. components cache on the filesystem (mainly the dependencies graph and docs)
314
- 3. scope's index file, which maps the component-id:object-hash
258
+ 2. components cache on the filesystem (mainly the dependencies graph and reference)
259
+ 3. scope's index file, which maps the component-id:object-hash
260
+ https://bit.dev/reference/workspace/clearing-cache
315
261
 
316
262
  `bit clear-cache`
317
263
 
@@ -323,6 +269,7 @@ The following gets removed by this command:
323
269
 
324
270
  ## cli
325
271
 
272
+ **Workspace only**: yes
326
273
  **Description**: EXPERIMENTAL. enters bit cli program and generates commands list
327
274
 
328
275
  `bit cli`
@@ -331,25 +278,20 @@ The following gets removed by this command:
331
278
 
332
279
  **Usage**: `cli generate`
333
280
 
334
- **Description**: generate an .md file with all commands details
281
+ **Description**: EXPERIMENTAL. generate an .md file with all commands details
335
282
 
336
283
  | **Option** | **Option alias** | **Description** |
337
284
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
338
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 |
339
- | `--docs` | | generate the cli-reference.docs.mdx file |
340
- | `--json` | `-j` | output the commands info as JSON |
341
286
 
342
287
  ---
343
288
 
344
289
  ## compile
345
290
 
346
- **Description**: compile components in the workspace
347
-
348
- `bit compile [component-names...]`
291
+ **Workspace only**: yes
292
+ **Description**: compile components in the development workspace
349
293
 
350
- | **Arg** | **Description** |
351
- | -------------------- | :---------------------------------------------------------------------: |
352
- | `component-names...` | a list of component names or component IDs (defaults to all components) |
294
+ `bit compile [component...]`
353
295
 
354
296
  | **Option** | **Option alias** | **Description** |
355
297
  | ------------------- | :--------------: | ------------------------------------------------------------- |
@@ -362,16 +304,31 @@ The following gets removed by this command:
362
304
 
363
305
  ## completion
364
306
 
307
+ **Workspace only**: yes
365
308
  **Description**: enable bash/zsh-completion shortcuts for commands and options
366
309
 
367
310
  `bit completion`
368
311
 
369
312
  ---
370
313
 
314
+ ## component-issues
315
+
316
+ **Workspace only**: yes
317
+ **Description**: list available component-issues
318
+
319
+ `bit component-issues`
320
+
321
+ | **Option** | **Option alias** | **Description** |
322
+ | ---------- | :--------------: | --------------- |
323
+ | `--json` | `-j` | json format |
324
+
325
+ ---
326
+
371
327
  ## config
372
328
 
373
- **Description**: global config management
374
- https://https://bit.dev//reference/config/bit-config
329
+ **Workspace only**: yes
330
+ **Description**: global config management.
331
+ https://bit.dev/reference/config/bit-config
375
332
 
376
333
  `bit config`
377
334
 
@@ -379,9 +336,7 @@ https://https://bit.dev//reference/config/bit-config
379
336
 
380
337
  **Usage**: `config set <key> <val>`
381
338
 
382
- **Description**: set a global configuration
383
- to set temporary configuration by env variable, prefix with "BIT*CONFIG", replace "." with "*" and change to upper case.
384
- for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
339
+ **Description**: set a global configuration
385
340
 
386
341
  ### config del
387
342
 
@@ -393,7 +348,7 @@ for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
393
348
 
394
349
  **Usage**: `config get <key>`
395
350
 
396
- **Description**: get a value from global configuration
351
+ **Description**: get a global configuration
397
352
 
398
353
  ### config list
399
354
 
@@ -405,269 +360,132 @@ for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"
405
360
 
406
361
  ## create
407
362
 
408
- **Description**: create a new component (source files and config) using a template.
409
-
410
- `bit create <template-name> <component-names...>`
363
+ **Workspace only**: yes
364
+ **Description**: create a new component from a template
411
365
 
412
- | **Arg** | **Description** |
413
- | -------------------- | :-----------------------------------------------------------------------------------------------: |
414
- | `template-name` | the template for generating the component (run 'bit templates' for a list of available templates) |
415
- | `component-names...` | a list of component names to generate |
366
+ `bit create <templateName> <componentNames...>`
416
367
 
417
368
  | **Option** | **Option alias** | **Description** |
418
369
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
419
370
  | `--namespace <string>` | `-n` | sets the component's namespace and nested dirs inside the scope |
420
371
  | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
421
372
  | `--aspect <string>` | `-a` | aspect-id of the template. helpful when multiple aspects use the same template name |
422
- | `--template <string>` | `-t` | env-id of the template. alias for --aspect. |
423
373
  | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
424
374
  | `--env <string>` | `-e` | set the component's environment. (overrides the env from variants and the template) |
425
375
 
426
376
  ---
427
377
 
428
- ## delete
378
+ ## dependencies
429
379
 
430
- **Description**: mark components as deleted on the remote
431
- to remove components from your local workspace only, use "bit remove" command.
432
- this command marks the components as deleted, and after snap/tag and export they will be marked as deleted from the remote scope as well.
380
+ **Workspace only**: yes
381
+ **Description**: EXPERIMENTAL. show dependencies (direct and indirect) of the given component
433
382
 
434
- `bit delete <component-pattern>`
383
+ `bit dependencies <id>`
435
384
 
436
- | **Arg** | **Description** |
437
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
438
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
439
-
440
- | **Option** | **Option alias** | **Description** |
441
- | --------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
442
- | `--lane` | | when on a lane, delete the component from this lane only. avoid merging it to main or other lanes |
443
- | `--update-main` | | EXPERIMENTAL. delete component/s on the main lane after merging this lane into main |
444
- | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
445
- | `--silent` | `-s` | skip confirmation |
446
- | `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. |
385
+ | **Option** | **Option alias** | **Description** |
386
+ | ---------- | :--------------: | -------------------------------------------------------------------- |
387
+ | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
447
388
 
448
389
  ---
449
390
 
450
391
  ## dependents
451
392
 
452
- **Description**: show dependents of the given component
393
+ **Workspace only**: yes
394
+ **Description**: EXPERIMENTAL. show dependents of the given component
453
395
 
454
- `bit dependents <component-name>`
396
+ `bit dependents <id>`
455
397
 
456
398
  ---
457
399
 
458
400
  ## deprecate
459
401
 
460
402
  **Alias**: `d`
403
+ **Workspace only**: no
461
404
  **Description**: deprecate a component
462
405
 
463
- `bit deprecate <component-name>`
464
-
465
- | **Arg** | **Description** |
466
- | ---------------- | :----------------------------: |
467
- | `component-name` | component name or component id |
406
+ `bit deprecate <id>`
468
407
 
469
- | **Option** | **Option alias** | **Description** |
470
- | ------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------- |
471
- | `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename" to do this automatically |
472
-
473
- ---
474
-
475
- ## deps
476
-
477
- **Alias**: `dependencies`
478
- **Description**: manage dependencies
479
-
480
- `bit deps <sub-command>`
481
-
482
- ### deps get
483
-
484
- **Usage**: `deps get <component-name>`
485
-
486
- **Description**: show direct and indirect dependencies of the given component
487
-
488
- | **Arg** | **Description** |
489
- | ---------------- | :----------------------------: |
490
- | `component-name` | component name or component id |
491
-
492
- | **Option** | **Option alias** | **Description** |
493
- | ---------- | :--------------: | ---------------------------------------------------------------- |
494
- | `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
495
-
496
- ### deps remove
497
-
498
- **Usage**: `deps remove <component-pattern> <package...>`
499
-
500
- **Description**: remove a dependency to component(s)
501
-
502
- | **Arg** | **Description** |
503
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
504
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
505
- | `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will remove all lodash instances of any version |
506
-
507
- | **Option** | **Option alias** | **Description** |
508
- | ---------- | :--------------: | ---------------------------- |
509
- | `--dev` | `-d` | remove from devDependencies |
510
- | `--peer` | `-p` | remove from peerDependencies |
511
-
512
- ### deps unset
513
-
514
- **Usage**: `deps unset <component-pattern> <package...>`
515
-
516
- **Description**: unset a dependency to component(s) that was previously set by "bit deps set"
517
-
518
- | **Arg** | **Description** |
519
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
520
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
521
- | `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will remove all lodash instances of any version |
522
-
523
- | **Option** | **Option alias** | **Description** |
524
- | ---------- | :--------------: | --------------------------- |
525
- | `--dev` | `-d` | unset from devDependencies |
526
- | `--peer` | `-p` | unset from peerDependencies |
527
-
528
- ### deps debug
529
-
530
- **Usage**: `deps debug <component-name>`
531
-
532
- **Description**: show the immediate dependencies and how their versions were determined
533
-
534
- | **Arg** | **Description** |
535
- | ---------------- | :----------------------------: |
536
- | `component-name` | component name or component id |
537
-
538
- ### deps set
539
-
540
- **Usage**: `deps set <component-pattern> <package...>`
541
-
542
- **Description**: set a dependency to component(s)
543
-
544
- | **Arg** | **Description** |
545
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
546
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
547
- | `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
548
-
549
- | **Option** | **Option alias** | **Description** |
550
- | ---------- | :--------------: | --------------------------- |
551
- | `--dev` | `-d` | add to the devDependencies |
552
- | `--peer` | `-p` | add to the peerDependencies |
553
-
554
- ### deps reset
555
-
556
- **Usage**: `deps reset <component-pattern>`
557
-
558
- **Description**: reset dependencies to the default values (revert any previously "bit deps set")
559
-
560
- | **Arg** | **Description** |
561
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
562
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
563
-
564
- ### deps eject
565
-
566
- **Usage**: `deps eject <component-pattern>`
567
-
568
- **Description**: write dependencies that were previously set via "bit deps set" into .bitmap
569
-
570
- | **Arg** | **Description** |
571
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
572
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
573
-
574
- ### deps blame
575
-
576
- **Usage**: `deps blame <component-name> <dependency-name>`
577
-
578
- **Description**: EXPERIMENTAL. find out which snap/tag changed a dependency version
579
-
580
- | **Arg** | **Description** |
581
- | ----------------- | :---------------------------------------------------------------------------: |
582
- | `dependency-name` | package-name. for components, you can use either component-id or package-name |
583
-
584
- ### deps usage
585
-
586
- **Usage**: `deps usage <dependency-name>`
587
-
588
- **Description**: EXPERIMENTAL. find components that use the specified dependency
589
-
590
- | **Arg** | **Description** |
591
- | ----------------- | :------------------------------------------------------------------------------------------------------------------------------------------: |
592
- | `dependency-name` | package-name. for components, you can use either component-id or package-name. if version is specified, it will search for the exact version |
408
+ | **Option** | **Option alias** | **Description** |
409
+ | ------------------- | :--------------: | ------------------------------------------------------------ |
410
+ | `--new-id <string>` | | if replaced by another component, enter the new component id |
593
411
 
594
412
  ---
595
413
 
596
414
  ## diff
597
415
 
598
- **Description**: show the diff between the components' current source files and config, and their latest snapshot or tag
599
- bit diff => compare all modified components to their model version
600
- bit diff [ids...] => compare the specified components against their modified states
601
- bit diff [id] [version] => compare component's current files and configs to the specified version of the component
602
- bit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided
603
- you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
416
+ **Workspace only**: yes
417
+ **Description**: show diff between components files
418
+ bit diff => compare all modified components to their model version
419
+ bit diff [ids...] => compare the specified components against their modified states
420
+ bit diff [id] [version] => compare the specified version to used or modified files
421
+ bit diff [id] [version] [to_version] => compare the specified version files to to_version files
422
+ you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
604
423
 
605
424
  `bit diff [values...]`
606
425
 
607
426
  | **Option** | **Option alias** | **Description** |
608
427
  | ----------- | :--------------: | ------------------------------------------------------- |
609
- | `--verbose` | `-v` | show a more verbose output where possible |
428
+ | `--verbose` | `-v` | show a more verbose output when possible |
610
429
  | `--table` | `-t` | show tables instead of plain text for dependencies diff |
611
430
 
612
431
  ---
613
432
 
614
433
  ## doctor
615
434
 
435
+ **Workspace only**: yes
616
436
  **Description**: diagnose a bit workspace
617
437
 
618
438
  `bit doctor [diagnosis-name]`
619
439
 
620
- | **Option** | **Option alias** | **Description** |
621
- | ---------------------- | :--------------: | ---------------------------------------------- |
622
- | `--json` | `-j` | return diagnoses in json format |
623
- | `--list` | | list all available diagnoses |
624
- | `--save [filePath]` | `-s` | save diagnoses to a file |
625
- | `--archive [filePath]` | `-a` | archive the workspace including diagnosis info |
440
+ | **Option** | **Option alias** | **Description** |
441
+ | ------------------- | :--------------: | ------------------------------- |
442
+ | `--json` | `-j` | return diagnoses in json format |
443
+ | `--list` | | list all available diagnoses |
444
+ | `--save [filePath]` | `-s` | save diagnoses to a file |
626
445
 
627
446
  ---
628
447
 
629
448
  ## eject
630
449
 
631
450
  **Alias**: `E`
632
- **Description**: remove component from the workspace and install it instead as a regular npm package.
633
- By default the component files will be removed from the workspace
451
+ **Workspace only**: yes
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>`.
634
456
 
635
- `bit eject <component-pattern>`
457
+ `bit eject <pattern>`
636
458
 
637
- | **Arg** | **Description** |
638
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
639
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
640
-
641
- | **Option** | **Option alias** | **Description** |
642
- | -------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------- |
643
- | `--force` | `-f` | ignore local changes/versions. eject component/s even when they are staged or modified. Note: unexported tags/snaps will be lost |
644
- | `--json` | `-j` | print the results in JSON format |
645
- | `--keep-files` | | keep the component files in the workspace intact |
459
+ | **Option** | **Option alias** | **Description** |
460
+ | -------------- | :--------------: | --------------------------------------------------------------------------------- |
461
+ | `--force` | `-f` | ignore local version. remove the components even when they are staged or modified |
462
+ | `--json` | `-j` | print the results in JSON format |
463
+ | `--keep-files` | | keep the component files in the workspace intact |
646
464
 
647
465
  ---
648
466
 
649
467
  ## eject-conf
650
468
 
469
+ **Workspace only**: yes
651
470
  **Description**: eject components configuration (create a `component.json` file)
652
- note this can be reversed at any time by snapping/tagging changes and deleting the component.json file
653
- you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
654
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
655
- always wrap the pattern with single quotes to avoid collision with shell commands.
656
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
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"
472
+ always wrap the pattern with quotes to avoid collision with shell commands.
473
+ to validate the pattern before running this command, run `bit pattern <pattern>`.
657
474
 
658
475
  `bit eject-conf <pattern>`
659
476
 
660
- | **Option** | **Option alias** | **Description** |
661
- | ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------- |
662
- | `--propagate` | `-p` | mark propagate true in the config file, so that component.json configs will be merge with workspace configs |
663
- | `--override` | `-o` | override file if exist |
477
+ | **Option** | **Option alias** | **Description** |
478
+ | ------------- | :--------------: | -------------------------------------- |
479
+ | `--propagate` | `-p` | mark propagate true in the config file |
480
+ | `--override` | `-o` | override file if exist |
664
481
 
665
482
  ---
666
483
 
667
484
  ## envs
668
485
 
669
486
  **Alias**: `env`
670
- **Description**: list all components maintained by the workspace and their corresponding envs
487
+ **Workspace only**: yes
488
+ **Description**: list all components envs
671
489
 
672
490
  `bit envs`
673
491
 
@@ -675,131 +493,88 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
675
493
 
676
494
  **Usage**: `envs list`
677
495
 
678
- **Description**: list all envs currently used in the workspace
496
+ **Description**: list all envs available in the workspace
679
497
 
680
498
  ### envs get
681
499
 
682
- **Usage**: `envs get <component-name>`
683
-
684
- **Description**: show config information from a component's env
685
-
686
- | **Arg** | **Description** |
687
- | ---------------- | :-------------------------------------------------------------------------------------: |
688
- | `component-name` | the 'component name' or 'component id' of the component whose env you'd like to inspect |
500
+ **Usage**: `envs get <name>`
689
501
 
690
- | **Option** | **Option alias** | **Description** |
691
- | --------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------ |
692
- | `--services <string>` | | show information about the specific services only. for multiple services, separate by a comma and wrap with quotes |
502
+ **Description**: show component's env details
693
503
 
694
504
  ### envs set
695
505
 
696
- **Usage**: `envs set <component-pattern> <env>`
506
+ **Usage**: `envs set <pattern> <env>`
697
507
 
698
- **Description**: Assigns one or more components a development environment (env)
699
-
700
- | **Arg** | **Description** |
701
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
702
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
703
- | `env` | the env's component id (include version if not latest, e.g `teambit.community/envs/community-react@1.95.13`) |
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>`.
704
512
 
705
513
  ### envs unset
706
514
 
707
- **Usage**: `envs unset <component-pattern>`
708
-
709
- **Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
710
- keep in mind that this doesn't remove envs that are set via variants.
711
- in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
712
- the purpose of this command is to reset previously assigned envs to either allow variants configure the env or use the base node env.
713
- you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
714
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
715
- always wrap the pattern with single quotes to avoid collision with shell commands.
716
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
515
+ **Usage**: `envs unset <component>`
717
516
 
718
- | **Arg** | **Description** |
719
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
720
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
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"
519
+ always wrap the pattern with quotes to avoid collision with shell commands.
520
+ to validate the pattern before running this command, run `bit pattern <pattern>`.
721
521
 
722
522
  ### envs replace
723
523
 
724
- **Usage**: `envs replace <current-env> <new-env>`
524
+ **Usage**: `envs replace <old-env> <new-env>`
725
525
 
726
526
  **Description**: replace an existing env with another env for all components using the old env
727
527
 
728
- | **Arg** | **Description** |
729
- | ------------- | :----------------------------------------: |
730
- | `current-env` | the component id of the env to be replaced |
731
- | `new-env` | the component id of the new env |
732
-
733
- ### envs update
734
-
735
- **Usage**: `envs update [env-id] [pattern]`
736
-
737
- **Description**: update a version of an env for all components using that env
738
-
739
- | **Arg** | **Description** |
740
- | --------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
741
- | `env-id` | the environment id (defaults to all envs). optionally, add a version (id@version), if no version is supplied will use the latest version on the remote. |
742
- | `pattern` | the components to update (defaults to all components). component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
743
-
744
528
  ---
745
529
 
746
530
  ## export
747
531
 
748
532
  **Alias**: `e`
749
- **Description**: export components from the workspace to remote scopes
750
- bit export => export all staged snaps/tags of components to their remote scope. if checked out to a lane, export the lane as well
751
- `bit export [pattern...]` => export components included by the pattern to their remote scope (we recommend not using a pattern in
752
- most scenarios so that all changes are exported simultaneously)
753
- you can use a pattern for multiple ids, such as bit export "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
533
+ **Workspace only**: yes
534
+ **Description**: export components to a remote scope.
535
+ 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
754
537
 
755
- `bit export [component-patterns...]`
538
+ https://bit.dev/reference/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)
756
540
 
757
- | **Arg** | **Description** |
758
- | ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
759
- | `component-patterns...` | (not recommended) component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
541
+ `bit export [remote] [id...]`
760
542
 
761
543
  | **Option** | **Option alias** | **Description** |
762
544
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
763
- | `--eject` | `-e` | remove component from the workspace and install it instead as a regular npm package |
764
- | `--all` | `-a` | export all components, including non-staged (useful when components in the remote scope are corrupted or missing) |
765
- | `--all-versions` | | export not only staged versions but all of them (useful when versions in the remote scope are corrupted or missing) |
766
- | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
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! |
767
553
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
768
- | `--head-only` | | EXPERIMENTAL. in case previous export failed and locally it shows exported and only one snap/tag was created, try using this flag |
769
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 |
770
- | `--fork-lane-new-scope` | | allow exporting a forked lane into a different scope than the original scope |
771
- | `--open-browser` | | open a browser once the export is completed in the cloud job url |
772
- | `--json` | `-j` | show output in json format |
773
555
 
774
556
  ---
775
557
 
776
558
  ## fork
777
559
 
778
- **Description**: create a new component forked from an existing one (copies source files and configs)
560
+ **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
779
564
 
780
- `bit fork <source-component-id> [target-component-name]`
565
+ `bit fork <source-id> [target-name]`
781
566
 
782
- | **Arg** | **Description** |
783
- | ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------: |
784
- | `source-component-id` | the component id of the source component |
785
- | `target-component-name` | the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag |
786
-
787
- | **Option** | **Option alias** | **Description** |
788
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
789
- | `--scope <string>` | `-s` | default scope for the new component |
790
- | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
791
- | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
792
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
793
- | `--env <string>` | `-e` | set the environment for the new component |
794
- | `--skip-config` | | do not copy the config (aspects-config, env, etc) to the new component. helpful when it fails during aspect loading |
795
- | `--preserve` | | avoid refactoring file and variable/class names according to the new component name |
796
- | `--no-link` | | avoid saving a reference to the original component |
797
- | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
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 |
798
572
 
799
573
  ---
800
574
 
801
575
  ## format
802
576
 
577
+ **Workspace only**: yes
803
578
  **Description**: format components in the development workspace
804
579
 
805
580
  `bit format [component...]`
@@ -812,32 +587,9 @@ bit export => export all staged snaps/tags of components to their remote scope.
812
587
 
813
588
  ---
814
589
 
815
- ## git
816
-
817
- **Description**: perform git operations
818
-
819
- `bit git <sub-command>`
820
-
821
- ### git set-merge-driver
822
-
823
- **Usage**: `git set-merge-driver`
824
-
825
- **Description**: setup bit's git merge driver for bitmap files
826
-
827
- | **Option** | **Option alias** | **Description** |
828
- | ---------- | :--------------: | --------------------------------- |
829
- | `--global` | `-g` | set the git merge driver globally |
830
-
831
- ### git merge-bitmaps
832
-
833
- **Usage**: `git merge-bitmaps <ancestor> <current> <other>`
834
-
835
- **Description**: a special command to merge conflicting bitmap files during git merge
836
-
837
- ---
838
-
839
590
  ## globals
840
591
 
592
+ **Workspace only**: yes
841
593
  **Description**: list all globals
842
594
 
843
595
  `bit globals`
@@ -850,393 +602,123 @@ bit export => export all staged snaps/tags of components to their remote scope.
850
602
 
851
603
  ## graph
852
604
 
853
- **Description**: generate an image file with the workspace components' dependencies graph
605
+ **Workspace only**: yes
606
+ **Description**: EXPERIMENTAL. generate an image file with the dependencies graph
854
607
 
855
608
  `bit graph [id]`
856
609
 
857
610
  | **Option** | **Option alias** | **Description** |
858
611
  | ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
859
- | `--image <image>` | `-i` | image path and format. use one of the following extensions: [gif, png, svg, pdf] |
612
+ | `--image <image>` | `-i` | image path. use one of the following extensions: [gif, png, svg, pdf] |
860
613
  | `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
861
614
  | `--all-versions` | | enter all components versions into the graph, not only latest |
862
615
  | `--layout <name>` | | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
863
- | `--json` | `-j` | json format |
864
616
 
865
617
  ---
866
618
 
867
619
  ## help
868
620
 
869
621
  **Alias**: `$0`
622
+ **Workspace only**: yes
870
623
  **Description**: shows help
871
624
 
872
625
  `bit help`
873
626
 
874
- | **Option** | **Option alias** | **Description** |
875
- | ------------ | :--------------: | ---------------------- |
876
- | `--internal` | | show internal commands |
877
-
878
627
  ---
879
628
 
880
629
  ## import
881
630
 
882
- **Description**: import components from their remote scopes to the local workspace
883
-
884
- `bit import [component-patterns...]`
631
+ **Workspace only**: yes
632
+ **Description**: import components into your current workspace.
633
+ https://bit.dev/reference/components/importing-components
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)
885
635
 
886
- | **Arg** | **Description** |
887
- | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
888
- | `component-patterns...` | component IDs or component patterns (separated by space). Use patterns to import groups of components using a common scope or namespace. E.g., "utils/\*" (wrap with double quotes) |
636
+ `bit import [ids...]`
889
637
 
890
- | **Option** | **Option alias** | **Description** |
891
- | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
892
- | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
893
- | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is the default behavior for import with no id argument |
894
- | `--override` | `-O` | override local changes |
895
- | `--verbose` | `-v` | show verbose output for inspection |
896
- | `--json` | `-j` | return the output as JSON |
897
- | `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
898
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
899
- | `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
900
- | `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
901
- | `--save-in-lane` | | when checked out to a lane and the component is not on the remote-lane, save it in the lane (defaults to save on main) |
902
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
903
- | `--fetch-deps` | | fetch dependencies (bit components) objects to the local scope, but dont add to the workspace. Useful to resolve errors about missing dependency data |
904
- | `--track-only` | | do not write any component files, just create .bitmap entries of the imported components. Useful when the files already exist and just want to re-add the component to the bitmap |
905
- | `--include-deprecated` | | when importing with patterns, include deprecated components (default to exclude them) |
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 |
906
654
 
907
655
  ---
908
656
 
909
657
  ## init
910
658
 
911
- **Description**: create or reinitialize an empty workspace
912
- https://https://bit.dev//workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
659
+ **Workspace only**: no
660
+ **Description**: initialize an empty bit scope
661
+ https://bit.dev/reference/workspace/creating-workspaces#initialize-a-workspace-on-an-existing-project
913
662
 
914
663
  `bit init [path]`
915
664
 
916
- | **Option** | **Option alias** | **Description** |
917
- | ----------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
918
- | `--bare [name]` | `-b` | initialize an empty bit bare scope |
919
- | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
920
- | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
921
- | `--reset` | `-r` | write missing or damaged Bit files |
922
- | `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
923
- | `--reset-lane-new` | | same as reset-new, but it only resets components belong to lanes. main components are left intact |
924
- | `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch |
925
- | `--reset-scope` | | removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact |
926
- | `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
927
- | `--default-scope <default-scope>` | | set the default scope for components in the workspace |
928
- | `--package-manager <package-manager>` | `-p` | set the package manager (npm or yarn) to be used in the workspace |
929
- | `--force` | `-f` | force workspace initialization without clearing local objects |
930
- | `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
931
- | `--interactive` | `-I` | EXPERIMENTAL. start an interactive process |
665
+ | **Option** | **Option alias** | **Description** |
666
+ | ----------------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
667
+ | `--bare [name]` | `-b` | initialize an empty bit bare scope |
668
+ | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
669
+ | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
670
+ | `--reset` | `-r` | write missing or damaged Bit files |
671
+ | `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
672
+ | `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-start using Bit from scratch |
673
+ | `--default-directory <default-directory>` | `-d` | set up default directory to import components into |
674
+ | `--package-manager <package-manager>` | `-p` | set up package manager (npm or yarn) |
675
+ | `--force` | `-f` | force workspace initialization without clearing local objects |
676
+ | `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
677
+ | `--interactive` | `-I` | EXPERIMENTAL. start an interactive process |
932
678
 
933
679
  ---
934
680
 
935
681
  ## install
936
682
 
937
683
  **Alias**: `in`
938
- **Description**: installs workspace dependencies
939
- when no package is specified, all workspace dependencies are installed and all workspace components are imported.
684
+ **Workspace only**: yes
685
+ **Description**: install development workspace dependencies
940
686
 
941
687
  `bit install [packages...]`
942
688
 
943
- | **Arg** | **Description** |
944
- | ------------- | :-------------------------------------------------: |
945
- | `packages...` | a list of packages to install (separated by spaces) |
946
-
947
- | **Option** | **Option alias** | **Description** |
948
- | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
949
- | `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
950
- | `--update` | `-u` | update all dependencies to latest version according to their semver range |
951
- | `--update-existing` | | DEPRECATED (not needed anymore, it is the default now). update existing dependencies version and types |
952
- | `--save-prefix [savePrefix]` | | set the prefix to use when adding dependency to workspace.jsonc |
953
- | `--skip-dedupe` | | do not dedupe dependencies on installation |
954
- | `--skip-import` | | do not import bit objects post installation |
955
- | `--skip-compile` | | do not compile components |
956
- | `--add-missing-deps` | | install all missing dependencies |
957
- | `--add-missing-peers` | | install all missing peer dependencies |
958
- | `--recurring-install` | | automatically run install again if there are non loaded old envs in your workspace |
959
- | `--no-optional [noOptional]` | | do not install optional dependencies (works with pnpm only) |
960
- | `--lockfile-only` | | dependencies are not written to node_modules. Only the lockfile is updated |
961
-
962
- ---
963
-
964
- ## lane
965
-
966
- **Alias**: `l`
967
- **Description**: manage lanes - if no sub-command is used, runs "bit lane list"
968
-
969
- `bit lane [sub-command]`
970
-
971
- ### lane list
972
-
973
- **Usage**: `lane list`
974
-
975
- **Description**: list local lanes
976
-
977
- | **Option** | **Option alias** | **Description** |
978
- | ------------------------------ | :--------------: | ------------------------------------------------------------- |
979
- | `--details` | `-d` | show more details on the state of each component in each lane |
980
- | `--json` | `-j` | show lanes' details in a json format |
981
- | `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
982
- | `--merged` | | list only merged lanes |
983
- | `--not-merged` | | list only lanes that haven't been merged |
984
-
985
- ### lane switch
986
-
987
- **Usage**: `lane switch <lane>`
988
-
989
- **Description**: switch to the specified lane
990
-
991
- | **Arg** | **Description** |
992
- | ------- | :------------------------------------------------------: |
993
- | `lane` | lane-name or lane-id (if lane is not local) to switch to |
994
-
995
- | **Option** | **Option alias** | **Description** |
996
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
997
- | `--alias <string>` | `-n` | relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote |
998
- | `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
999
- | `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
1000
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1001
- | `--pattern <component-pattern>` | `-p` | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1002
- | `--json` | `-j` | return the output as JSON |
1003
-
1004
- ### lane show
1005
-
1006
- **Usage**: `lane show [lane-name]`
1007
-
1008
- **Description**: show lane details. if no lane specified, show the current lane
1009
-
1010
- | **Option** | **Option alias** | **Description** |
1011
- | ---------- | :--------------: | ---------------------------------------------------- |
1012
- | `--json` | `-j` | show the lane details in json format |
1013
- | `--remote` | `-r` | show details of the remote head of the provided lane |
1014
-
1015
- ### lane create
1016
-
1017
- **Usage**: `lane create <lane-name>`
1018
-
1019
- **Description**: creates a new lane and switches to it
1020
- a lane created from main (default-lane) is empty until components are snapped.
1021
- a lane created from another lane contains all the components of the original lane.
1022
-
1023
- | **Arg** | **Description** |
1024
- | ----------- | :-----------------------: |
1025
- | `lane-name` | the name for the new lane |
1026
-
1027
- | **Option** | **Option alias** | **Description** |
1028
- | ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1029
- | `--scope <scope-name>` | `-s` | remote scope to which this lane will be exported, default to the workspace.json's defaultScope (can be changed up to first export of the lane with "bit lane change-scope") |
1030
- | `--remote-scope <scope-name>` | | DEPRECATED. use --scope |
1031
- | `--alias <name>` | | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias") |
1032
- | `--fork-lane-new-scope` | | create the new lane in a different scope than its parent lane (if created from another lane) |
1033
-
1034
- ### lane remove
1035
-
1036
- **Usage**: `lane remove <lanes...>`
1037
-
1038
- **Description**: remove or delete lanes
1039
-
1040
- | **Arg** | **Description** |
1041
- | ---------- | :---------------------------------------: |
1042
- | `lanes...` | A list of lane names, separated by spaces |
1043
-
1044
- | **Option** | **Option alias** | **Description** |
1045
- | ---------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
1046
- | `--remote` | `-r` | delete a remote lane. use remote/lane-id syntax e.g. bit lane remove owner.org/my-lane --remote. Delete is immediate, no export required |
1047
- | `--force` | `-f` | removes/deletes the lane even when the lane is not yet merged to main |
1048
- | `--silent` | `-s` | skip confirmation |
1049
-
1050
- ### lane change-scope
1051
-
1052
- **Usage**: `lane change-scope <remote-scope-name>`
1053
-
1054
- **Description**: changes the remote scope of a lane
1055
- NOTE: available only before the lane is exported to the remote
1056
-
1057
- | **Option** | **Option alias** | **Description** |
1058
- | ------------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
1059
- | `--lane-name <lane-name>` | `-l` | the name of the lane to change its remote scope. if not specified, the current lane is used |
1060
-
1061
- ### lane alias
1062
-
1063
- **Usage**: `lane alias <lane-name> <alias>`
1064
-
1065
- **Description**: adds an alias to a lane
1066
- an alias is a name that can be used locally to refer to a lane. it is saved locally and never reaches the remote.
1067
- it is useful e.g. when having multiple lanes with the same name, but with different remote scopes.
1068
-
1069
- ### lane rename
1070
-
1071
- **Usage**: `lane rename <new-name>`
1072
-
1073
- **Description**: EXPERIMENTAL. change the lane-name locally
1074
- the remote will be updated after the next "bit export" command
1075
-
1076
- | **Option** | **Option alias** | **Description** |
1077
- | ------------------------- | :--------------: | -------------------------------------------------------------------------- |
1078
- | `--lane-name <lane-name>` | `-l` | the name of the lane to rename. if not specified, the current lane is used |
1079
-
1080
- ### lane diff
1081
-
1082
- **Usage**: `lane diff [values...]`
1083
-
1084
- **Description**: show diff between lanes
1085
- bit lane diff => diff between the current lane and default lane. (only inside workspace).
1086
- bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
1087
- bit lane diff from to => diff between "from" lane and "to" lane.
1088
-
1089
- | **Arg** | **Description** |
1090
- | ------- | :------------------------------: |
1091
- | `from` | base lane for comparison |
1092
- | `to` | lane being compared to base lane |
1093
-
1094
- | **Option** | **Option alias** | **Description** |
1095
- | ------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1096
- | `--pattern <component-pattern>` | | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1097
-
1098
- ### lane add-readme
1099
-
1100
- **Usage**: `lane add-readme <component-name> [lane-name]`
1101
-
1102
- **Description**: EXPERIMENTAL. sets an existing component as the readme of a lane
1103
-
1104
- | **Arg** | **Description** |
1105
- | -------------- | :-------------------------------------------------------------------: |
1106
- | `component-id` | the component name or id of the component to use as the lane's readme |
1107
- | `lane-name` | the lane to attach the readme to (defaults to the current lane) |
1108
-
1109
- ### lane remove-readme
1110
-
1111
- **Usage**: `lane remove-readme [laneName]`
1112
-
1113
- **Description**: EXPERIMENTAL. remove lane readme component
1114
-
1115
- ### lane import
1116
-
1117
- **Usage**: `lane import <lane>`
1118
-
1119
- **Description**: import a remote lane to your workspace and switch to that lane
1120
-
1121
- | **Arg** | **Description** |
1122
- | ------- | :------------------: |
1123
- | `lane` | the remote lane name |
1124
-
1125
- | **Option** | **Option alias** | **Description** |
1126
- | -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
1127
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1128
- | `--pattern <component-pattern>` | `-p` | import only components from the lane that fit the specified component-pattern to the workspace. works only when the workspace is empty |
1129
-
1130
- ### lane remove-comp
1131
-
1132
- **Usage**: `lane remove-comp <component-pattern>`
1133
-
1134
- **Description**: DEPRECATED. remove components when on a lane
1135
-
1136
- | **Arg** | **Description** |
1137
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1138
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1139
-
1140
- | **Option** | **Option alias** | **Description** |
1141
- | ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
1142
- | `--workspace-only` | | do not mark the components as removed from the lane. instead, remove them from the workspace only |
1143
- | `--update-main` | | EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main |
1144
-
1145
- ### lane merge
1146
-
1147
- **Usage**: `lane merge <lane> [pattern]`
1148
-
1149
- **Description**: merge a local or a remote lane to the current lane
1150
- by default, the provided lane will be fetched from the remote before merging.
1151
- to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
1152
-
1153
- when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,
1154
- these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead.
1155
-
1156
- in case a component in both ends don't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.
1157
- this flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:
1158
-
1159
- 1. if the component exists on main, then the history linked to main will be kept.
1160
- in this case, the strategy of "--resolve-unrelated" only determines which source-code to keep. it's not about the history.
1161
- 2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.
1162
- unless "--resolve-unrelated" is set to "theirs", in which case the history of the other lane will be kept.
1163
- 3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".
1164
- so then the history (and the source-code) of the other lane will be kept.
1165
-
1166
- | **Arg** | **Description** |
1167
- | --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1168
- | `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
1169
- | `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1170
-
1171
- | **Option** | **Option alias** | **Description** |
1172
- | --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
1173
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
1174
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
1175
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1176
- | `--auto-merge-resolve <merge-strategy>` | | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
1177
- | `--workspace` | | merge only lane components that are in the current workspace |
1178
- | `--no-snap` | | do not auto snap after merge completed without conflicts |
1179
- | `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
1180
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1181
- | `--message <message>` | `-m` | override the default message for the auto snap |
1182
- | `--keep-readme` | | skip deleting the lane readme component after merging |
1183
- | `--no-squash` | | relevant for merging lanes into main, which by default squashes all lane snaps |
1184
- | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash |
1185
- | `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
1186
- | `--verbose` | | show details of components that were not merged successfully |
1187
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1188
- | `--skip-fetch` | | use the local state of target-lane if exits locally, without updating it from the remote |
1189
- | `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components |
1190
- | `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
1191
- | `--include-non-lane-comps` | | when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
1192
-
1193
- ### lane merge-abort
1194
-
1195
- **Usage**: `lane merge-abort`
1196
-
1197
- **Description**: abort the recent lane-merge. revert the lane object and checkout accordingly
1198
- restore the lane-object to its state before the last "bit lane merge" command.
1199
- also, checkout the workspace components according to the restored lane state
1200
-
1201
- | **Option** | **Option alias** | **Description** |
1202
- | -------------------------------- | :--------------: | -------------------------------------------------------- |
1203
- | `--verbose` | | show details of components that didn't need to be merged |
1204
- | `--silent` | `-s` | skip confirmation |
1205
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
1206
-
1207
- | **Option** | **Option alias** | **Description** |
1208
- | ------------------------------ | :--------------: | ------------------------------------------------------------- |
1209
- | `--details` | `-d` | show more details on the state of each component in each lane |
1210
- | `--json` | `-j` | show lanes details in json format |
1211
- | `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
1212
- | `--merged` | | list only merged lanes |
1213
- | `--not-merged` | | list only lanes that haven't been merged |
689
+ | **Option** | **Option alias** | **Description** |
690
+ | --------------------------------------- | :--------------: | --------------------------------------------------------------- |
691
+ | `--variants <variants>` | `-v` | add packages to specific variants |
692
+ | `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
693
+ | `--update-existing [updateExisting]` | `-u` | update existing dependencies version and types |
694
+ | `--save-prefix [savePrefix]` | | set the prefix to use when adding dependency to workspace.jsonc |
695
+ | `--skip-dedupe [skipDedupe]` | | do not dedupe dependencies on installation |
696
+ | `--skip-import [skipImport]` | | do not import bit objects post installation |
697
+ | `--add-missing-peers [addMissingPeers]` | | install all missing peer dependencies |
1214
698
 
1215
699
  ---
1216
700
 
1217
701
  ## link
1218
702
 
1219
- **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
1220
-
1221
- `bit link [component-names...]`
703
+ **Workspace only**: yes
704
+ **Description**: generate symlinks to resolve module paths for imported components.
705
+ https://bit.dev/reference/workspace/component-links
1222
706
 
1223
- | **Arg** | **Description** |
1224
- | -------------------- | :------------------------------------: |
1225
- | `component-names...` | names or IDs of the components to link |
707
+ `bit link [ids...]`
1226
708
 
1227
- | **Option** | **Option alias** | **Description** |
1228
- | ------------------------- | :--------------: | ------------------------------------------------------------------------------------------------ |
1229
- | `--json` | `-j` | return the output as JSON |
1230
- | `--verbose` | | verbose output |
1231
- | `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
1232
- | `--target <dir>` | | link to an external directory (similar to npm-link) so other projects could use these components |
1233
- | `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking |
1234
- | `--peers` | | link peer dependencies of the components too |
709
+ | **Option** | **Option alias** | **Description** |
710
+ | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
711
+ | `--json` | `-j` | return the output as JSON |
712
+ | `--verbose` | | verbose output |
713
+ | `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
714
+ | `--target <dir>` | | EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components |
715
+ | `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking |
1235
716
 
1236
717
  ---
1237
718
 
1238
719
  ## lint
1239
720
 
721
+ **Workspace only**: yes
1240
722
  **Description**: lint components in the development workspace
1241
723
 
1242
724
  `bit lint [component...]`
@@ -1253,74 +735,59 @@ also, checkout the workspace components according to the restored lane state
1253
735
  ## list
1254
736
 
1255
737
  **Alias**: `ls`
1256
- **Description**: list components on a workspace or a remote scope (with flag).
738
+ **Workspace only**: no
739
+ **Description**: list components on a local or a remote scope.
740
+ https://bit.dev/reference/reference/cli-reference#list
1257
741
 
1258
742
  `bit list [remote-scope]`
1259
743
 
1260
- | **Option** | **Option alias** | **Description** |
1261
- | ---------------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1262
- | `--ids` | `-i` | show only component ids, unformatted |
1263
- | `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
1264
- | `--outdated` | `-o` | highlight outdated components, in comparison with their latest remote version (if one exists) |
1265
- | `--json` | `-j` | show the output in JSON format |
1266
- | `--namespace <string>` | `-n` | show only components in the specified namespace/s e.g. '-n ui' or '\*/ui' |
744
+ | **Option** | **Option alias** | **Description** |
745
+ | ---------------------- | :--------------: | ------------------------------------------------------------------------------- |
746
+ | `--ids` | `-i` | show only component ids unformatted |
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) |
750
+ | `--outdated` | `-o` | show latest versions from remotes |
751
+ | `--json` | `-j` | show the output in JSON format |
752
+ | `--namespace <string>` | `-n` | show only specified namespace by using wildcards |
1267
753
 
1268
754
  ---
1269
755
 
1270
756
  ## log
1271
757
 
1272
- **Description**: show components(s) version history
758
+ **Workspace only**: no
759
+ **Description**: show components(s) tag history.
760
+ https://bit.dev/reference/reference/cli-reference#log
1273
761
 
1274
762
  `bit log <id>`
1275
763
 
1276
- | **Arg** | **Description** |
1277
- | ------- | :----------------------------: |
1278
- | `id` | component-id or component-name |
1279
-
1280
- | **Option** | **Option alias** | **Description** |
1281
- | ------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1282
- | `--remote` | `-r` | show log of a remote component |
1283
- | `--parents` | | show parents and lanes data |
1284
- | `--one-line` | `-o` | show each log entry in one line |
1285
- | `--full-hash` | `-f` | show full hash of the snap (default to the first 9 characters for --one-line/--parents flags) |
1286
- | `--json` | `-j` | json format |
1287
-
1288
- ---
1289
-
1290
- ## log-file
1291
-
1292
- **Description**: EXPERIMENTAL. show file history
1293
-
1294
- `bit log-file <filepath>`
1295
-
1296
- | **Arg** | **Description** |
1297
- | ---------- | :---------------------------------: |
1298
- | `filepath` | file path relative to the workspace |
1299
-
1300
- | **Option** | **Option alias** | **Description** |
1301
- | ------------ | :--------------: | ------------------------------- |
1302
- | `--one-line` | `-o` | show each log entry in one line |
764
+ | **Option** | **Option alias** | **Description** |
765
+ | ----------- | :--------------: | ----------------------------------------- |
766
+ | `--remote` | `-r` | show log of a remote component |
767
+ | `--parents` | | EXPERIMENTAL. show parents and lanes data |
1303
768
 
1304
769
  ---
1305
770
 
1306
771
  ## login
1307
772
 
1308
- **Description**: log in to Bit cloud
773
+ **Workspace only**: no
774
+ **Description**: log the CLI into Bit Cloud
1309
775
 
1310
776
  `bit login`
1311
777
 
1312
- | **Option** | **Option alias** | **Description** |
1313
- | --------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
1314
- | `--cloud-domain <domain>` | `-d` | login cloud domain (default bit.cloud) |
1315
- | `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
1316
- | `--no-browser` | | do not open a browser for authentication |
1317
- | `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token) |
1318
- | `--suppress-browser-launch` | | DEPRECATE. use --no-browser instead |
778
+ | **Option** | **Option alias** | **Description** |
779
+ | --------------------------- | :--------------: | -------------------------------------------------------------------------------------------------- |
780
+ | `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
781
+ | `--suppress-browser-launch` | | do not open a browser for authentication |
782
+ | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
783
+ | `--skip-registry-config` | | don't configure bit.cloud registry |
784
+ | `--machine-name <string>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
1319
785
 
1320
786
  ---
1321
787
 
1322
788
  ## logout
1323
789
 
790
+ **Workspace only**: yes
1324
791
  **Description**: log the CLI out of Bit
1325
792
 
1326
793
  `bit logout`
@@ -1329,101 +796,81 @@ also, checkout the workspace components according to the restored lane state
1329
796
 
1330
797
  ## merge
1331
798
 
1332
- **Description**: merge changes of the remote head into local - auto-snaps all merged components
1333
- merge changes of the remote head into local when they are diverged. when on a lane, merge the remote head of the lane into the local
1334
- and creates snaps for merged components that have diverged, on the lane.
1335
- if no ids are specified, all pending-merge components will be merged. (run "bit status" to list them).
1336
- optionally use '--abort' to revert the last merge. to revert a lane merge, use "bit lane merge-abort" command.
1337
- you can use a pattern for multiple ids, such as bit merge "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
799
+ **Workspace only**: yes
800
+ **Description**: merge changes of different component versions
801
+ `bit merge <version> [ids...]` => merge changes of the given version into the checked out version
802
+ `bit merge [ids...]` => EXPERIMENTAL. merge changes of the remote head into local, optionally use '--abort' or '--resolve'
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)
1338
804
 
1339
- `bit merge [ids...]`
805
+ `bit merge [values...]`
1340
806
 
1341
- | **Option** | **Option alias** | **Description** |
1342
- | --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
1343
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep the local modification |
1344
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override the local modification with the specified version |
1345
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1346
- | `--auto-merge-resolve <merge-strategy>` | | in case of a conflict, resolve according to the strategy: [ours, theirs, manual] |
1347
- | `--abort` | | in case of an unresolved merge, revert to pre-merge state |
1348
- | `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes |
1349
- | `--no-snap` | | do not auto snap even if the merge completed without conflicts |
1350
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1351
- | `--verbose` | | show details of components that were not merged successfully |
1352
- | `--skip-dependency-installation` | `-x` | do not install new dependencies resulting from the merge |
1353
- | `--message <message>` | `-m` | 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 |
1354
817
 
1355
818
  ---
1356
819
 
1357
- ## mini-status
1358
-
1359
- **Alias**: `ms`
1360
- **Description**: EXPERIMENTAL. basic status for fast execution
1361
- shows only modified/new components with code changes. for the full status, use "bit status".
1362
- this command only checks source code changes, it doesn't check for config/aspect/dependency changes
820
+ ## move
1363
821
 
1364
- `bit mini-status [component-pattern]`
822
+ **Alias**: `mv`
823
+ **Workspace only**: yes
824
+ **Description**: move files or directories of component(s)
825
+ https://bit.dev/reference/workspace/moving-components
1365
826
 
1366
- | **Arg** | **Description** |
1367
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1368
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
827
+ `bit move <existing-dir> <new-dir>`
1369
828
 
1370
- | **Option** | **Option alias** | **Description** |
1371
- | --------------- | :--------------: | ---------------------------------------------- |
1372
- | `--show-issues` | | show component issues (slows down the command) |
1373
- | `--json` | `-j` | json format |
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>` |
1374
832
 
1375
833
  ---
1376
834
 
1377
- ## move
835
+ ## new
1378
836
 
1379
- **Alias**: `mv`
1380
- **Description**: move a component to a different filesystem path (note: this does NOT affect the component's name or scope, just its location in the workspace)
1381
- move files or directories of component(s)
837
+ **Workspace only**: yes
838
+ **Description**: Create a new workspace from a template
1382
839
 
1383
- `bit move <current-component-dir> <new-component-dir>`
840
+ `bit new <templateName> <workspaceName>`
1384
841
 
1385
- | **Arg** | **Description** |
1386
- | ----------------------- | :--------------------------------------------------------------------------------------------: |
1387
- | `current-component-dir` | the component's current directory (relative to the workspace root) |
1388
- | `new-component-dir` | the new directory (relative to the workspace root) to create and move the component's files to |
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 |
1389
850
 
1390
851
  ---
1391
852
 
1392
- ## new
1393
-
1394
- **Description**: create a new workspace from a template
853
+ ## pack
1395
854
 
1396
- `bit new <template-name> <workspace-name>`
855
+ **Workspace only**: yes
856
+ **Description**: create tar for npm publish
1397
857
 
1398
- | **Arg** | **Description** |
1399
- | ---------------- | :----------------------------------------------------------------------------------------------------------------------------: |
1400
- | `template-name` | the name of the workspace template (run 'bit templates' outside of a workspace to get a list of available workspace templates) |
1401
- | `workspace-name` | the name for the new workspace and workspace directory that will be created |
858
+ `bit pack <componentId> [scopePath]`
1402
859
 
1403
- | **Option** | **Option alias** | **Description** |
1404
- | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
1405
- | `--aspect <aspect-id>` | `-a` | id of the aspect that registered the template, mandatory for non-core aspects. helpful for core aspects in case of a name collision |
1406
- | `--template <env-id>` | `-t` | env-id of the template's owner. Alias for --env. |
1407
- | `--env <env-id>` | | env-id of the template. Alias -t |
1408
- | `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace's workspace.jsonc |
1409
- | `--standalone` | | DEPRECATED. use --skip-git instead |
1410
- | `--skip-git` | `-s` | skip generation of Git repository in the new workspace |
1411
- | `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
1412
- | `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during a development of a workspace-template |
860
+ | **Option** | **Option alias** | **Description** |
861
+ | --------------------- | :--------------: | -------------------------------------------------- |
862
+ | `--out-dir <out-dir>` | `-d` | directory to put the result tar file |
863
+ | `--override` | `-o` | override existing pack file |
864
+ | `--keep` | `-k` | should keep isolated environment [default = false] |
865
+ | `--prefix` | `-p` | keep custom (binding) prefix |
866
+ | `--json` | `-j` | return the output as JSON |
1413
867
 
1414
868
  ---
1415
869
 
1416
870
  ## pattern
1417
871
 
1418
- **Description**: list the component ids matching the given pattern
1419
- this command helps validating a pattern before using it in other commands.
1420
- a pattern can be a simple component-id or component-name. e.g. 'ui/button'.
1421
- a pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.
1422
- to enter multiple patterns, separate them by a comma, e.g. 'ui/_, lib/_'
1423
- to exclude, use '!'. e.g. 'ui/**, !ui/button'
1424
- always wrap the pattern with single quotes to avoid collision with shell commands.
1425
- the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch)
1426
- NOTE: always wrap the pattern with single quotes '' and not double "" to avoid collision with shell commands
872
+ **Workspace only**: yes
873
+ **Description**: list the component ids matching the given pattern
1427
874
 
1428
875
  `bit pattern <pattern>`
1429
876
 
@@ -1433,21 +880,10 @@ NOTE: always wrap the pattern with single quotes '' and not double "" to avoid c
1433
880
 
1434
881
  ---
1435
882
 
1436
- ## recover
1437
-
1438
- **Description**: EXPERIMENTAL. recover component(s) soft-deleted from the workspace, or a remote scope
1439
-
1440
- `bit recover <component-name>`
1441
-
1442
- | **Option** | **Option alias** | **Description** |
1443
- | -------------------------------- | :--------------: | ------------------------------------------------------- |
1444
- | `--skip-dependency-installation` | `-x` | do not install packages in case of importing components |
1445
-
1446
- ---
1447
-
1448
883
  ## refactor
1449
884
 
1450
- **Description**: source code refactoring / codemod
885
+ **Workspace only**: yes
886
+ **Description**: EXPERIMENTAL. source code refactoring / codemod
1451
887
 
1452
888
  `bit refactor <sub-command>`
1453
889
 
@@ -1462,7 +898,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
1462
898
 
1463
899
  ## remote
1464
900
 
1465
- **Description**: manage set of tracked bit scope(s)
901
+ **Workspace only**: yes
902
+ **Description**: manage set of tracked bit scope(s)
903
+ https://bit.dev/reference/scope/remote-scopes
1466
904
 
1467
905
  `bit remote`
1468
906
 
@@ -1470,9 +908,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
1470
908
 
1471
909
  **Usage**: `remote add <url>`
1472
910
 
1473
- **Description**: add a bare-scope as a remote
1474
- supported protocols are [file, http].
1475
- for example: "http://localhost:3000", "file:///tmp/local-scope"
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].
1476
914
 
1477
915
  | **Option** | **Option alias** | **Description** |
1478
916
  | ---------- | :--------------: | ---------------------------- |
@@ -1484,9 +922,9 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1484
922
 
1485
923
  **Description**: remove a tracked bit remote
1486
924
 
1487
- | **Option** | **Option alias** | **Description** |
1488
- | ---------- | :--------------: | ----------------------------------------- |
1489
- | `--global` | `-g` | remove a globally configured remote scope |
925
+ | **Option** | **Option alias** | **Description** |
926
+ | ---------- | :--------------: | --------------------------------------- |
927
+ | `--global` | `-g` | remove a global configured remote scope |
1490
928
 
1491
929
  | **Option** | **Option alias** | **Description** |
1492
930
  | ---------- | :--------------: | ------------------------------- |
@@ -1497,193 +935,83 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1497
935
  ## remove
1498
936
 
1499
937
  **Alias**: `rm`
1500
- **Description**: remove component(s) from the local workspace
1501
- to mark components as deleted on the remote scope, use "bit delete".
1502
-
1503
- `bit remove <component-pattern>`
938
+ **Workspace only**: no
939
+ **Description**: remove a component (local/remote)
940
+ https://bit.dev/reference/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)
1504
942
 
1505
- | **Arg** | **Description** |
1506
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1507
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
943
+ `bit remove <ids...>`
1508
944
 
1509
- | **Option** | **Option alias** | **Description** |
1510
- | -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
1511
- | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
1512
- | `--keep-files` | | keep component files (just untrack the component) |
1513
- | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: you will need to fix the components that depend on this component |
1514
- | `--silent` | `-s` | skip confirmation |
945
+ | **Option** | **Option alias** | **Description** |
946
+ | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
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) |
950
+ | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
951
+ | `--silent` | `-s` | skip confirmation |
1515
952
 
1516
953
  ---
1517
954
 
1518
955
  ## rename
1519
956
 
1520
- **Description**: rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component
1521
-
1522
- `bit rename <current-name> <new-name>`
957
+ **Workspace only**: no
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
1523
961
 
1524
- | **Arg** | **Description** |
1525
- | -------------- | :----------------------------------------------------------------------------------------------: |
1526
- | `current-name` | the current component name (without its scope name) |
1527
- | `new-name` | the new component name (without its scope name. use --scope to define the new component's scope) |
962
+ `bit rename <source-name> <target-name>`
1528
963
 
1529
- | **Option** | **Option alias** | **Description** |
1530
- | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
1531
- | `--scope <scope-name>` | `-s` | define the scope for the newly created component |
1532
- | `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
1533
- | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
1534
- | `--preserve` | | avoid renaming files and variables/classes according to the new component name |
1535
- | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
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 |
1536
969
 
1537
970
  ---
1538
971
 
1539
- ## reset
1540
-
1541
- **Description**: revert tagged or snapped versions for component(s)
1542
- https://https://bit.dev//components/tags#undoing-a-tag
1543
-
1544
- `bit reset [component-pattern]`
972
+ ## resume-export
1545
973
 
1546
- | **Arg** | **Description** |
1547
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1548
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1549
- | `component-version` | the version to untag (semver for tags. hash for snaps) |
974
+ **Workspace only**: yes
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
1550
978
 
1551
- | **Option** | **Option alias** | **Description** |
1552
- | ---------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
1553
- | `--all` | `-a` | revert all unexported tags/snaps for all components |
1554
- | `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
1555
- | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
1556
- | `--force` | `-f` | revert the tag even if it's used as a dependency. WARNING: components that depend on this tag will be corrupted |
1557
-
1558
- ---
1559
-
1560
- ## revert
1561
-
1562
- **Description**: replace the current component files by the specified version, leave the version intact
1563
-
1564
- `bit revert <component-pattern> <to>`
1565
-
1566
- | **Arg** | **Description** |
1567
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1568
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1569
- | `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
1570
-
1571
- | **Option** | **Option alias** | **Description** |
1572
- | -------------------------------- | :--------------: | -------------------------------------------------- |
1573
- | `--verbose` | `-v` | showing verbose output for inspection |
1574
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
979
+ `bit resume-export <export-id> <remotes...>`
1575
980
 
1576
981
  ---
1577
982
 
1578
983
  ## run
1579
984
 
1580
985
  **Alias**: `c`
1581
- **Description**: locally run an app component (independent of bit's dev server)
1582
-
1583
- `bit run <app-name>`
986
+ **Workspace only**: yes
987
+ **Description**: run an application
1584
988
 
1585
- | **Arg** | **Description** |
1586
- | ---------- | :--------------------------------------------------------------------------------------------------: |
1587
- | `app-name` | the app's name is registered by the app (run 'bit app list' to list the names of the available apps) |
989
+ `bit run <app>`
1588
990
 
1589
- | **Option** | **Option alias** | **Description** |
1590
- | ---------------------- | :--------------: | -------------------------------------------------------------------------- |
1591
- | `--dev` | `-d` | start the application in dev mode. |
1592
- | `--port [port-number]` | `-p` | port to run the app on |
1593
- | `--verbose` | `-v` | show verbose output for inspection and print stack trace |
1594
- | `--skip-watch` | | avoid running the watch process that compiles components in the background |
1595
- | `--ssr` | | run app in server side rendering mode. |
991
+ | **Option** | **Option alias** | **Description** |
992
+ | -------------- | :--------------: | -------------------------------------------------------------------------- |
993
+ | `--dev` | `-d` | start the application in dev mode. |
994
+ | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
995
+ | `--skip-watch` | | avoid running the watch process that compiles components in the background |
1596
996
 
1597
997
  ---
1598
998
 
1599
999
  ## schema
1600
1000
 
1601
- **Description**: shows the API schema of the specified component/s.
1602
- you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
1603
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
1604
- always wrap the pattern with single quotes to avoid collision with shell commands.
1605
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1606
-
1607
- `bit schema <pattern>`
1608
-
1609
- | **Option** | **Option alias** | **Description** |
1610
- | ---------- | :--------------: | ------------------------------------------ |
1611
- | `--json` | `-j` | return the component schema in json format |
1612
-
1613
- ---
1614
-
1615
- ## scope
1616
-
1617
- **Description**: manage the scope-name for components
1618
-
1619
- `bit scope <sub-command>`
1620
-
1621
- ### scope set
1622
-
1623
- **Usage**: `scope set <scope-name> [component-pattern]`
1001
+ **Workspace only**: yes
1002
+ **Description**: shows the API schema of a certain component.
1624
1003
 
1625
- **Description**: Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace
1626
- default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
1627
- a component is set with a scope (as oppose to default scope) only once it is versioned.'
1004
+ `bit schema <id>`
1628
1005
 
1629
- you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
1630
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
1631
- always wrap the pattern with single quotes to avoid collision with shell commands.
1632
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1633
-
1634
- | **Arg** | **Description** |
1635
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1636
- | `scope-name` | name of the scope to set |
1637
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1638
-
1639
- ### scope rename
1640
-
1641
- **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1642
-
1643
- **Description**: Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged
1644
- Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`
1645
- as the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file
1646
- as a result of this change
1647
-
1648
- | **Arg** | **Description** |
1649
- | -------------------- | :-------------------------------------------------: |
1650
- | `current-scope-name` | the scope name to be replaced by another scope name |
1651
- | `new-scope-name` | a new scope name to replace the current scope name |
1652
-
1653
- | **Option** | **Option alias** | **Description** |
1654
- | ------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
1655
- | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (i.e. with the new scope name) |
1656
-
1657
- ### scope rename-owner
1658
-
1659
- **Usage**: `scope rename-owner <current-owner-name> <new-owner-name>`
1660
-
1661
- **Description**: Renames the owner part of the scope-name for all components with the specified 'current owner name'
1662
-
1663
- | **Arg** | **Description** |
1664
- | -------------------- | :-------------------------------------------------: |
1665
- | `current-owner-name` | the owner name to be replaced by another owner name |
1666
- | `new-owner-name` | a new owner name to replace the current owner name |
1667
-
1668
- | **Option** | **Option alias** | **Description** |
1669
- | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1670
- | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new owner name) |
1671
- | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
1672
-
1673
- ### scope fork
1674
-
1675
- **Usage**: `scope fork <original-scope> <new-scope>`
1676
-
1677
- **Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
1678
-
1679
- | **Option** | **Option alias** | **Description** |
1680
- | ---------- | :--------------: | --------------------------------------------------------- |
1681
- | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
1006
+ | **Option** | **Option alias** | **Description** |
1007
+ | ---------- | :--------------: | ---------------------------------------- |
1008
+ | `--json` | `-j` | return the component data in json format |
1682
1009
 
1683
1010
  ---
1684
1011
 
1685
1012
  ## scope-config
1686
1013
 
1014
+ **Workspace only**: yes
1687
1015
  **Description**: scope config management
1688
1016
 
1689
1017
  `bit scope-config`
@@ -1714,206 +1042,146 @@ as a result of this change
1714
1042
 
1715
1043
  ---
1716
1044
 
1717
- ## server
1718
-
1719
- **Description**: EXPERIMENTAL. communicate with bit cli program via http requests
1720
-
1721
- `bit server`
1722
-
1723
- | **Option** | **Option alias** | **Description** |
1724
- | --------------- | :--------------: | ------------------------- |
1725
- | `--port [port]` | `-p` | port to run the server on |
1726
-
1727
- ---
1728
-
1729
1045
  ## show
1730
1046
 
1731
- **Description**: display the component's essential information
1732
-
1733
- `bit show <component-name>`
1047
+ **Workspace only**: yes
1048
+ **Description**: show a component
1734
1049
 
1735
- | **Arg** | **Description** |
1736
- | ---------------- | :----------------------------: |
1737
- | `component-name` | component name or component id |
1050
+ `bit show <id>`
1738
1051
 
1739
- | **Option** | **Option alias** | **Description** |
1740
- | ----------- | :--------------: | ------------------------------------------------------------------------------------------------ |
1741
- | `--json` | `-j` | return the component data in json format |
1742
- | `--legacy` | `-l` | use the legacy bit show. |
1743
- | `--remote` | `-r` | show data for a remote component |
1744
- | `--compare` | `-c` | legacy-only. compare current file system component to its latest tagged version [default=latest] |
1745
-
1746
- ---
1747
-
1748
- ## snap
1749
-
1750
- **Description**: create an immutable and exportable component snapshot (non-release version)
1751
-
1752
- `bit snap [component-pattern]`
1753
-
1754
- | **Arg** | **Description** |
1755
- | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1756
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes. By default, only new and modified components are snapped (add --unmodified to snap all components in the workspace). |
1757
-
1758
- | **Option** | **Option alias** | **Description** |
1759
- | -------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1760
- | `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
1761
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
1762
- | `--unmerged` | | complete a merge process by snapping the unmerged components |
1763
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
1764
- | `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
1765
- | `--skip-tests` | | skip running component tests during snap process |
1766
- | `--skip-auto-snap` | | skip auto snapping dependents |
1767
- | `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
1768
- | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1769
- | `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
1770
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1771
- | `--all` | `-a` | DEPRECATED (not needed anymore, now the default). snap all new and modified components |
1772
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
1773
- | `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-snap even if tests are failing and even when component has not changed |
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. |
1774
1058
 
1775
1059
  ---
1776
1060
 
1777
1061
  ## start
1778
1062
 
1779
1063
  **Alias**: `c`
1780
- **Description**: run the ui/development server
1781
-
1782
- `bit start [component-pattern]`
1064
+ **Workspace only**: yes
1065
+ **Description**: Start a dev environment for a workspace or a specific component
1783
1066
 
1784
- | **Arg** | **Description** |
1785
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1786
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1067
+ `bit start [type] [pattern]`
1787
1068
 
1788
- | **Option** | **Option alias** | **Description** |
1789
- | ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
1790
- | `--dev` | `-d` | start UI server in dev mode. |
1791
- | `--port [port-number]` | `-p` | port of the UI server. |
1792
- | `--rebuild` | `-r` | rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case) |
1793
- | `--skip-ui-build` | | skip building UI |
1794
- | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1795
- | `--no-browser` | `-n` | do not automatically open browser when ready |
1796
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1797
- | `--ui-root-name [type]` | `-u` | name of the ui root to use, e.g. "teambit.scope/scope" or "teambit.workspace/workspace" |
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 |
1798
1077
 
1799
1078
  ---
1800
1079
 
1801
1080
  ## status
1802
1081
 
1803
1082
  **Alias**: `s`
1804
- **Description**: present the current status of components in the workspace, including indication of detected issues
1083
+ **Workspace only**: yes
1084
+ **Description**: show the working area component(s) status.
1085
+ https://bit.dev/reference/workspace/workspace-status
1805
1086
 
1806
1087
  `bit status`
1807
1088
 
1808
- | **Option** | **Option alias** | **Description** |
1809
- | ----------- | :--------------: | --------------------------------------------------------------------------------------- |
1810
- | `--json` | `-j` | return a json version of the component |
1811
- | `--verbose` | | show extra data: full snap hashes for staged components, and divergence point for lanes |
1812
- | `--lanes` | `-l` | when on a lane, show updates from main and updates from forked lanes |
1813
- | `--strict` | | in case issues found, exit with code 1 |
1814
-
1815
- ---
1816
-
1817
- ## system
1818
-
1819
- **Description**: system operations
1820
-
1821
- `bit system <sub-command>`
1822
-
1823
- ### system log
1824
-
1825
- **Usage**: `system log`
1826
-
1827
- **Description**: print debug.log to the screen
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 |
1828
1093
 
1829
1094
  ---
1830
1095
 
1831
1096
  ## tag
1832
1097
 
1833
1098
  **Alias**: `t`
1834
- **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1835
- if no patterns are provided, it will tag all new and modified components.
1836
- 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
1837
-
1838
- `bit tag [component-patterns...]`
1839
-
1840
- | **Arg** | **Description** |
1841
- | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1842
- | `component-patterns...` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes. By default, all new and modified are tagged. |
1843
-
1844
- | **Option** | **Option alias** | **Description** |
1845
- | ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1846
- | `--message <message>` | `-m` | a log message describing latest changes |
1847
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
1848
- | `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1849
- | `--ver <version>` | `-v` | tag with the given version |
1850
- | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1851
- | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1852
- | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1853
- | `--minor` | | syntactic sugar for "--increment minor" |
1854
- | `--major` | | syntactic sugar for "--increment major" |
1855
- | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1856
- | `--snapped` | | tag only components whose head is a snap (not a tag) |
1857
- | `--unmerged` | | complete a merge process by tagging the unmerged components |
1858
- | `--skip-tests` | | skip running component tests during tag process |
1859
- | `--skip-auto-tag` | | skip auto tagging dependents |
1860
- | `--soft` | | do not persist. only keep note of the changes to be made |
1861
- | `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
1862
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1863
- | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1864
- | `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
1865
- | `--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. |
1866
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1867
- | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) |
1868
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
1869
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
1870
- | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1871
- | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the local scope |
1872
- | `--force` | `-f` | DEPRECATED (use "--skip-tests", "--ignore-build-errors" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
1873
- | `--disable-deploy-pipeline` | | DEPRECATED. use --disable-tag-pipeline instead |
1099
+ **Workspace only**: yes
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/reference/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]
1129
+ to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
1130
+ |`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
1131
+ |`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|
1132
+ |`--all [version]`|`-a`|DEPRECATED (not needed anymore, it is the default now). tag all new and modified components|
1133
+ |`--scope [version]`|`-s`|DEPRECATED (use "--unmodified" instead). tag all components of the current scope|
1134
+ |`--force`|`-f`|DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed|
1135
+ |`--disable-deploy-pipeline`| |DEPRECATED. use --disable-tag-pipeline instead|
1874
1136
 
1875
1137
  ---
1876
1138
 
1877
1139
  ## templates
1878
1140
 
1879
- **Description**: list available templates for "bit create" and "bit new"
1880
- list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
1141
+ **Workspace only**: yes
1142
+ **Description**: list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)
1881
1143
 
1882
1144
  `bit templates`
1883
1145
 
1884
- | **Option** | **Option alias** | **Description** |
1885
- | ---------------------- | :--------------: | ---------------------------------------- |
1886
- | `--show-all` | `-s` | show hidden templates |
1887
- | `--aspect <aspect-id>` | `-a` | show templates provided by the aspect-id |
1146
+ | **Option** | **Option alias** | **Description** |
1147
+ | ------------ | :--------------: | --------------------- |
1148
+ | `--show-all` | `-s` | show hidden templates |
1888
1149
 
1889
1150
  ---
1890
1151
 
1891
1152
  ## test
1892
1153
 
1893
1154
  **Alias**: `at`
1894
- **Description**: test components in the workspace. by default only runs tests for new and modified components
1155
+ **Workspace only**: yes
1156
+ **Description**: test set of components in your workspace
1157
+
1158
+ `bit test [pattern]`
1895
1159
 
1896
- `bit test [component-pattern]`
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 |
1897
1169
 
1898
- | **Arg** | **Description** |
1899
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1900
- | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1170
+ ---
1171
+
1172
+ ## ui-build
1901
1173
 
1902
- | **Option** | **Option alias** | **Description** |
1903
- | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1904
- | `--watch` | `-w` | start the tester in watch mode. |
1905
- | `--debug` | `-d` | start the tester in debug mode. |
1906
- | `--all` | `-a` | DEPRECATED. (use --unmodified) |
1907
- | `--unmodified` | `-u` | test all components, not only new and modified |
1908
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1909
- | `--coverage` | | show code coverage data |
1910
- | `--env <id>` | `-e` | test only components assigned the given env |
1911
- | `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
1174
+ **Alias**: `c`
1175
+ **Workspace only**: yes
1176
+ **Description**: build production assets for deployment.
1177
+
1178
+ `bit ui-build [type]`
1912
1179
 
1913
1180
  ---
1914
1181
 
1915
1182
  ## undeprecate
1916
1183
 
1184
+ **Workspace only**: no
1917
1185
  **Description**: undeprecate a deprecated component (local/remote)
1918
1186
 
1919
1187
  `bit undeprecate <id>`
@@ -1923,106 +1191,64 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1923
1191
  ## uninstall
1924
1192
 
1925
1193
  **Alias**: `un`
1194
+ **Workspace only**: yes
1926
1195
  **Description**: uninstall dependencies
1927
1196
 
1928
1197
  `bit uninstall [packages...]`
1929
1198
 
1930
1199
  ---
1931
1200
 
1201
+ ## untag
1202
+
1203
+ **Workspace only**: yes
1204
+ **Description**: revert version(s) tagged for component(s)
1205
+ https://bit.dev/reference/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
+
1932
1218
  ## update
1933
1219
 
1934
1220
  **Alias**: `up`
1935
- **Description**: update dependencies. By default, dependencies are updated to the highest semver compatible versions.
1221
+ **Workspace only**: yes
1222
+ **Description**: update dependencies
1936
1223
 
1937
- `bit update [package-patterns...]`
1224
+ `bit update`
1938
1225
 
1939
- | **Arg** | **Description** |
1940
- | --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1941
- | `package-patterns...` | a string list of package names, or patterns (separated by spaces or commas), e.g. "@teambit/**,@my-org/ui/**". The patterns should be in glob format. By default, all packages are selected. |
1942
-
1943
- | **Option** | **Option alias** | **Description** |
1944
- | ---------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1945
- | `--yes` | `-y` | automatically update all outdated versions for packages specified in pattern (all if no pattern supplied) - use carefully as could result in breaking updates for dependencies |
1946
- | `--patch` | | update to the latest patch version. Semver rules are ignored |
1947
- | `--minor` | | update to the latest minor version. Semver rules are ignored |
1948
- | `--major` | | update to the latest major version. Semver rules are ignored |
1949
- | `--latest` | | update to the latest version. Semver rules are ignored |
1226
+ | **Option** | **Option alias** | **Description** |
1227
+ | ---------- | :--------------: | ------------------------------------------ |
1228
+ | `--yes` | `-y` | automatically update all outdated packages |
1950
1229
 
1951
1230
  ---
1952
1231
 
1953
1232
  ## use
1954
1233
 
1955
- **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1234
+ **Workspace only**: yes
1235
+ **Description**: set up aspects in the workspace/scope config
1956
1236
 
1957
- `bit use <component-id>`
1958
-
1959
- | **Arg** | **Description** |
1960
- | -------------- | :----------------------------: |
1961
- | `component-id` | the component ID of the aspect |
1237
+ `bit use [ids...]`
1962
1238
 
1963
1239
  ---
1964
1240
 
1965
1241
  ## watch
1966
1242
 
1967
- **Description**: automatically recompile modified components (on save)
1968
- by default, the watcher doesn't use polling, to keep the CPU idle.
1969
- if this doesn't work well for you, run "bit config set watch_use_polling true" to use polling.
1243
+ **Workspace only**: yes
1244
+ **Description**: watch a set of components
1970
1245
 
1971
1246
  `bit watch`
1972
1247
 
1973
1248
  | **Option** | **Option alias** | **Description** |
1974
1249
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1975
- | `--verbose` | `-v` | show all watch events and compiler verbose output |
1976
- | `--skip-pre-compilation` | | skip compilation step before starting to watch |
1250
+ | `--verbose` | `-v` | showing npm verbose output for inspection and prints stack trace |
1251
+ | `--skip-pre-compilation` | | skip the compilation step before starting to watch |
1977
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 |
1978
1253
 
1979
1254
  ---
1980
-
1981
- ## ws-config
1982
-
1983
- **Alias**: `workspace-config`
1984
- **Description**: manage workspace config files
1985
-
1986
- `bit ws-config <sub-command>`
1987
-
1988
- ### ws-config write
1989
-
1990
- **Usage**: `ws-config write`
1991
-
1992
- **Description**: EXPERIMENTAL. write config files in the workspace. useful for IDEs
1993
-
1994
- | **Option** | **Option alias** | **Description** |
1995
- | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1996
- | `--clean` | `-c` | delete existing config files from the workspace. highly recommended to run it with "--dry-run" first |
1997
- | `--writers <writers>` | `-w` | only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
1998
- | `--silent` | `-s` | do not prompt for confirmation |
1999
- | `--no-dedupe` | | write configs inside each one of the component's dir, avoid deduping |
2000
- | `--dry-run` | | show the paths that configs will be written per env |
2001
- | `--dry-run-with-content` | | use with --json flag. show the config content and the paths that will be written per env |
2002
- | `--verbose` | `-v` | showing verbose output for writing |
2003
- | `--json` | `-j` | json format |
2004
-
2005
- ### ws-config clean
2006
-
2007
- **Usage**: `ws-config clean`
2008
-
2009
- **Description**: EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs
2010
-
2011
- | **Option** | **Option alias** | **Description** |
2012
- | --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
2013
- | `--silent` | `-s` | do not prompt for confirmation |
2014
- | `--writers <writers>` | `-w` | only clean config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
2015
- | `--dry-run` | | show the paths of configs that will be cleaned |
2016
- | `--json` | `-j` | json format |
2017
-
2018
- ### ws-config list
2019
-
2020
- **Usage**: `ws-config list`
2021
-
2022
- **Description**: EXPERIMENTAL. list config writers
2023
-
2024
- | **Option** | **Option alias** | **Description** |
2025
- | ---------- | :--------------: | --------------- |
2026
- | `--json` | `-j` | json format |
2027
-
2028
- ---