@teambit/harmony.content.cli-reference 2.0.4 → 2.0.6

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 +1604 -3293
  3. package/cli-reference.mdx +543 -1310
  4. package/dist/cli-reference.docs.mdx +4 -3
  5. package/dist/cli-reference.json +1604 -3293
  6. package/dist/cli-reference.mdx.js +1950 -6620
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/preview-1695413141774.js +7 -0
  9. package/package.json +2 -2
  10. package/dist/preview-1695352690046.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,129 +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
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 |
769
- | `--fork-lane-new-scope` | | allow exporting a forked lane into a different scope than the original scope |
770
- | `--json` | `-j` | show output in json format |
771
555
 
772
556
  ---
773
557
 
774
558
  ## fork
775
559
 
776
- **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
777
564
 
778
- `bit fork <source-component-id> [target-component-name]`
565
+ `bit fork <source-id> [target-name]`
779
566
 
780
- | **Arg** | **Description** |
781
- | ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------: |
782
- | `source-component-id` | the component id of the source component |
783
- | `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 |
784
-
785
- | **Option** | **Option alias** | **Description** |
786
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
787
- | `--scope <string>` | `-s` | default scope for the new component |
788
- | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
789
- | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
790
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
791
- | `--env <string>` | `-e` | set the environment for the new component |
792
- | `--skip-config` | | do not copy the config (aspects-config, env, etc) to the new component. helpful when it fails during aspect loading |
793
- | `--preserve` | | avoid refactoring file and variable/class names according to the new component name |
794
- | `--no-link` | | avoid saving a reference to the original component |
795
- | `--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 |
796
572
 
797
573
  ---
798
574
 
799
575
  ## format
800
576
 
577
+ **Workspace only**: yes
801
578
  **Description**: format components in the development workspace
802
579
 
803
580
  `bit format [component...]`
@@ -810,32 +587,9 @@ bit export => export all staged snaps/tags of components to their remote scope.
810
587
 
811
588
  ---
812
589
 
813
- ## git
814
-
815
- **Description**: perform git operations
816
-
817
- `bit git <sub-command>`
818
-
819
- ### git set-merge-driver
820
-
821
- **Usage**: `git set-merge-driver`
822
-
823
- **Description**: setup bit's git merge driver for bitmap files
824
-
825
- | **Option** | **Option alias** | **Description** |
826
- | ---------- | :--------------: | --------------------------------- |
827
- | `--global` | `-g` | set the git merge driver globally |
828
-
829
- ### git merge-bitmaps
830
-
831
- **Usage**: `git merge-bitmaps <ancestor> <current> <other>`
832
-
833
- **Description**: a special command to merge conflicting bitmap files during git merge
834
-
835
- ---
836
-
837
590
  ## globals
838
591
 
592
+ **Workspace only**: yes
839
593
  **Description**: list all globals
840
594
 
841
595
  `bit globals`
@@ -848,391 +602,123 @@ bit export => export all staged snaps/tags of components to their remote scope.
848
602
 
849
603
  ## graph
850
604
 
851
- **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
852
607
 
853
608
  `bit graph [id]`
854
609
 
855
610
  | **Option** | **Option alias** | **Description** |
856
611
  | ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
857
- | `--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] |
858
613
  | `--remote [remoteName]` | `-r` | remote name (name is optional, leave empty when id is specified) |
859
614
  | `--all-versions` | | enter all components versions into the graph, not only latest |
860
615
  | `--layout <name>` | | GraphVis layout. default to "dot". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi] |
861
- | `--json` | `-j` | json format |
862
616
 
863
617
  ---
864
618
 
865
619
  ## help
866
620
 
867
621
  **Alias**: `$0`
622
+ **Workspace only**: yes
868
623
  **Description**: shows help
869
624
 
870
625
  `bit help`
871
626
 
872
- | **Option** | **Option alias** | **Description** |
873
- | ------------ | :--------------: | ---------------------- |
874
- | `--internal` | | show internal commands |
875
-
876
627
  ---
877
628
 
878
629
  ## import
879
630
 
880
- **Description**: import components from their remote scopes to the local workspace
881
-
882
- `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)
883
635
 
884
- | **Arg** | **Description** |
885
- | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
886
- | `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...]`
887
637
 
