@teambit/harmony.content.cli-reference 1.95.182 → 1.95.183

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 (12) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +51 -51
  3. package/cli-reference.mdx +255 -0
  4. package/dist/cli-reference.composition.d.ts +2 -2
  5. package/dist/cli-reference.docs.mdx +1 -1
  6. package/dist/cli-reference.json +51 -51
  7. package/dist/cli-reference.mdx.js +1883 -135
  8. package/dist/cli-reference.mdx.js.map +1 -1
  9. package/dist/{preview-1690082162569.js → preview-1690254961496.js} +2 -2
  10. package/package-tar/teambit-harmony.content.cli-reference-1.95.183.tgz +0 -0
  11. package/package.json +2 -2
  12. package/package-tar/teambit-harmony.content.cli-reference-1.95.182.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -61,6 +61,10 @@ Learn the recommended workflow for tracking directories as components, in the li
61
61
 
62
62
  **Description**: run an app (independent of bit's dev server)
63
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
+
64
68
  | **Option** | **Option alias** | **Description** |
65
69
  | ---------------------- | :--------------: | -------------------------------------------------------------------------- |
66
70
  | `--dev` | `-d` | start the application in dev mode. |
@@ -80,6 +84,10 @@ and a package.tgz file generated by pkg aspect.
80
84
 
81
85
  `bit artifacts <component-pattern>`
82
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 |
90
+
83
91
  | **Option** | **Option alias** | **Description** |
84
92
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
85
93
  | `--aspect <aspect-id>` | | show/download only artifacts generated by this aspect-id |
@@ -101,6 +109,10 @@ and a package.tgz file generated by pkg aspect.
101
109
 
102
110
  **Description**: list all aspects configured on component(s)
103
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 |
115
+
104
116
  | **Option** | **Option alias** | **Description** |
105
117
  | ---------- | :--------------: | ------------------------------------------------- |
106
118
  | `--debug` | `-d` | show the origins were the aspects were taken from |
@@ -111,6 +123,10 @@ and a package.tgz file generated by pkg aspect.
111
123
 
112
124
  **Description**: list the aspects set on a component, as well as their config and data
113
125
 
126
+ | **Arg** | **Description** |
127
+ | ---------------- | :--------------------------------: |
128
+ | `component-name` | the component name or component id |
129
+
114
130
  | **Option** | **Option alias** | **Description** |
115
131
  | ---------- | :--------------: | ------------------------------------------------- |
116
132
  | `--debug` | `-d` | show the origins were the aspects were taken from |
@@ -122,6 +138,12 @@ and a package.tgz file generated by pkg aspect.
122
138
 
123
139
  **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
124
140
 
141
+ | **Arg** | **Description** |
142
+ | ----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
143
+ | `pattern` | the components to extend. use 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
+
125
147
  | **Option** | **Option alias** | **Description** |
126
148
  | ---------- | :--------------: | ---------------------------------------------------------------------------- |
127
149
  | `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces the config) |
@@ -132,12 +154,22 @@ and a package.tgz file generated by pkg aspect.
132
154
 
133
155
  **Description**: unset an aspect from component(s).
134
156
 
157
+ | **Arg** | **Description** |
158
+ | ----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
159
+ | `pattern` | the components to target. use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". wrap the pattern with quotes |
160
+ | `aspect-id` | the aspect's component id |
161
+
135
162
  ### aspect update
136
163
 
137
164
  **Usage**: `aspect update <aspect-id> [pattern]`
138
165
 
139
166
  **Description**: update a version of an aspect
140
167
 
168
+ | **Arg** | **Description** |
169
+ | ----------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
170
+ | `aspect-id` | the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote |
171
+ | `pattern` | the components to update (defaults to all components). use component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". wrap the pattern with quotes |
172
+
141
173
  ---
142
174
 
143
175
  ## build
@@ -146,6 +178,10 @@ and a package.tgz file generated by pkg aspect.
146
178
 
147
179
  `bit build [component-pattern]`
148
180
 
181
+ | **Arg** | **Description** |
182
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
183
+ | `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 |
184
+
149
185
  | **Option** | **Option alias** | **Description** |
150
186
  | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
151
187
  | `--all` | `-a` | DEPRECATED. use --unmodified |
@@ -222,6 +258,10 @@ with no args, only workspace's capsules are deleted
222
258
 
223
259
  `bit check-types [component-pattern]`
224
260
 
261
+ | **Arg** | **Description** |
262
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
263
+ | `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 |
264
+
225
265
  | **Option** | **Option alias** | **Description** |
226
266
  | ---------- | :--------------: | --------------------------------------------------------- |
227
267
  | `--all` | `-a` | check-types for all components, not only modified and new |
@@ -241,6 +281,11 @@ with no args, only workspace's capsules are deleted
241
281
 
242
282
  `bit checkout <to> [component-pattern]`
243
283
 
284
+ | **Arg** | **Description** |
285
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
286
+ | `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
287
+ | `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 |
288
+
244
289
  | **Option** | **Option alias** | **Description** |
245
290
  | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------- |
246
291
  | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
@@ -299,6 +344,10 @@ The following gets removed by this command:
299
344
 
300
345
  `bit compile [component-names...]`
301
346
 
347
+ | **Arg** | **Description** |
348
+ | -------------------- | :---------------------------------------------------------------------: |
349
+ | `component-names...` | a list of component names or component IDs (defaults to all components) |
350
+
302
351
  | **Option** | **Option alias** | **Description** |
303
352
  | ------------------- | :--------------: | ------------------------------------------------------------- |
304
353
  | `--changed` | `-c` | compile only new and modified components |
@@ -355,6 +404,11 @@ https://bit.dev/docs/config/bit-config
355
404
 
356
405
  `bit create <template-name> <component-names...>`
357
406
 
407
+ | **Arg** | **Description** |
408
+ | -------------------- | :-----------------------------------------------------------------------------------------------: |
409
+ | `template-name` | the template for generating the component (run 'bit templates' for a list of available templates) |
410
+ | `component-names...` | a list of component names to generate |
411
+
358
412
  | **Option** | **Option alias** | **Description** |
359
413
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
360
414
  | `--namespace <string>` | `-n` | sets the component's namespace and nested dirs inside the scope |
@@ -381,6 +435,10 @@ https://bit.dev/docs/config/bit-config
381
435
 
382
436
  `bit deprecate <component-name>`
383
437
 
438
+ | **Arg** | **Description** |
439
+ | ---------------- | :----------------------------: |
440
+ | `component-name` | component name or component id |
441
+
384
442
  | **Option** | **Option alias** | **Description** |
385
443
  | ------------------- | :--------------: | ------------------------------------------------------------ |
386
444
  | `--new-id <string>` | | if replaced by another component, enter the new component id |
@@ -400,6 +458,10 @@ https://bit.dev/docs/config/bit-config
400
458
 
401
459
  **Description**: show direct and indirect dependencies of the given component
402
460
 
461
+ | **Arg** | **Description** |
462
+ | ---------------- | :----------------------------: |
463
+ | `component-name` | component name or component id |
464
+
403
465
  | **Option** | **Option alias** | **Description** |
404
466
  | ---------- | :--------------: | ---------------------------------------------------------------- |
405
467
  | `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
@@ -410,6 +472,11 @@ https://bit.dev/docs/config/bit-config
410
472
 
411
473
  **Description**: remove a dependency to component(s)
412
474
 
475
+ | **Arg** | **Description** |
476
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
477
+ | `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 |
478
+ | `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 |
479
+
413
480
  | **Option** | **Option alias** | **Description** |
414
481
  | ---------- | :--------------: | ---------------------------- |
415
482
  | `--dev` | `-d` | remove from devDependencies |
@@ -421,6 +488,11 @@ https://bit.dev/docs/config/bit-config
421
488
 
422
489
  **Description**: unset a dependency to component(s) that was previously set by "bit deps set"
423
490
 
491
+ | **Arg** | **Description** |
492
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
493
+ | `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 |
494
+ | `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 |
495
+
424
496
  | **Option** | **Option alias** | **Description** |
425
497
  | ---------- | :--------------: | --------------------------- |
426
498
  | `--dev` | `-d` | unset from devDependencies |
@@ -432,12 +504,21 @@ https://bit.dev/docs/config/bit-config
432
504
 
433
505
  **Description**: show the immediate dependencies and how their versions were determined
434
506
 
507
+ | **Arg** | **Description** |
508
+ | ---------------- | :----------------------------: |
509
+ | `component-name` | component name or component id |
510
+
435
511
  ### deps set
436
512
 
437
513
  **Usage**: `deps set <component-pattern> <package...>`
438
514
 
439
515
  **Description**: set a dependency to component(s)
440
516
 
517
+ | **Arg** | **Description** |
518
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
519
+ | `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 |
520
+ | `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
521
+
441
522
  | **Option** | **Option alias** | **Description** |
442
523
  | ---------- | :--------------: | --------------------------- |
443
524
  | `--dev` | `-d` | add to the devDependencies |
@@ -449,18 +530,30 @@ https://bit.dev/docs/config/bit-config
449
530
 
450
531
  **Description**: reset dependencies to the default values (revert any previously "bit deps set")
451
532
 
533
+ | **Arg** | **Description** |
534
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
535
+ | `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 |
536
+
452
537
  ### deps eject
453
538
 
454
539
  **Usage**: `deps eject <component-pattern>`
455
540
 
456
541
  **Description**: write dependencies that were previously set via "bit deps set" into .bitmap
457
542
 
543
+ | **Arg** | **Description** |
544
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
545
+ | `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 |
546
+
458
547
  ### deps blame
459
548
 
460
549
  **Usage**: `deps blame <component-name> <dependency-name>`
461
550
 
462
551
  **Description**: EXPERIMENTAL. find out which snap/tag changed a dependency version
463
552
 
553
+ | **Arg** | **Description** |
554
+ | ----------------- | :---------------------------------------------------------------------------: |
555
+ | `dependency-name` | package-name. for components, you can use either component-id or package-name |
556
+
464
557
  ---
465
558
 
466
559
  ## diff
@@ -503,6 +596,10 @@ you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the p
503
596
 
504
597
  `bit eject <component-pattern>`
505
598
 
599
+ | **Arg** | **Description** |
600
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
601
+ | `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 |
602
+
506
603
  | **Option** | **Option alias** | **Description** |
507
604
  | -------------- | :--------------: | --------------------------------------------------------------------------------- |
508
605
  | `--force` | `-f` | ignore local version. remove the components even when they are staged or modified |
@@ -547,6 +644,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
547
644
 
548
645
  **Description**: show information about a component's env
549
646
 
647
+ | **Arg** | **Description** |
648
+ | ---------------- | :-----------------------------------------------------------------------------------: |
649
+ | `component-name` | the 'component name' or 'component id' of the component its env you'd like to inspect |
650
+
550
651
  | **Option** | **Option alias** | **Description** |
551
652
  | --------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------ |
552
653
  | `--services <string>` | | show information about the specific services only. for multiple services, separate by a comma and wrap with quotes |
@@ -557,6 +658,11 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
557
658
 
558
659
  **Description**: Sets one or more components with a development environment (env)
559
660
 
661
+ | **Arg** | **Description** |
662
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
663
+ | `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 |
664
+ | `env` | the env's component id (include version for non-core envs. e.g, `teambit.community/envs/community-react@1.95.13`) |
665
+
560
666
  ### envs unset
561
667
 
562
668
  **Usage**: `envs unset <component-pattern>`
@@ -570,18 +676,32 @@ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
570
676
  always wrap the pattern with quotes to avoid collision with shell commands.
571
677
  use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
572
678
 
679
+ | **Arg** | **Description** |
680
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
681
+ | `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 |
682
+
573
683
  ### envs replace
574
684
 
575
685
  **Usage**: `envs replace <current-env> <new-env>`
576
686
 
577
687
  **Description**: replace an existing env with another env for all components using the old env
578
688
 
689
+ | **Arg** | **Description** |
690
+ | ------------- | :---------------------------------: |
691
+ | `current-env` | the component id of the current env |
692
+ | `new-env` | the component id of the new env |
693
+
579
694
  ### envs update
580
695
 
581
696
  **Usage**: `envs update [env-id] [pattern]`
582
697
 
583
698
  **Description**: update a version of an env for all components using that env
584
699
 
700
+ | **Arg** | **Description** |
701
+ | --------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
702
+ | `env-id` | the environment id (defaults to all envs). optionally, add a version (id@version), otherwise, it finds the latest version on the remote. |
703
+ | `pattern` | the components to update (defaults to all components). use 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 |
704
+
585
705
  ---
586
706
 
587
707
  ## export
@@ -594,6 +714,10 @@ bit export => export all staged components to their current scope, if checked ou
594
714
 
595
715
  `bit export [component-patterns...]`
596
716
 
717
+ | **Arg** | **Description** |
718
+ | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
719
+ | `component-patterns...` | component IDs, component names, or component patterns (separated by space). Use patterns to export groups of components using a common scope or namespace. E.g., "utils/\*" (wrap with double quotes) |
720
+
597
721
  | **Option** | **Option alias** | **Description** |
598
722
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
599
723
  | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
@@ -613,6 +737,11 @@ bit export => export all staged components to their current scope, if checked ou
613
737
 
614
738
  `bit fork <source-component-id> [target-component-name]`
615
739
 
740
+ | **Arg** | **Description** |
741
+ | ----------------------- | :-------------------------------------------------------------------------------------------------------------: |
742
+ | `source-component-id` | the component id of the source component |
743
+ | `target-component-name` | the name for the new component (component name without scope). to set a different scope, use the '--scope' flag |
744
+
616
745
  | **Option** | **Option alias** | **Description** |
617
746
  | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------- |
618
747
  | `--scope <string>` | `-s` | default scope for the new component |
@@ -711,6 +840,10 @@ bit export => export all staged components to their current scope, if checked ou
711
840
 
712
841
  `bit import [component-patterns...]`
713
842
 
843
+ | **Arg** | **Description** |
844
+ | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
845
+ | `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) |
846
+
714
847
  | **Option** | **Option alias** | **Description** |