888
- | **Option** | **Option alias** | **Description** |
889
- | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
890
- | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
891
- | `--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 |
892
- | `--override` | `-O` | override local changes |
893
- | `--verbose` | `-v` | show verbose output for inspection |
894
- | `--json` | `-j` | return the output as JSON |
895
- | `--skip-dependency-installation` | `-x` | do not auto-install dependencies of the imported components |
896
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
897
- | `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
898
- | `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
899
- | `--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) |
900
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
901
- | `--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 |
902
- | `--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 |
903
- | `--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 |
904
654
 
905
655
  ---
906
656
 
907
657
  ## init
908
658
 
909
- **Description**: create or reinitialize an empty workspace
910
- 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
911
662
 
912
663
  `bit init [path]`
913
664
 
914
- | **Option** | **Option alias** | **Description** |
915
- | ----------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
916
- | `--bare [name]` | `-b` | initialize an empty bit bare scope |
917
- | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
918
- | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
919
- | `--reset` | `-r` | write missing or damaged Bit files |
920
- | `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
921
- | `--reset-lane-new` | | same as reset-new, but it only resets components belong to lanes. main components are left intact |
922
- | `--reset-hard` | | delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch |
923
- | `--reset-scope` | | removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact |
924
- | `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
925
- | `--default-scope <default-scope>` | | set the default scope for components in the workspace |
926
- | `--package-manager <package-manager>` | `-p` | set the package manager (npm or yarn) to be used in the workspace |
927
- | `--force` | `-f` | force workspace initialization without clearing local objects |
928
- | `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
929
- | `--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 |
930
678
 
931
679
  ---
932
680
 
933
681
  ## install
934
682
 
935
683
  **Alias**: `in`
936
- **Description**: installs workspace dependencies
937
- 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
938
686
 
939
687
  `bit install [packages...]`
940
688
 
941
- | **Arg** | **Description** |
942
- | ------------- | :-------------------------------------------------: |
943
- | `packages...` | a list of packages to install (separated by spaces) |
944
-
945
- | **Option** | **Option alias** | **Description** |
946
- | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
947
- | `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
948
- | `--update` | `-u` | update all dependencies to latest version according to their semver range |
949
- | `--update-existing` | | DEPRECATED (not needed anymore, it is the default now). update existing dependencies version and types |
950
- | `--save-prefix [savePrefix]` | | set the prefix to use when adding dependency to workspace.jsonc |
951
- | `--skip-dedupe` | | do not dedupe dependencies on installation |
952
- | `--skip-import` | | do not import bit objects post installation |
953
- | `--skip-compile` | | do not compile components |
954
- | `--add-missing-deps` | | install all missing dependencies |
955
- | `--add-missing-peers` | | install all missing peer dependencies |
956
- | `--recurring-install` | | automatically run install again if there are non loaded old envs in your workspace |
957
- | `--no-optional [noOptional]` | | do not install optional dependencies (works with pnpm only) |
958
- | `--lockfile-only` | | dependencies are not written to node_modules. Only the lockfile is updated |
959
-
960
- ---
961
-
962
- ## lane
963
-
964
- **Alias**: `l`
965
- **Description**: manage lanes - if no sub-command is used, runs "bit lane list"
966
-
967
- `bit lane [sub-command]`
968
-
969
- ### lane list
970
-
971
- **Usage**: `lane list`
972
-
973
- **Description**: list local lanes
974
-
975
- | **Option** | **Option alias** | **Description** |
976
- | ------------------------------ | :--------------: | ------------------------------------------------------------- |
977
- | `--details` | `-d` | show more details on the state of each component in each lane |
978
- | `--json` | `-j` | show lanes' details in a json format |
979
- | `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
980
- | `--merged` | | list only merged lanes |
981
- | `--not-merged` | | list only lanes that haven't been merged |
982
-
983
- ### lane switch
984
-
985
- **Usage**: `lane switch <lane>`
986
-
987
- **Description**: switch to the specified lane
988
-
989
- | **Arg** | **Description** |
990
- | ------- | :------------------------------------------------------: |
991
- | `lane` | lane-name or lane-id (if lane is not local) to switch to |
992
-
993
- | **Option** | **Option alias** | **Description** |
994
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
995
- | `--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 |
996
- | `--merge [strategy]` | `-m` | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" |
997
- | `--get-all` | `-a` | checkout all components in a lane, including those not currently in the workspace |
998
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
999
- | `--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 |
1000
- | `--json` | `-j` | return the output as JSON |
1001
-
1002
- ### lane show
1003
-
1004
- **Usage**: `lane show [lane-name]`
1005
-
1006
- **Description**: show lane details. if no lane specified, show the current lane
1007
-
1008
- | **Option** | **Option alias** | **Description** |
1009
- | ---------- | :--------------: | ---------------------------------------------------- |
1010
- | `--json` | `-j` | show the lane details in json format |
1011
- | `--remote` | `-r` | show details of the remote head of the provided lane |
1012
-
1013
- ### lane create
1014
-
1015
- **Usage**: `lane create <lane-name>`
1016
-
1017
- **Description**: creates a new lane and switches to it
1018
- a lane created from main (default-lane) is empty until components are snapped.
1019
- a lane created from another lane contains all the components of the original lane.
1020
-
1021
- | **Arg** | **Description** |
1022
- | ----------- | :-----------------------: |
1023
- | `lane-name` | the name for the new lane |
1024
-
1025
- | **Option** | **Option alias** | **Description** |
1026
- | ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1027
- | `--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") |
1028
- | `--remote-scope <scope-name>` | | DEPRECATED. use --scope |
1029
- | `--alias <name>` | | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias") |
1030
- | `--fork-lane-new-scope` | | create the new lane in a different scope than its parent lane (if created from another lane) |
1031
-
1032
- ### lane remove
1033
-
1034
- **Usage**: `lane remove <lanes...>`
1035
-
1036
- **Description**: remove or delete lanes
1037
-
1038
- | **Arg** | **Description** |
1039
- | ---------- | :---------------------------------------: |
1040
- | `lanes...` | A list of lane names, separated by spaces |
1041
-
1042
- | **Option** | **Option alias** | **Description** |
1043
- | ---------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
1044
- | `--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 |
1045
- | `--force` | `-f` | removes/deletes the lane even when the lane is not yet merged to main |
1046
- | `--silent` | `-s` | skip confirmation |
1047
-
1048
- ### lane change-scope
1049
-
1050
- **Usage**: `lane change-scope <remote-scope-name>`
1051
-
1052
- **Description**: changes the remote scope of a lane
1053
- NOTE: available only before the lane is exported to the remote
1054
-
1055
- | **Option** | **Option alias** | **Description** |
1056
- | ------------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
1057
- | `--lane-name <lane-name>` | `-l` | the name of the lane to change its remote scope. if not specified, the current lane is used |
1058
-
1059
- ### lane alias
1060
-
1061
- **Usage**: `lane alias <lane-name> <alias>`
1062
-
1063
- **Description**: adds an alias to a lane
1064
- an alias is a name that can be used locally to refer to a lane. it is saved locally and never reaches the remote.
1065
- it is useful e.g. when having multiple lanes with the same name, but with different remote scopes.
1066
-
1067
- ### lane rename
1068
-
1069
- **Usage**: `lane rename <new-name>`
1070
-
1071
- **Description**: EXPERIMENTAL. change the lane-name locally and on the remote (if exported)
1072
-
1073
- | **Option** | **Option alias** | **Description** |
1074
- | ------------------------- | :--------------: | -------------------------------------------------------------------------- |
1075
- | `--lane-name <lane-name>` | `-l` | the name of the lane to rename. if not specified, the current lane is used |
1076
-
1077
- ### lane diff
1078
-
1079
- **Usage**: `lane diff [values...]`
1080
-
1081
- **Description**: show diff between lanes
1082
- bit lane diff => diff between the current lane and default lane. (only inside workspace).
1083
- bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.
1084
- bit lane diff from to => diff between "from" lane and "to" lane.
1085
-
1086
- | **Arg** | **Description** |
1087
- | ------- | :------------------------------: |
1088
- | `from` | base lane for comparison |
1089
- | `to` | lane being compared to base lane |
1090
-
1091
- | **Option** | **Option alias** | **Description** |
1092
- | ------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1093
- | `--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 |
1094
-
1095
- ### lane add-readme
1096
-
1097
- **Usage**: `lane add-readme <component-name> [lane-name]`
1098
-
1099
- **Description**: EXPERIMENTAL. sets an existing component as the readme of a lane
1100
-
1101
- | **Arg** | **Description** |
1102
- | -------------- | :-------------------------------------------------------------------: |
1103
- | `component-id` | the component name or id of the component to use as the lane's readme |
1104
- | `lane-name` | the lane to attach the readme to (defaults to the current lane) |
1105
-
1106
- ### lane remove-readme
1107
-
1108
- **Usage**: `lane remove-readme [laneName]`
1109
-
1110
- **Description**: EXPERIMENTAL. remove lane readme component
1111
-
1112
- ### lane import
1113
-
1114
- **Usage**: `lane import <lane>`
1115
-
1116
- **Description**: import a remote lane to your workspace and switch to that lane
1117
-
1118
- | **Arg** | **Description** |
1119
- | ------- | :------------------: |
1120
- | `lane` | the remote lane name |
1121
-
1122
- | **Option** | **Option alias** | **Description** |
1123
- | -------------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
1124
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1125
- | `--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 |
1126
-
1127
- ### lane remove-comp
1128
-
1129
- **Usage**: `lane remove-comp <component-pattern>`
1130
-
1131
- **Description**: DEPRECATED. remove components when on a lane
1132
-
1133
- | **Arg** | **Description** |
1134
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1135
- | `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 |
1136
-
1137
- | **Option** | **Option alias** | **Description** |
1138
- | ------------------ | :--------------: | ------------------------------------------------------------------------------------------------- |
1139
- | `--workspace-only` | | do not mark the components as removed from the lane. instead, remove them from the workspace only |
1140
- | `--update-main` | | EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main |
1141
-
1142
- ### lane merge
1143
-
1144
- **Usage**: `lane merge <lane> [pattern]`
1145
-
1146
- **Description**: merge a local or a remote lane to the current lane
1147
- by default, the provided lane will be fetched from the remote before merging.
1148
- to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
1149
-
1150
- when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,
1151
- these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead.
1152
-
1153
- in case a component in both ends don't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.
1154
- 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:
1155
-
1156
- 1. if the component exists on main, then the history linked to main will be kept.
1157
- in this case, the strategy of "--resolve-unrelated" only determines which source-code to keep. it's not about the history.
1158
- 2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.
1159
- unless "--resolve-unrelated" is set to "theirs", in which case the history of the other lane will be kept.
1160
- 3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".
1161
- so then the history (and the source-code) of the other lane will be kept.
1162
-
1163
- | **Arg** | **Description** |
1164
- | --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1165
- | `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
1166
- | `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 |
1167
-
1168
- | **Option** | **Option alias** | **Description** |
1169
- | --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
1170
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
1171
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
1172
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1173
- | `--auto-merge-resolve <merge-strategy>` | | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
1174
- | `--workspace` | | merge only lane components that are in the current workspace |
1175
- | `--no-snap` | | do not auto snap after merge completed without conflicts |
1176
- | `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
1177
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1178
- | `--message <message>` | `-m` | override the default message for the auto snap |
1179
- | `--keep-readme` | | skip deleting the lane readme component after merging |
1180
- | `--no-squash` | | relevant for merging lanes into main, which by default squashes all lane snaps |
1181
- | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash |
1182
- | `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
1183
- | `--verbose` | | show details of components that were not merged successfully |
1184
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1185
- | `--skip-fetch` | | use the local state of target-lane if exits locally, without updating it from the remote |
1186
- | `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components |
1187
- | `--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" |
1188
- | `--include-non-lane-comps` | | when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
1189
-
1190
- ### lane merge-abort
1191
-
1192
- **Usage**: `lane merge-abort`
1193
-
1194
- **Description**: abort the recent lane-merge. revert the lane object and checkout accordingly
1195
- restore the lane-object to its state before the last "bit lane merge" command.
1196
- also, checkout the workspace components according to the restored lane state
1197
-
1198
- | **Option** | **Option alias** | **Description** |
1199
- | -------------------------------- | :--------------: | -------------------------------------------------------- |
1200
- | `--verbose` | | show details of components that didn't need to be merged |
1201
- | `--silent` | `-s` | skip confirmation |
1202
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
1203
-
1204
- | **Option** | **Option alias** | **Description** |
1205
- | ------------------------------ | :--------------: | ------------------------------------------------------------- |
1206
- | `--details` | `-d` | show more details on the state of each component in each lane |
1207
- | `--json` | `-j` | show lanes details in json format |
1208
- | `--remote <remote-scope-name>` | `-r` | show all remote lanes from the specified scope |
1209
- | `--merged` | | list only merged lanes |
1210
- | `--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 |
1211
698
 
1212
699
  ---
1213
700
 
1214
701
  ## link
1215
702
 
1216
- **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
1217
-
1218
- `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
1219
706
 
1220
- | **Arg** | **Description** |
1221
- | -------------------- | :------------------------------------: |
1222
- | `component-names...` | names or IDs of the components to link |
707
+ `bit link [ids...]`
1223
708
 
1224
- | **Option** | **Option alias** | **Description** |
1225
- | ------------------------- | :--------------: | ------------------------------------------------------------------------------------------------ |
1226
- | `--json` | `-j` | return the output as JSON |
1227
- | `--verbose` | | verbose output |
1228
- | `--rewire` | `-r` | Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo") |
1229
- | `--target <dir>` | | link to an external directory (similar to npm-link) so other projects could use these components |
1230
- | `--skip-fetching-objects` | | skip fetch missing objects from remotes before linking |
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 |
1231
716
 
1232
717
  ---
1233
718
 
1234
719
  ## lint
1235
720
 
721
+ **Workspace only**: yes
1236
722
  **Description**: lint components in the development workspace
1237
723
 
1238
724
  `bit lint [component...]`
@@ -1249,72 +735,59 @@ also, checkout the workspace components according to the restored lane state
1249
735
  ## list
1250
736
 
1251
737
  **Alias**: `ls`
1252
- **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
1253
741
 
1254
742
  `bit list [remote-scope]`
1255
743
 
1256
- | **Option** | **Option alias** | **Description** |
1257
- | ---------------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1258
- | `--ids` | `-i` | show only component ids, unformatted |
1259
- | `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
1260
- | `--outdated` | `-o` | highlight outdated components, in comparison with their latest remote version (if one exists) |
1261
- | `--json` | `-j` | show the output in JSON format |
1262
- | `--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 |
1263
753
 