715
848
  | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
716
849
  | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
@@ -765,6 +898,10 @@ when no package is specified, all workspace dependencies are installed and all w
765
898
 
766
899
  `bit install [packages...]`
767
900
 
901
+ | **Arg** | **Description** |
902
+ | ------------- | :-------------------------------------------------: |
903
+ | `packages...` | a list of packages to install (separated by spaces) |
904
+
768
905
  | **Option** | **Option alias** | **Description** |
769
906
  | --------------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
770
907
  | `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
@@ -808,6 +945,10 @@ when no package is specified, all workspace dependencies are installed and all w
808
945
 
809
946
  **Description**: switch to the specified lane
810
947
 
948
+ | **Arg** | **Description** |
949
+ | ------- | :-------------------------------------------------------: |
950
+ | `lane` | lane-name or lane-id (if not exists locally) to switch to |
951
+
811
952
  | **Option** | **Option alias** | **Description** |
812
953
  | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
813
954
  | `--alias <string>` | `-n` | relevant when the specified lane is a remote late. name a local lane differently than the remote lane |
@@ -836,6 +977,10 @@ when no package is specified, all workspace dependencies are installed and all w
836
977
  a lane created from main (default-lane) is empty until components are snapped.
837
978
  a lane created from another lane has all the components of the original lane.
838
979
 
980
+ | **Arg** | **Description** |
981
+ | ----------- | :-----------------------: |
982
+ | `lane-name` | the name for the new lane |
983
+
839
984
  | **Option** | **Option alias** | **Description** |
840
985
  | ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------- |
841
986
  | `--scope <scope-name>` | `-s` | remote scope where this lane will be exported to, default to the defaultScope (can be changed later with "bit lane change-scope") |
@@ -849,6 +994,10 @@ a lane created from another lane has all the components of the original lane.
849
994
 
850
995
  **Description**: remove lanes
851
996
 
997
+ | **Arg** | **Description** |
998
+ | ---------- | :---------------------------------------: |
999
+ | `lanes...` | A list of lane names, separated by spaces |
1000
+
852
1001
  | **Option** | **Option alias** | **Description** |
853
1002
  | ---------- | :--------------: | ----------------------------------------------------------------- |
854
1003
  | `--remote` | `-r` | remove a remote lane (in the lane arg, use remote/lane-id syntax) |
@@ -894,6 +1043,11 @@ bit lane diff from to => diff between "from" lane and "to" lane.
894
1043
 
895
1044
  **Description**: EXPERIMENTAL. adds a readme component to a lane
896
1045
 
1046
+ | **Arg** | **Description** |
1047
+ | -------------- | :-------------------------------------------------------------------: |
1048
+ | `component-id` | the component name or id of the component to use as the lane's readme |
1049
+ | `lane-name` | the lane to attach the readme to (defaults to the current lane) |
1050
+
897
1051
  ### lane remove-readme
898
1052
 
899
1053
  **Usage**: `lane remove-readme [laneName]`
@@ -906,6 +1060,10 @@ bit lane diff from to => diff between "from" lane and "to" lane.
906
1060
 
907
1061
  **Description**: import a remote lane to your workspace
908
1062
 
1063
+ | **Arg** | **Description** |
1064
+ | ------- | :------------------: |
1065
+ | `lane` | the remote lane name |
1066
+
909
1067
  | **Option** | **Option alias** | **Description** |
910
1068
  | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------- |
911
1069
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
@@ -921,6 +1079,10 @@ and then after snap+export, the remote-lane gets updated as well. upon lane-merg
921
1079
 
922
1080
  in case the components are not part of the lane or the lane is new, it simply removes the components from the workspace
923
1081
 
1082
+ | **Arg** | **Description** |
1083
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1084
+ | `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 |
1085
+
924
1086
  | **Option** | **Option alias** | **Description** |