1264
754
  ---
1265
755
 
1266
756
  ## log
1267
757
 
1268
- **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
1269
761
 
1270
762
  `bit log <id>`
1271
763
 
1272
- | **Arg** | **Description** |
1273
- | ------- | :----------------------------: |
1274
- | `id` | component-id or component-name |
1275
-
1276
- | **Option** | **Option alias** | **Description** |
1277
- | ------------ | :--------------: | ------------------------------- |
1278
- | `--remote` | `-r` | show log of a remote component |
1279
- | `--parents` | | show parents and lanes data |
1280
- | `--one-line` | `-o` | show each log entry in one line |
1281
- | `--json` | `-j` | json format |
1282
-
1283
- ---
1284
-
1285
- ## log-file
1286
-
1287
- **Description**: EXPERIMENTAL. show file history
1288
-
1289
- `bit log-file <filepath>`
1290
-
1291
- | **Arg** | **Description** |
1292
- | ---------- | :---------------------------------: |
1293
- | `filepath` | file path relative to the workspace |
1294
-
1295
- | **Option** | **Option alias** | **Description** |
1296
- | ------------ | :--------------: | ------------------------------- |
1297
- | `--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 |
1298
768
 
1299
769
  ---
1300
770
 
1301
771
  ## login
1302
772
 
1303
- **Description**: log in to Bit cloud
773
+ **Workspace only**: no
774
+ **Description**: log the CLI into Bit Cloud
1304
775
 
1305
776
  `bit login`
1306
777
 
1307
- | **Option** | **Option alias** | **Description** |
1308
- | --------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
1309
- | `--cloud-domain <domain>` | `-d` | login cloud domain (default bit.cloud) |
1310
- | `--port <port>` | `-p` | port number to open for localhost server (default 8085) |
1311
- | `--suppress-browser-launch` | | do not open a browser for authentication |
1312
- | `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoking the token) |
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) |
1313
785
 
1314
786
  ---
1315
787
 
1316
788
  ## logout
1317
789
 
790
+ **Workspace only**: yes
1318
791
  **Description**: log the CLI out of Bit
1319
792
 
1320
793
  `bit logout`
@@ -1323,101 +796,81 @@ also, checkout the workspace components according to the restored lane state
1323
796
 
1324
797
  ## merge
1325
798
 
1326
- **Description**: merge changes of the remote head into local - auto-snaps all merged components
1327
- 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
1328
- and creates snaps for merged components that have diverged, on the lane.
1329
- if no ids are specified, all pending-merge components will be merged. (run "bit status" to list them).
1330
- optionally use '--abort' to revert the last merge. to revert a lane merge, use "bit lane merge-abort" command.
1331
- 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)
1332
804
 
1333
- `bit merge [ids...]`
805
+ `bit merge [values...]`
1334
806
 
1335
- | **Option** | **Option alias** | **Description** |
1336
- | --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
1337
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep the local modification |
1338
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override the local modification with the specified version |
1339
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1340
- | `--auto-merge-resolve <merge-strategy>` | | in case of a conflict, resolve according to the strategy: [ours, theirs, manual] |
1341
- | `--abort` | | in case of an unresolved merge, revert to pre-merge state |
1342
- | `--resolve` | | mark an unresolved merge as resolved and create a new snap with the changes |
1343
- | `--no-snap` | | do not auto snap even if the merge completed without conflicts |
1344
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1345
- | `--verbose` | | show details of components that were not merged successfully |
1346
- | `--skip-dependency-installation` | `-x` | do not install new dependencies resulting from the merge |
1347
- | `--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 |
1348
817
 
1349
818
  ---
1350
819
 
1351
- ## mini-status
1352
-
1353
- **Alias**: `ms`
1354
- **Description**: EXPERIMENTAL. basic status for fast execution
1355
- shows only modified/new components with code changes. for the full status, use "bit status".
1356
- this command only checks source code changes, it doesn't check for config/aspect/dependency changes
820
+ ## move
1357
821
 
1358
- `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
1359
826
 
1360
- | **Arg** | **Description** |
1361
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1362
- | `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>`
1363
828
 
1364
- | **Option** | **Option alias** | **Description** |
1365
- | --------------- | :--------------: | ---------------------------------------------- |
1366
- | `--show-issues` | | show component issues (slows down the command) |
1367
- | `--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>` |
1368
832
 
1369
833
  ---
1370
834
 
1371
- ## move
835
+ ## new
1372
836
 
1373
- **Alias**: `mv`
1374
- **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)
1375
- move files or directories of component(s)
837
+ **Workspace only**: yes
838
+ **Description**: Create a new workspace from a template
1376
839
 
1377
- `bit move <current-component-dir> <new-component-dir>`
840
+ `bit new <templateName> <workspaceName>`
1378
841
 
1379
- | **Arg** | **Description** |
1380
- | ----------------------- | :--------------------------------------------------------------------------------------------: |
1381
- | `current-component-dir` | the component's current directory (relative to the workspace root) |
1382
- | `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 |
1383
850
 
1384
851
  ---
1385
852
 
1386
- ## new
1387
-
1388
- **Description**: create a new workspace from a template
853
+ ## pack
1389
854
 
1390
- `bit new <template-name> <workspace-name>`
855
+ **Workspace only**: yes
856
+ **Description**: create tar for npm publish
1391
857
 
1392
- | **Arg** | **Description** |
1393
- | ---------------- | :----------------------------------------------------------------------------------------------------------------------------: |
1394
- | `template-name` | the name of the workspace template (run 'bit templates' outside of a workspace to get a list of available workspace templates) |
1395
- | `workspace-name` | the name for the new workspace and workspace directory that will be created |
858
+ `bit pack <componentId> [scopePath]`
1396
859
 
1397
- | **Option** | **Option alias** | **Description** |
1398
- | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
1399
- | `--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 |
1400
- | `--template <env-id>` | `-t` | env-id of the template's owner. Alias for --env. |
1401
- | `--env <env-id>` | | env-id of the template. Alias -t |
1402
- | `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace's workspace.jsonc |
1403
- | `--standalone` | | DEPRECATED. use --skip-git instead |
1404
- | `--skip-git` | `-s` | skip generation of Git repository in the new workspace |
1405
- | `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
1406
- | `--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 |
1407
867
 
1408
868
  ---
1409
869
 
1410
870
  ## pattern
1411
871
 
1412
- **Description**: list the component ids matching the given pattern
1413
- this command helps validating a pattern before using it in other commands.
1414
- a pattern can be a simple component-id or component-name. e.g. 'ui/button'.
1415
- a pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.
1416
- to enter multiple patterns, separate them by a comma, e.g. 'ui/_, lib/_'
1417
- to exclude, use '!'. e.g. 'ui/**, !ui/button'
1418
- always wrap the pattern with single quotes to avoid collision with shell commands.
1419
- the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch)
1420
- 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
1421
874
 
1422
875
  `bit pattern <pattern>`
1423
876
 
@@ -1427,21 +880,10 @@ NOTE: always wrap the pattern with single quotes '' and not double "" to avoid c
1427
880
 
1428
881
  ---
1429
882
 
1430
- ## recover
1431
-
1432
- **Description**: EXPERIMENTAL. recover component(s) soft-deleted from the workspace, or a remote scope
1433
-
1434
- `bit recover <component-name>`
1435
-
1436
- | **Option** | **Option alias** | **Description** |
1437
- | -------------------------------- | :--------------: | ------------------------------------------------------- |
1438
- | `--skip-dependency-installation` | `-x` | do not install packages in case of importing components |
1439
-
1440
- ---
1441
-
1442
883
  ## refactor
1443
884
 
1444
- **Description**: source code refactoring / codemod
885
+ **Workspace only**: yes
886
+ **Description**: EXPERIMENTAL. source code refactoring / codemod
1445
887
 
1446
888
  `bit refactor <sub-command>`
1447
889
 
@@ -1456,7 +898,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
1456
898
 
1457
899
  ## remote
1458
900
 
1459
- **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
1460
904
 
1461
905
  `bit remote`
1462
906
 
@@ -1464,9 +908,9 @@ the `<old-id>` and `<new-id>` arguments can be either a component-id or a packag
1464
908
 
1465
909
  **Usage**: `remote add <url>`
1466
910
 
1467
- **Description**: add a bare-scope as a remote
1468
- supported protocols are [file, http].
1469
- 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].
1470
914
 
1471
915
  | **Option** | **Option alias** | **Description** |
1472
916
  | ---------- | :--------------: | ---------------------------- |
@@ -1478,9 +922,9 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1478
922
 
1479
923
  **Description**: remove a tracked bit remote
1480
924
 
1481
- | **Option** | **Option alias** | **Description** |
1482
- | ---------- | :--------------: | ----------------------------------------- |
1483
- | `--global` | `-g` | remove a globally configured remote scope |
925
+ | **Option** | **Option alias** | **Description** |
926
+ | ---------- | :--------------: | --------------------------------------- |
927
+ | `--global` | `-g` | remove a global configured remote scope |
1484
928
 
1485
929
  | **Option** | **Option alias** | **Description** |
1486
930
  | ---------- | :--------------: | ------------------------------- |
@@ -1491,193 +935,83 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1491
935
  ## remove
1492
936
 
1493
937
  **Alias**: `rm`
1494
- **Description**: remove component(s) from the local workspace
1495
- to mark components as deleted on the remote scope, use "bit delete".
1496
-
1497
- `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)
1498
942
 
1499
- | **Arg** | **Description** |
1500
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1501
- | `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...>`
1502
944
 
1503
- | **Option** | **Option alias** | **Description** |
1504
- | -------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------- |
1505
- | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
1506
- | `--keep-files` | | keep component files (just untrack the component) |
1507
- | `--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 |
1508
- | `--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 |
1509
952
 
1510
953
  ---
1511
954
 
1512
955
  ## rename
1513
956
 