925
1087
  | ------------------ | :--------------: | ----------------------------------------------------------------------------------- |
926
1088
  | `--workspace-only` | | do not mark the components as removed. instead, remove them from the workspace only |
@@ -937,6 +1099,11 @@ to merge the lane from the local scope without updating it first, use "--skip-fe
937
1099
  when the current and the other lanes are diverged in history and the files could be merged with no conflicts,
938
1100
  it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
939
1101
 
1102
+ | **Arg** | **Description** |
1103
+ | --------- | :-----------------------------------------------------------------------: |
1104
+ | `lane` | lane-name or lane-id (if not exists locally) to merge to the current lane |
1105
+ | `pattern` | partially merge the lane with the specified component-pattern |
1106
+
940
1107
  | **Option** | **Option alias** | **Description** |
941
1108
  | -------------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
942
1109
  | `--ours` | | in case of a conflict, override the used version with the current modification |
@@ -987,6 +1154,10 @@ also, checkout the workspace components according to the restored lane
987
1154
 
988
1155
  `bit link [component-names...]`
989
1156
 
1157
+ | **Arg** | **Description** |
1158
+ | -------------------- | :------------------------------------: |
1159
+ | `component-names...` | names or IDs of the components to link |
1160
+
990
1161
  | **Option** | **Option alias** | **Description** |
991
1162
  | ------------------------- | :--------------: | ------------------------------------------------------------------------------------------------ |
992
1163
  | `--json` | `-j` | return the output as JSON |
@@ -1036,6 +1207,10 @@ https://bit.dev/docs/reference/cli-reference#list
1036
1207
 
1037
1208
  `bit log <id>`
1038
1209
 
1210
+ | **Arg** | **Description** |
1211
+ | ------- | :----------------------------: |
1212
+ | `id` | component-id or component-name |
1213
+
1039
1214
  | **Option** | **Option alias** | **Description** |
1040
1215
  | ------------ | :--------------: | ------------------------------- |
1041
1216
  | `--remote` | `-r` | show log of a remote component |
@@ -1051,6 +1226,10 @@ https://bit.dev/docs/reference/cli-reference#list
1051
1226
 
1052
1227
  `bit log-file <filepath>`
1053
1228
 
1229
+ | **Arg** | **Description** |
1230
+ | ---------- | :---------------------------------: |
1231
+ | `filepath` | file path relative to the workspace |
1232
+
1054
1233
  | **Option** | **Option alias** | **Description** |
1055
1234
  | ------------ | :--------------: | ------------------------------- |
1056
1235
  | `--one-line` | `-o` | show each log entry in one line |
@@ -1116,6 +1295,10 @@ the modified are components that their source code have changed, it doesn't chec
1116
1295
 