1514
- **Description**: rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component
1515
-
1516
- `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
1517
961
 
1518
- | **Arg** | **Description** |
1519
- | -------------- | :----------------------------------------------------------------------------------------------: |
1520
- | `current-name` | the current component name (without its scope name) |
1521
- | `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>`
1522
963
 
1523
- | **Option** | **Option alias** | **Description** |
1524
- | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
1525
- | `--scope <scope-name>` | `-s` | define the scope for the newly created component |
1526
- | `--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 |
1527
- | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
1528
- | `--preserve` | | avoid renaming files and variables/classes according to the new component name |
1529
- | `--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 |
1530
969
 
1531
970
  ---
1532
971
 
1533
- ## reset
1534
-
1535
- **Description**: revert tagged or snapped versions for component(s)
1536
- https://https://bit.dev//components/tags#undoing-a-tag
1537
-
1538
- `bit reset [component-pattern]`
972
+ ## resume-export
1539
973
 
1540
- | **Arg** | **Description** |
1541
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1542
- | `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 |
1543
- | `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
1544
978
 
1545
- | **Option** | **Option alias** | **Description** |
1546
- | ---------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
1547
- | `--all` | `-a` | revert all unexported tags/snaps for all components |
1548
- | `--head` | | revert the head tag/snap only (by default, all local tags/snaps are reverted) |
1549
- | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
1550
- | `--force` | `-f` | revert the tag even if it's used as a dependency. WARNING: components that depend on this tag will be corrupted |
1551
-
1552
- ---
1553
-
1554
- ## revert
1555
-
1556
- **Description**: replace the current component files by the specified version, leave the version intact
1557
-
1558
- `bit revert <component-pattern> <to>`
1559
-
1560
- | **Arg** | **Description** |
1561
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1562
- | `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 |
1563
- | `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
1564
-
1565
- | **Option** | **Option alias** | **Description** |
1566
- | -------------------------------- | :--------------: | -------------------------------------------------- |
1567
- | `--verbose` | `-v` | showing verbose output for inspection |
1568
- | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
979
+ `bit resume-export <export-id> <remotes...>`
1569
980
 
1570
981
  ---
1571
982
 
1572
983
  ## run
1573
984
 
1574
985
  **Alias**: `c`
1575
- **Description**: locally run an app component (independent of bit's dev server)
1576
-
1577
- `bit run <app-name>`
986
+ **Workspace only**: yes
987
+ **Description**: run an application
1578
988
 
1579
- | **Arg** | **Description** |
1580
- | ---------- | :--------------------------------------------------------------------------------------------------: |
1581
- | `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>`
1582
990
 
1583
- | **Option** | **Option alias** | **Description** |
1584
- | ---------------------- | :--------------: | -------------------------------------------------------------------------- |
1585
- | `--dev` | `-d` | start the application in dev mode. |
1586
- | `--port [port-number]` | `-p` | port to run the app on |
1587
- | `--verbose` | `-v` | show verbose output for inspection and print stack trace |
1588
- | `--skip-watch` | | avoid running the watch process that compiles components in the background |
1589
- | `--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 |
1590
996
 
1591
997
  ---
1592
998
 
1593
999
  ## schema
1594
1000
 
1595
- **Description**: shows the API schema of the specified component/s.
1596
- you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
1597
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
1598
- always wrap the pattern with single quotes to avoid collision with shell commands.
1599
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1600
-
1601
- `bit schema <pattern>`
1602
-
1603
- | **Option** | **Option alias** | **Description** |
1604
- | ---------- | :--------------: | ------------------------------------------ |
1605
- | `--json` | `-j` | return the component schema in json format |
1606
-
1607
- ---
1608
-
1609
- ## scope
1610
-
1611
- **Description**: manage the scope-name for components
1612
-
1613
- `bit scope <sub-command>`
1614
-
1615
- ### scope set
1616
-
1617
- **Usage**: `scope set <scope-name> [component-pattern]`
1001
+ **Workspace only**: yes
1002
+ **Description**: shows the API schema of a certain component.
1618
1003
 
1619
- **Description**: Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace
1620
- default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.
1621
- a component is set with a scope (as oppose to default scope) only once it is versioned.'
1004
+ `bit schema <id>`
1622
1005
 
1623
- you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
1624
- use comma to separate patterns and '!' to exclude. e.g. 'ui/\*\*, !ui/button'
1625
- always wrap the pattern with single quotes to avoid collision with shell commands.
1626
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1627
-
1628
- | **Arg** | **Description** |
1629
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1630
- | `scope-name` | name of the scope to set |
1631
- | `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 |
1632
-
1633
- ### scope rename
1634
-
1635
- **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1636
-
1637
- **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
1638
- Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`
1639
- as the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file
1640
- as a result of this change
1641
-
1642
- | **Arg** | **Description** |
1643
- | -------------------- | :-------------------------------------------------: |
1644
- | `current-scope-name` | the scope name to be replaced by another scope name |
1645
- | `new-scope-name` | a new scope name to replace the current scope name |
1646
-
1647
- | **Option** | **Option alias** | **Description** |
1648
- | ------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
1649
- | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (i.e. with the new scope name) |
1650
-
1651
- ### scope rename-owner
1652
-
1653
- **Usage**: `scope rename-owner <current-owner-name> <new-owner-name>`
1654
-
1655
- **Description**: Renames the owner part of the scope-name for all components with the specified 'current owner name'
1656
-
1657
- | **Arg** | **Description** |
1658
- | -------------------- | :-------------------------------------------------: |
1659
- | `current-owner-name` | the owner name to be replaced by another owner name |
1660
- | `new-owner-name` | a new owner name to replace the current owner name |
1661
-
1662
- | **Option** | **Option alias** | **Description** |
1663
- | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1664
- | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new owner name) |
1665
- | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
1666
-
1667
- ### scope fork
1668
-
1669
- **Usage**: `scope fork <original-scope> <new-scope>`
1670
-
1671
- **Description**: fork all components of the original-scope and refactor the source-code to use the new scope name
1672
-
1673
- | **Option** | **Option alias** | **Description** |
1674
- | ---------- | :--------------: | --------------------------------------------------------- |
1675
- | `--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 |
1676
1009
 
1677
1010
  ---
1678
1011
 
1679
1012
  ## scope-config
1680
1013
 
1014
+ **Workspace only**: yes
1681
1015
  **Description**: scope config management
1682
1016
 
1683
1017
  `bit scope-config`
@@ -1708,206 +1042,146 @@ as a result of this change
1708
1042
 
1709
1043
  ---
1710
1044
 
1711
- ## server
1712
-
1713
- **Description**: EXPERIMENTAL. communicate with bit cli program via http requests
1714
-
1715
- `bit server`
1716
-
1717
- | **Option** | **Option alias** | **Description** |
1718
- | --------------- | :--------------: | ------------------------- |
1719
- | `--port [port]` | `-p` | port to run the server on |
1720
-
1721
- ---
1722
-
1723
1045
  ## show
1724
1046
 
1725
- **Description**: display the component's essential information
1726
-
1727
- `bit show <component-name>`
1047
+ **Workspace only**: yes
1048
+ **Description**: show a component
1728
1049
 
1729
- | **Arg** | **Description** |
1730
- | ---------------- | :----------------------------: |
1731
- | `component-name` | component name or component id |
1050
+ `bit show <id>`
1732
1051
 
1733
- | **Option** | **Option alias** | **Description** |
1734
- | ----------- | :--------------: | ------------------------------------------------------------------------------------------------ |
1735
- | `--json` | `-j` | return the component data in json format |
1736
- | `--legacy` | `-l` | use the legacy bit show. |
1737
- | `--remote` | `-r` | show data for a remote component |
1738
- | `--compare` | `-c` | legacy-only. compare current file system component to its latest tagged version [default=latest] |
1739
-
1740
- ---
1741
-
1742
- ## snap
1743
-
1744
- **Description**: create an immutable and exportable component snapshot (non-release version)
1745
-
1746
- `bit snap [component-pattern]`
1747
-
1748
- | **Arg** | **Description** |
1749
- | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1750
- | `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). |
1751
-
1752
- | **Option** | **Option alias** | **Description** |
1753
- | -------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1754
- | `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
1755
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
1756
- | `--unmerged` | | complete a merge process by snapping the unmerged components |
1757
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
1758
- | `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
1759
- | `--skip-tests` | | skip running component tests during snap process |
1760
- | `--skip-auto-snap` | | skip auto snapping dependents |
1761
- | `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
1762
- | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1763
- | `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
1764
- | `--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 "\*". |
1765
- | `--all` | `-a` | DEPRECATED (not needed anymore, now the default). snap all new and modified components |
1766
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
1767
- | `--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. |
1768
1058
 