1117
1296
  `bit mini-status [component-pattern]`
1118
1297
 
1298
+ | **Arg** | **Description** |
1299
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1300
+ | `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 |
1301
+
1119
1302
  | **Option** | **Option alias** | **Description** |
1120
1303
  | --------------- | :--------------: | ---------------------------------------------- |
1121
1304
  | `--show-issues` | | show component issues (slows down the command) |
@@ -1132,6 +1315,11 @@ move files or directories of component(s)
1132
1315
 
1133
1316
  `bit move <current-component-dir> <new-component-dir>`
1134
1317
 
1318
+ | **Arg** | **Description** |
1319
+ | ----------------------- | :---------------------------------------------------------------------: |
1320
+ | `current-component-dir` | the current relative path (in the workspace) to the component directory |
1321
+ | `new-component-dir` | the new relative path (in the workspace) to the component directory |
1322
+
1135
1323
  ---
1136
1324
 
1137
1325
  ## new
@@ -1140,6 +1328,11 @@ move files or directories of component(s)
1140
1328
 
1141
1329
  `bit new <template-name> <workspace-name>`
1142
1330
 
1331
+ | **Arg** | **Description** |
1332
+ | ---------------- | :--------------------------------------------------------------------------------------------------------------------: |
1333
+ | `template-name` | the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates) |
1334
+ | `workspace-name` | the name for the new workspace and workspace directory |
1335
+
1143
1336
  | **Option** | **Option alias** | **Description** |
1144
1337
  | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
1145
1338
  | `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