1769
1059
  ---
1770
1060
 
1771
1061
  ## start
1772
1062
 
1773
1063
  **Alias**: `c`
1774
- **Description**: run the ui/development server
1775
-
1776
- `bit start [component-pattern]`
1064
+ **Workspace only**: yes
1065
+ **Description**: Start a dev environment for a workspace or a specific component
1777
1066
 
1778
- | **Arg** | **Description** |
1779
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1780
- | `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]`
1781
1068
 
1782
- | **Option** | **Option alias** | **Description** |
1783
- | ----------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
1784
- | `--dev` | `-d` | start UI server in dev mode. |
1785
- | `--port [port-number]` | `-p` | port of the UI server. |
1786
- | `--rebuild` | `-r` | rebuild the UI (useful e.g. when updating the workspace UI - can use the dev flag for HMR in this case) |
1787
- | `--skip-ui-build` | | skip building UI |
1788
- | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1789
- | `--no-browser` | `-n` | do not automatically open browser when ready |
1790
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1791
- | `--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 |
1792
1077
 
1793
1078
  ---
1794
1079
 
1795
1080
  ## status
1796
1081
 
1797
1082
  **Alias**: `s`
1798
- **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
1799
1086
 
1800
1087
  `bit status`
1801
1088
 
1802
- | **Option** | **Option alias** | **Description** |
1803
- | ----------- | :--------------: | --------------------------------------------------------------------------------------- |
1804
- | `--json` | `-j` | return a json version of the component |
1805
- | `--verbose` | | show extra data: full snap hashes for staged components, and divergence point for lanes |
1806
- | `--lanes` | `-l` | when on a lane, show updates from main and updates from forked lanes |
1807
- | `--strict` | | in case issues found, exit with code 1 |
1808
-
1809
- ---
1810
-
1811
- ## system
1812
-
1813
- **Description**: system operations
1814
-
1815
- `bit system <sub-command>`
1816
-
1817
- ### system log
1818
-
1819
- **Usage**: `system log`
1820
-
1821
- **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 |
1822
1093
 
1823
1094
  ---
1824
1095
 
1825
1096
  ## tag
1826
1097
 
1827
1098
  **Alias**: `t`
1828
- **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1829
- if no patterns are provided, it will tag all new and modified components.
1830
- 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
1831
-
1832
- `bit tag [component-patterns...]`
1833
-
1834
- | **Arg** | **Description** |
1835
- | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1836
- | `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. |
1837
-
1838
- | **Option** | **Option alias** | **Description** |
1839
- | ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1840
- | `--message <message>` | `-m` | a log message describing latest changes |
1841
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
1842
- | `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1843
- | `--ver <version>` | `-v` | tag with the given version |
1844
- | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1845
- | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1846
- | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1847
- | `--minor` | | syntactic sugar for "--increment minor" |
1848
- | `--major` | | syntactic sugar for "--increment major" |
1849
- | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1850
- | `--snapped` | | tag only components whose head is a snap (not a tag) |
1851
- | `--unmerged` | | complete a merge process by tagging the unmerged components |
1852
- | `--skip-tests` | | skip running component tests during tag process |
1853
- | `--skip-auto-tag` | | skip auto tagging dependents |
1854
- | `--soft` | | do not persist. only keep note of the changes to be made |
1855
- | `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
1856
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1857
- | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1858
- | `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
1859
- | `--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. |
1860
- | `--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 "\*". |
1861
- | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) |
1862
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
1863
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
1864
- | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1865
- | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the local scope |
1866
- | `--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 |
1867
- | `--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|
1868
1136
 
1869
1137
  ---
1870
1138
 
1871
1139
  ## templates
1872
1140
 
1873
- **Description**: list available templates for "bit create" and "bit new"
1874
- 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)
1875
1143
 
1876
1144
  `bit templates`
1877
1145
 
1878
- | **Option** | **Option alias** | **Description** |
1879
- | ---------------------- | :--------------: | ---------------------------------------- |
1880
- | `--show-all` | `-s` | show hidden templates |
1881
- | `--aspect <aspect-id>` | `-a` | show templates provided by the aspect-id |
1146
+ | **Option** | **Option alias** | **Description** |
1147
+ | ------------ | :--------------: | --------------------- |
1148
+ | `--show-all` | `-s` | show hidden templates |
1882
1149
 
1883
1150
  ---
1884
1151
 
1885
1152
  ## test
1886
1153
 
1887
1154
  **Alias**: `at`
1888
- **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]`
1889
1159
 