@@ -1247,6 +1440,10 @@ to remove components from lanes, use "bit lane remove-comp".
1247
1440
 
1248
1441
  `bit remove <component-pattern>`
1249
1442
 
1443
+ | **Arg** | **Description** |
1444
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1445
+ | `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 |
1446
+
1250
1447
  | **Option** | **Option alias** | **Description** |
1251
1448
  | -------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------- |
1252
1449
  | `--delete` | | mark the component as deleted. after tag/snap and export the remote will be updated |
@@ -1264,6 +1461,11 @@ to remove components from lanes, use "bit lane remove-comp".
1264
1461
 
1265
1462
  `bit rename <current-name> <new-name>`
1266
1463
 
1464
+ | **Arg** | **Description** |
1465
+ | -------------- | :-------------------------------------------------: |
1466
+ | `current-name` | the current component name (without its scope name) |
1467
+ | `new-name` | the new component name (without its scope name) |
1468
+
1267
1469
  | **Option** | **Option alias** | **Description** |
1268
1470
  | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------- |
1269
1471
  | `--scope <scope-name>` | `-s` | default scope for the newly created component |
@@ -1280,6 +1482,11 @@ https://bit.dev/docs/components/tags#undoing-a-tag
1280
1482
 
1281
1483
  `bit reset [component-pattern]`
1282
1484
 
1485
+ | **Arg** | **Description** |
1486
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1487
+ | `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 |
1488
+ | `component-version` | the version to untag (semver for tags. hash for snaps) |
1489
+
1283
1490
  | **Option** | **Option alias** | **Description** |
1284
1491
  | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
1285
1492
  | `--all` | `-a` | revert tag/snap for all tagged/snapped components |
@@ -1295,6 +1502,11 @@ https://bit.dev/docs/components/tags#undoing-a-tag
1295
1502
 
1296
1503
  `bit revert <component-pattern> <to>`
1297
1504
 
1505
+ | **Arg** | **Description** |
1506
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1507
+ | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button" wrap the pattern with quotes |
1508
+ | `to` | permitted values: [main, specific-version]. 'main' - head version on main. |
1509
+
1298
1510
  | **Option** | **Option alias** | **Description** |
1299
1511
  | -------------------------------- | :--------------: | -------------------------------------------------- |
1300
1512
  | `--verbose` | `-v` | showing verbose output for inspection |
@@ -1309,6 +1521,10 @@ https://bit.dev/docs/components/tags#undoing-a-tag
1309
1521
 
1310
1522
  `bit run <app-name>`
1311
1523
 
1524
+ | **Arg** | **Description** |
1525
+ | ---------- | :--------------------------------------------------------------------------------------------------: |
1526
+ | `app-name` | the app's name is registered by the app (run 'bit app list' to list the names of the available apps) |
1527
+
1312
1528
  | **Option** | **Option alias** | **Description** |
1313
1529
  | ---------------------- | :--------------: | -------------------------------------------------------------------------- |