1890
- `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 |
1891
1169
 
1892
- | **Arg** | **Description** |
1893
- | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1894
- | `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
1895
1173
 
1896
- | **Option** | **Option alias** | **Description** |
1897
- | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1898
- | `--watch` | `-w` | start the tester in watch mode. |
1899
- | `--debug` | `-d` | start the tester in debug mode. |
1900
- | `--all` | `-a` | DEPRECATED. (use --unmodified) |
1901
- | `--unmodified` | `-u` | test all components, not only new and modified |
1902
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1903
- | `--coverage` | | show code coverage data |
1904
- | `--env <id>` | `-e` | test only components assigned the given env |
1905
- | `--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]`
1906
1179
 
1907
1180
  ---
1908
1181
 
1909
1182
  ## undeprecate
1910
1183
 
1184
+ **Workspace only**: no
1911
1185
  **Description**: undeprecate a deprecated component (local/remote)
1912
1186
 
1913
1187
  `bit undeprecate <id>`
@@ -1917,105 +1191,64 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1917
1191
  ## uninstall
1918
1192
 
1919
1193
  **Alias**: `un`
1194
+ **Workspace only**: yes
1920
1195
  **Description**: uninstall dependencies
1921
1196
 
1922
1197
  `bit uninstall [packages...]`
1923
1198
 
1924
1199
  ---
1925
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
+
1926
1218
  ## update
1927
1219
 
1928
1220
  **Alias**: `up`
1221
+ **Workspace only**: yes
1929
1222
  **Description**: update dependencies
1930
1223
 
1931
- `bit update [package-patterns...]`
1224
+ `bit update`
1932
1225
 
1933
- | **Arg** | **Description** |
1934
- | --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1935
- | `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. |
1936
-
1937
- | **Option** | **Option alias** | **Description** |
1938
- | ---------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1939
- | `--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 |
1940
- | `--patch` | | update to the latest patch version. Semver rules are ignored |
1941
- | `--minor` | | update to the latest minor version. Semver rules are ignored |
1942
- | `--major` | | update to the latest major version. Semver rules are ignored |
1226
+ | **Option** | **Option alias** | **Description** |
1227
+ | ---------- | :--------------: | ------------------------------------------ |
1228
+ | `--yes` | `-y` | automatically update all outdated packages |
1943
1229
 
1944
1230
  ---
1945
1231
 
1946
1232
  ## use
1947
1233
 
1948
- **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
1949
1236
 
1950
- `bit use <component-id>`
1951
-
1952
- | **Arg** | **Description** |
1953
- | -------------- | :----------------------------: |
1954
- | `component-id` | the component ID of the aspect |
1237
+ `bit use [ids...]`
1955
1238
 
1956
1239
  ---
1957
1240
 
1958
1241
  ## watch
1959
1242
 
1960
- **Description**: automatically recompile modified components (on save)
1961
- by default, the watcher doesn't use polling, to keep the CPU idle.
1962
- 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
1963
1245
 
1964
1246
  `bit watch`
1965
1247
 
1966
1248
  | **Option** | **Option alias** | **Description** |
1967
1249
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1968
- | `--verbose` | `-v` | show all watch events and compiler verbose output |
1969
- | `--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 |
1970
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 |
1971
1253
 
1972
1254
  ---
1973
-
1974
- ## ws-config
1975
-
1976
- **Alias**: `workspace-config`
1977
- **Description**: manage workspace config files
1978
-
1979
- `bit ws-config <sub-command>`
1980
-
1981
- ### ws-config write
1982
-
1983
- **Usage**: `ws-config write`
1984
-
1985
- **Description**: EXPERIMENTAL. write config files in the workspace. useful for IDEs
1986
-
1987
- | **Option** | **Option alias** | **Description** |
1988
- | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1989
- | `--clean` | `-c` | delete existing config files from the workspace. highly recommended to run it with "--dry-run" first |
1990
- | `--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 |
1991
- | `--silent` | `-s` | do not prompt for confirmation |
1992
- | `--no-dedupe` | | write configs inside each one of the component's dir, avoid deduping |
1993
- | `--dry-run` | | show the paths that configs will be written per env |
1994
- | `--dry-run-with-content` | | use with --json flag. show the config content and the paths that will be written per env |
1995
- | `--verbose` | `-v` | showing verbose output for writing |
1996
- | `--json` | `-j` | json format |
1997
-
1998
- ### ws-config clean
1999
-
2000
- **Usage**: `ws-config clean`
2001
-
2002
- **Description**: EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs
2003
-
2004
- | **Option** | **Option alias** | **Description** |
2005
- | --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
2006
- | `--silent` | `-s` | do not prompt for confirmation |
2007
- | `--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 |
2008
- | `--dry-run` | | show the paths of configs that will be cleaned |
2009
- | `--json` | `-j` | json format |
2010
-
2011
- ### ws-config list
2012
-
2013
- **Usage**: `ws-config list`
2014
-
2015
- **Description**: EXPERIMENTAL. list config writers
2016
-
2017
- | **Option** | **Option alias** | **Description** |
2018
- | ---------- | :--------------: | --------------- |
2019
- | `--json` | `-j` | json format |
2020
-
2021
- ---