1314
1530
  | `--dev` | `-d` | start the application in dev mode. |
@@ -1353,12 +1569,22 @@ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1353
1569
  always wrap the pattern with quotes to avoid collision with shell commands.
1354
1570
  use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1355
1571
 
1572
+ | **Arg** | **Description** |
1573
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1574
+ | `scope-name` | the scope name to use as the default scope |
1575
+ | `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 |
1576
+
1356
1577
  ### scope rename
1357
1578
 
1358
1579
  **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1359
1580
 
1360
1581
  **Description**: Renames the scope name for all components with the specified 'current scope name'
1361
1582
 
1583
+ | **Arg** | **Description** |
1584
+ | -------------------- | :-------------------------------------------------: |
1585
+ | `current-scope-name` | the scope name to be replaced by another scope name |
1586
+ | `new-scope-name` | a new scope name to replace the current scope name |
1587
+
1362
1588
  | **Option** | **Option alias** | **Description** |
1363
1589
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1364
1590
  | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new scope name) |
@@ -1369,6 +1595,11 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1369
1595
 
1370
1596
  **Description**: Renames the owner part of the scope-name for all components with the specified 'current owner name'
1371
1597
 
1598
+ | **Arg** | **Description** |
1599
+ | -------------------- | :-------------------------------------------------: |
1600
+ | `current-owner-name` | the owner name to be replaced by another owner name |
1601
+ | `new-owner-name` | a new owner name to replace the current owner name |
1602
+
1372
1603
  | **Option** | **Option alias** | **Description** |
1373
1604
  | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1374
1605
  | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new owner name) |
@@ -1431,6 +1662,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1431
1662
 
1432
1663
  `bit show <component-name>`
1433
1664
 
1665
+ | **Arg** | **Description** |
1666
+ | ---------------- | :----------------------------: |
1667
+ | `component-name` | component name or component id |
1668
+
1434
1669
  | **Option** | **Option alias** | **Description** |
1435
1670
  | ----------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
1436
1671
  | `--json` | `-j` | return the component data in a json format |
@@ -1446,6 +1681,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1446
1681
 
1447
1682
  `bit snap [component-pattern]`
1448
1683
 
1684
+ | **Arg** | **Description** |
1685
+ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1686
+ | `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, all new and modified components are snapped. |
1687
+
1449
1688
  | **Option** | **Option alias** | **Description** |
1450
1689
  | -------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1451
1690
  | `--message <message>` | `-m` | log message describing the latest changes |
@@ -1472,6 +1711,10 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1472
1711
 
1473
1712
  `bit start [component-pattern]`
1474
1713
 
1714
+ | **Arg** | **Description** |
1715
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1716
+ | `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 |
1717
+
1475
1718
  | **Option** | **Option alias** | **Description** |
1476
1719
  | ----------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1477
1720
  | `--dev` | `-d` | start UI server in dev mode. |
@@ -1524,6 +1767,10 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1524
1767
 
1525
1768
  `bit tag [component-patterns...]`
1526
1769
 
1770
+ | **Arg** | **Description** |
1771
+ | ----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1772
+ | `component-patterns...` | a list of component names, IDs or patterns (separated by space). run "bit pattern --help" to get more data about patterns. By default, all modified are tagged. |
1773
+
1527
1774
  | **Option** | **Option alias** | **Description** |
1528
1775
  | ---------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1529
1776
  | `--message <message>` | `-m` | a log message describing latest changes |
@@ -1578,6 +1825,10 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1578
1825
 
1579
1826
  `bit test [component-pattern]`
1580
1827
 
1828
+ | **Arg** | **Description** |
1829
+ | ------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1830
+ | `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 |
1831
+
1581
1832
  | **Option** | **Option alias** | **Description** |
1582
1833
  | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1583
1834
  | `--watch` | `-w` | start the tester in watch mode. |
@@ -1626,6 +1877,10 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1626
1877
 
1627
1878
  `bit use <component-id>`
1628
1879
 
1880
+ | **Arg** | **Description** |
1881
+ | -------------- | :----------------------------: |
1882
+ | `component-id` | the component ID of the aspect |
1883
+
1629
1884
  ---
1630
1885
 
1631
1886
  ## watch