@teambit/harmony.content.cli-reference 1.95.28 → 1.95.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/cli-reference.json +307 -124
  2. package/cli-reference.mdx +160 -148
  3. package/dist/cli-reference.json +307 -124
  4. package/dist/cli-reference.mdx.js +202 -125
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.31.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1654918011878.js → preview-1655436530187.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.28.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -27,7 +27,7 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
27
27
  ## app
28
28
 
29
29
  **Workspace only**: yes
30
- **Description**: manage applications
30
+ **Description**: Manages apps
31
31
 
32
32
  `bit app <sub-command>`
33
33
 
@@ -35,7 +35,7 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
35
35
 
36
36
  **Usage**: `app list`
37
37
 
38
- **Description**: list all registered applications
38
+ **Description**: list all registered apps
39
39
 
40
40
  | **Option** | **Option alias** | **Description** |
41
41
  | ---------- | :--------------: | ---------------------------------------- |
@@ -74,9 +74,10 @@ and a package.tgz file generated by pkg aspect.
74
74
  **Usage**: `aspect list [pattern]`
75
75
 
76
76
  **Description**: list all aspects configured on component(s)
77
- 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"
77
+ you can use a `<pattern>` for multiple component ids, such as `bit aspect list "org.scope/utils/**"`.
78
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
78
79
  always wrap the pattern with quotes to avoid collision with shell commands.
79
- to validate the pattern before running this command, run `bit pattern <pattern>`.
80
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
80
81
 
81
82
  | **Option** | **Option alias** | **Description** |
82
83
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -100,18 +101,20 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
100
101
  **Description**: set an aspect to component(s) with optional config.
101
102
  enter the config as stringified JSON (e.g. '{"foo":"bar"}' ).
102
103
  if no config entered, the aspect will be set with empty config ({}).
103
- 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"
104
+ you can use a `<pattern>` for multiple component ids, such as `bit aspect set "org.scope/utils/**"`.
105
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
104
106
  always wrap the pattern with quotes to avoid collision with shell commands.
105
- to validate the pattern before running this command, run `bit pattern <pattern>`.
107
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
106
108
 
107
109
  ### aspect unset
108
110
 
109
111
  **Usage**: `aspect unset <pattern> <aspect-id>`
110
112
 
111
113
  **Description**: unset an aspect from component(s).
112
- 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"
114
+ you can use a `<pattern>` for multiple component ids, such as `bit aspect unset "org.scope/utils/**"`.
115
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
113
116
  always wrap the pattern with quotes to avoid collision with shell commands.
114
- to validate the pattern before running this command, run `bit pattern <pattern>`.
117
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
115
118
 
116
119
  ### aspect update
117
120
 
@@ -119,9 +122,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
119
122
 
120
123
  **Description**: update a version of an aspect
121
124
  default to all components using the aspect, unless "pattern" is provided.
122
- 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"
125
+ you can use a `<pattern>` for multiple component ids, such as `bit aspect update <aspect-id> "org.scope/utils/**"`.
126
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
123
127
  always wrap the pattern with quotes to avoid collision with shell commands.
124
- to validate the pattern before running this command, run `bit pattern <pattern>`.
128
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
125
129
 
126
130
  examples:
127
131
  "bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version
@@ -134,7 +138,7 @@ examples:
134
138
  **Workspace only**: yes
135
139
  **Description**: run set of tasks for build
136
140
 
137
- `bit build [pattern]`
141
+ `bit build [component-pattern]`
138
142
 
139
143
  | **Option** | **Option alias** | **Description** |
140
144
  | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
@@ -206,7 +210,7 @@ with no args, only workspace's capsules are deleted
206
210
  **Workspace only**: yes
207
211
  **Description**: check typescript types
208
212
 
209
- `bit check-types [pattern]`
213
+ `bit check-types [component-pattern]`
210
214
 
211
215
  | **Option** | **Option alias** | **Description** |
212
216
  | ---------- | :--------------: | --------------------------------------------------------- |
@@ -289,9 +293,9 @@ The following gets removed by this command:
289
293
  ## compile
290
294
 
291
295
  **Workspace only**: yes
292
- **Description**: compile components in the development workspace
296
+ **Description**: compile components in the workspace
293
297
 
294
- `bit compile [component...]`
298
+ `bit compile [component-names...]`
295
299
 
296
300
  | **Option** | **Option alias** | **Description** |
297
301
  | ------------------- | :--------------: | ------------------------------------------------------------- |
@@ -361,9 +365,9 @@ https://bit.dev/docs/config/bit-config
361
365
  ## create
362
366
 
363
367
  **Workspace only**: yes
364
- **Description**: create a new component from a template
368
+ **Description**: create a new component (source files and config) using a template.
365
369
 
366
- `bit create <templateName> <componentNames...>`
370
+ `bit create <template-name> <component-names...>`
367
371
 
368
372
  | **Option** | **Option alias** | **Description** |
369
373
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
@@ -450,9 +454,10 @@ bit diff => compare all modified components to their model version
450
454
  **Alias**: `E`
451
455
  **Workspace only**: yes
452
456
  **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"
457
+ you can use a `<pattern>` for multiple component ids, such as `bit eject "org.scope/utils/**"`.
458
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
454
459
  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>`.
460
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
456
461
 
457
462
  `bit eject <pattern>`
458
463
 
@@ -468,9 +473,10 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
468
473
 
469
474
  **Workspace only**: yes
470
475
  **Description**: eject components configuration (create a `component.json` file)
471
- you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
476
+ you can use a `<pattern>` for multiple component ids, such as `bit eject-conf "org.scope/utils/**"`.
477
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
472
478
  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>`.
479
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
474
480
 
475
481
  `bit eject-conf <pattern>`
476
482
 
@@ -485,7 +491,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
485
491
 
486
492
  **Alias**: `env`
487
493
  **Workspace only**: yes
488
- **Description**: list all components envs
494
+ **Description**: list all components maintained by the workspace and their corresponding envs
489
495
 
490
496
  `bit envs`
491
497
 
@@ -497,34 +503,32 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
497
503
 
498
504
  ### envs get
499
505
 
500
- **Usage**: `envs get <name>`
506
+ **Usage**: `envs get <component-name>`
501
507
 
502
- **Description**: show component's env details
508
+ **Description**: show information about a component's env
503
509
 
504
510
  ### envs set
505
511
 
506
- **Usage**: `envs set <pattern> <env>`
512
+ **Usage**: `envs set <component-pattern> <env>`
507
513
 
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>`.
514
+ **Description**: Sets one or more components with a development environment (env)
512
515
 
513
516
  ### envs unset
514
517
 
515
- **Usage**: `envs unset <pattern>`
518
+ **Usage**: `envs unset <component-pattern>`
516
519
 
517
- **Description**: unset an environment from component(s) that was set by "bit env set"
520
+ **Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
518
521
  keep in mind that this doesn't remove envs that are set in the variants.
519
522
  in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
520
523
  the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
521
- 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"
524
+ you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`.
525
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
522
526
  always wrap the pattern with quotes to avoid collision with shell commands.
523
- to validate the pattern before running this command, run `bit pattern <pattern>`.
527
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
524
528
 
525
529
  ### envs replace
526
530
 
527
- **Usage**: `envs replace <old-env> <new-env>`
531
+ **Usage**: `envs replace <current-env> <new-env>`
528
532
 
529
533
  **Description**: replace an existing env with another env for all components using the old env
530
534
 
@@ -534,19 +538,19 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
534
538
 
535
539
  **Alias**: `e`
536
540
  **Workspace only**: yes
537
- **Description**: Export components to a remote scope
541
+ **Description**: export components from the workspace to remote scopes
538
542
  bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well
539
543
  `bit export [id...]` => export the given ids to their current scope
540
544
 
541
545
  https://bit.dev/docs/components/exporting-components
542
546
  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)
543
547
 
544
- `bit export [remote] [id...]`
548
+ `bit export [remote] [component-names...]`
545
549
 
546
550
  | **Option** | **Option alias** | **Description** |
547
551
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
548
- | `--eject` | `-e` | replaces the exported components from the local scope with the corresponding packages |
549
- | `--all` | `-a` | export all components include non-staged |
552
+ | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
553
+ | `--all` | `-a` | export all components, including non-staged |
550
554
  | `--include-dependencies` | `-d` | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope |
551
555
  | `--set-current-scope` | `-s` | LEGACY ONLY. ensure the component's remote scope is set according to the target location |
552
556
  | `--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 |
@@ -562,17 +566,15 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
562
566
  ## fork
563
567
 
564
568
  **Workspace only**: no
565
- **Description**: EXPERIMENTAL. create a new component out of an existing one
566
- note that [target-name] is the name only without the scope.
567
- to set the default-scope, please use --scope flag
569
+ **Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
568
570
 
569
- `bit fork <source-id> [target-name]`
571
+ `bit fork <source-component-id> [target-component-name]`
570
572
 
571
- | **Option** | **Option alias** | **Description** |
572
- | ------------------ | :--------------: | ----------------------------------------------------------------------------------------------- |
573
- | `--scope <string>` | `-s` | default scope for the newly created component |
574
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
575
- | `--refactor` | `-r` | change the source code of all components using the original component with the new package-name |
573
+ | **Option** | **Option alias** | **Description** |
574
+ | ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------- |
575
+ | `--scope <string>` | `-s` | default scope for the new component |
576
+ | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
577
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
576
578
 
577
579
  ---
578
580
 
@@ -633,28 +635,28 @@ to set the default-scope, please use --scope flag
633
635
  ## import
634
636
 
635
637
  **Workspace only**: yes
636
- **Description**: import components into your workspace
638
+ **Description**: import components from remote scopes to the local workspace
637
639
  https://bit.dev/docs/components/importing-components
638
640
  you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
639
641
 
640
- `bit import [ids...]`
642
+ `bit import [component-ids...]`
641
643
 
642
- | **Option** | **Option alias** | **Description** |
643
- | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
644
- | `--path <path>` | `-p` | import components into a specific directory |
645
- | `--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 |
646
- | `--display-dependencies` | `-d` | display the imported dependencies |
647
- | `--override` | `-O` | override local changes |
648
- | `--verbose` | `-v` | showing verbose output for inspection |
649
- | `--json` | `-j` | return the output as JSON |
650
- | `--conf` | | write the configuration file (component.json) of the component (harmony components only) |
651
- | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
652
- | `--skip-dependency-installation` | | do not install packages of the imported components |
653
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
654
- | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
655
- | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
656
- | `--save-in-lane` | | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
657
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
644
+ | **Option** | **Option alias** | **Description** |
645
+ | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
646
+ | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
647
+ | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument |
648
+ | `--display-dependencies` | `-d` | display the imported dependencies |
649
+ | `--override` | `-O` | override local changes |
650
+ | `--verbose` | `-v` | show verbose output for inspection |
651
+ | `--json` | `-j` | return the output as JSON |
652
+ | `--conf` | | write the configuration file (component.json) of the component |
653
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
654
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
655
+ | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
656
+ | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
657
+ | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
658
+ | `--save-in-lane` | | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
659
+ | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
658
660
 
659
661
  ---
660
662
 
@@ -686,7 +688,8 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
686
688
 
687
689
  **Alias**: `in`
688
690
  **Workspace only**: yes
689
- **Description**: install development workspace dependencies
691
+ **Description**: installs workspace dependencies
692
+ when no package is specified, all workspace dependencies are installed and all workspace components are imported.
690
693
 
691
694
  `bit install [packages...]`
692
695
 
@@ -769,6 +772,7 @@ https://bit.dev/docs/reference/cli-reference#log
769
772
  | ----------- | :--------------: | ----------------------------------------- |
770
773
  | `--remote` | `-r` | show log of a remote component |
771
774
  | `--parents` | | EXPERIMENTAL. show parents and lanes data |
775
+ | `--json` | `-j` | json format |
772
776
 
773
777
  ---
774
778
 
@@ -841,18 +845,18 @@ move files or directories of component(s)
841
845
  ## new
842
846
 
843
847
  **Workspace only**: yes
844
- **Description**: Create a new workspace from a template
848
+ **Description**: create a new workspace from a template
845
849
 
846
- `bit new <templateName> <workspaceName>`
850
+ `bit new <template-name> <workspace-name>`
847
851
 
848
- | **Option** | **Option alias** | **Description** |
849
- | -------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
850
- | `--aspect <string>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
851
- | `--default-scope <string>` | `-d` | set defaultScope in the new workspace.jsonc |
852
- | `--standalone` | | DEPRECATED. use --skip-git instead |
853
- | `--skip-git` | `-s` | skip generation of Git repository |
854
- | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
855
- | `--load-from <string>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
852
+ | **Option** | **Option alias** | **Description** |
853
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
854
+ | `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
855
+ | `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc |
856
+ | `--standalone` | | DEPRECATED. use --skip-git instead |
857
+ | `--skip-git` | `-s` | skip generation of Git repository |
858
+ | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
859
+ | `--load-from <path-to-template>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
856
860
 
857
861
  ---
858
862
 
@@ -876,7 +880,14 @@ move files or directories of component(s)
876
880
  ## pattern
877
881
 
878
882
  **Workspace only**: yes
879
- **Description**: list the component ids matching the given pattern
883
+ **Description**: list the component ids matching the given pattern
884
+ this command helps validating a pattern before using it in other commands.
885
+ a pattern can be a simple component-id or component-name. e.g. "ui/button".
886
+ a pattern can be used with wildcards for multiple component ids, e.g. "org.scope/utils/**".
887
+ to enter multiple patterns, separate them by a comma, e.g. "ui/_, lib/_"
888
+ to exclude, use "!". e.g. "ui/**, !ui/button"
889
+ always wrap the pattern with quotes to avoid collision with shell commands.
890
+ the matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)
880
891
 
881
892
  `bit pattern <pattern>`
882
893
 
@@ -980,9 +991,9 @@ to assign a default-scope to this component, please use "--scope" flag
980
991
 
981
992
  **Alias**: `c`
982
993
  **Workspace only**: yes
983
- **Description**: run an application
994
+ **Description**: run an app (independent of bit's dev server)
984
995
 
985
- `bit run <app>`
996
+ `bit run <app-name>`
986
997
 
987
998
  | **Option** | **Option alias** | **Description** |
988
999
  | -------------- | :--------------: | -------------------------------------------------------------------------- |
@@ -996,9 +1007,10 @@ to assign a default-scope to this component, please use "--scope" flag
996
1007
 
997
1008
  **Workspace only**: yes
998
1009
  **Description**: shows the API schema of a certain component.
999
- you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1010
+ you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`.
1011
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1000
1012
  always wrap the pattern with quotes to avoid collision with shell commands.
1001
- to validate the pattern before running this command, run `bit pattern <pattern>`.
1013
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1002
1014
 
1003
1015
  `bit schema <pattern>`
1004
1016
 
@@ -1011,27 +1023,27 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1011
1023
  ## scope
1012
1024
 
1013
1025
  **Workspace only**: yes
1014
- **Description**: EXPERIMENTAL. manage scope-name
1026
+ **Description**: EXPERIMENTAL. manage the scope-name for components
1015
1027
 
1016
1028
  `bit scope <sub-command>`
1017
1029
 
1018
1030
  ### scope set
1019
1031
 
1020
- **Usage**: `scope set <scope-name> [pattern]`
1032
+ **Usage**: `scope set <scope-name> [component-pattern]`
1021
1033
 
1022
- **Description**: set the default-scope
1023
- set a new scope in the workspace.jsonc.
1024
- if "pattern" is provided, the default-scope will be set to the new components matching the criteria.
1034
+ **Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope
1035
+ default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'
1025
1036
 
1026
- you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1037
+ you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`.
1038
+ use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1027
1039
  always wrap the pattern with quotes to avoid collision with shell commands.
1028
- to validate the pattern before running this command, run `bit pattern <pattern>`.
1040
+ use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
1029
1041
 
1030
1042
  ### scope rename
1031
1043
 
1032
- **Usage**: `scope rename <old-name> <new-name>`
1044
+ **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1033
1045
 
1034
- **Description**: rename a scope for components using the old-name, optionally change the dependencies source-code
1046
+ **Description**: Renames the scope name for all components with the specified 'current scope name'
1035
1047
 
1036
1048
  | **Option** | **Option alias** | **Description** |
1037
1049
  | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
@@ -1081,16 +1093,16 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1081
1093
  ## show
1082
1094
 
1083
1095
  **Workspace only**: yes
1084
- **Description**: show a component
1096
+ **Description**: display the component's essential information
1085
1097
 
1086
- `bit show <id>`
1098
+ `bit show <component-name>`
1087
1099
 
1088
- | **Option** | **Option alias** | **Description** |
1089
- | ----------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
1090
- | `--json` | `-j` | return the component data in json format |
1091
- | `--legacy` | `-l` | use the legacy bit show. |
1092
- | `--remote` | `-r` | show a remote component |
1093
- | `--compare` | `-c` | compare current file system component to latest tagged component [default=latest]. only works in legacy. |
1100
+ | **Option** | **Option alias** | **Description** |
1101
+ | ----------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
1102
+ | `--json` | `-j` | return the component data in a json format |
1103
+ | `--legacy` | `-l` | use the legacy bit show. |
1104
+ | `--remote` | `-r` | show a remote component |
1105
+ | `--compare` | `-c` | compare current file system component to the latest tagged component [default=latest]. only works in legacy. |
1094
1106
 
1095
1107
  ---
1096
1108
 
@@ -1098,18 +1110,18 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1098
1110
 
1099
1111
  **Alias**: `c`
1100
1112
  **Workspace only**: yes
1101
- **Description**: Start a dev environment for a workspace or a specific component
1113
+ **Description**: run the ui/development server
1102
1114
 
1103
1115
  `bit start [type] [pattern]`
1104
1116
 
1105
- | **Option** | **Option alias** | **Description** |
1106
- | -------------------- | :--------------: | ------------------------------------------------------------ |
1107
- | `--dev` | `-d` | start UI server in dev mode. |
1108
- | `--port [number]` | `-p` | port of the UI server. |
1109
- | `--rebuild` | `-r` | rebuild the UI |
1110
- | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
1111
- | `--no-browser` | | do not automatically open browser when ready |
1112
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1117
+ | **Option** | **Option alias** | **Description** |
1118
+ | ---------------------- | :--------------: | --------------------------------------------------------- |
1119
+ | `--dev` | `-d` | start UI server in dev mode. |
1120
+ | `--port [port-number]` | `-p` | port of the UI server. |
1121
+ | `--rebuild` | `-r` | rebuild the UI |
1122
+ | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1123
+ | `--no-browser` | | do not automatically open browser when ready |
1124
+ | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1113
1125
 
1114
1126
  ---
1115
1127
 
@@ -1117,8 +1129,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1117
1129
 
1118
1130
  **Alias**: `s`
1119
1131
  **Workspace only**: yes
1120
- **Description**: show the working area component(s) status
1121
- https://bit.dev/docs/workspace/workspace-status
1132
+ **Description**: present the current status of components in the workspace, and notifies when issues are detected
1122
1133
 
1123
1134
  `bit status`
1124
1135
 
@@ -1133,33 +1144,34 @@ https://bit.dev/docs/workspace/workspace-status
1133
1144
 
1134
1145
  **Alias**: `t`
1135
1146
  **Workspace only**: yes
1136
- **Description**: record component changes and lock versions
1137
- if no ids are provided, it will tag all new and modified components.
1138
- 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
1139
- https://bit.dev/components/tags
1140
- you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1141
-
1142
- `bit tag [id...]`
1143
-
1144
- | **Option** | **Option alias** | **Description** |
1145
- | ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
1146
- | `--message <message>` | `-m` | log message describing the user changes |
1147
- | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1148
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim |
1149
- | `--ver <version>` | `-v` | tag with the given version |
1150
- | `--patch` | `-p` | increment the patch version number |
1151
- | `--minor` | | increment the minor version number |
1152
- | `--major` | | increment the major version number |
1153
- | `--snapped` | | tag components that their head is a snap (not a tag) |
1154
- | `--pre-release [identifier]` | | EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1) |
1155
- | `--skip-tests` | | skip running component tests during tag process |
1156
- | `--skip-auto-tag` | | skip auto tagging dependents |
1157
- | `--soft` | | do not persist. only keep note of the changes to be made |
1158
- | `--persist` | | persist the changes generated by --soft tag |
1159
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1160
- | `--force-deploy` | | run the tag pipeline although the build failed |
1161
- | `--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. |
1162
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1147
+ **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1148
+ if no patterns are provided, it will tag all new and modified components.
1149
+ 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
1150
+ https://bit.dev/components/tags
1151
+
1152
+ `bit tag [patterns...]`
1153
+
1154
+ | **Option** | **Option alias** | **Description** |
1155
+ | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
1156
+ | `--message <message>` | `-m` | a log message describing latest changes |
1157
+ | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1158
+ | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1159
+ | `--ver <version>` | `-v` | tag with the given version |
1160
+ | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1161
+ | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1162
+ | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1163
+ | `--minor` | | syntactic sugar for "--increment minor" |
1164
+ | `--major` | | syntactic sugar for "--increment major" |
1165
+ | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1166
+ | `--pre-release [identifier]` | | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead |
1167
+ | `--skip-tests` | | skip running component tests during tag process |
1168
+ | `--skip-auto-tag` | | skip auto tagging dependents |
1169
+ | `--soft` | | do not persist. only keep note of the changes to be made |
1170
+ | `--persist` | | persist the changes generated by --soft tag |
1171
+ | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1172
+ | `--force-deploy` | | run the tag pipeline although the build failed |
1173
+ | `--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. |
1174
+ | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1163
1175
 
1164
1176
  [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1165
1177
  to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
@@ -1190,19 +1202,19 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1190
1202
 
1191
1203
  **Alias**: `at`
1192
1204
  **Workspace only**: yes
1193
- **Description**: test set of components in your workspace
1205
+ **Description**: test components in the workspace
1194
1206
 
1195
- `bit test [pattern]`
1207
+ `bit test [component-pattern]`
1196
1208
 
1197
- | **Option** | **Option alias** | **Description** |
1198
- | -------------------- | :--------------: | -------------------------------------------------------------------- |
1199
- | `--watch` | `-w` | start the tester in watch mode. |
1200
- | `--debug` | `-d` | start the tester in debug mode. |
1201
- | `--all` | `-a` | test all components, not only new and modified |
1202
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1203
- | `--coverage` | | show code coverage data |
1204
- | `--env <id>` | `-e` | test only the given env |
1205
- | `--scope <scope>` | `-s` | name of the scope to test |
1209
+ | **Option** | **Option alias** | **Description** |
1210
+ | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1211
+ | `--watch` | `-w` | start the tester in watch mode. |
1212
+ | `--debug` | `-d` | start the tester in debug mode. |
1213
+ | `--all` | `-a` | test all components, not only new and modified |
1214
+ | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1215
+ | `--coverage` | | show code coverage data |
1216
+ | `--env <id>` | `-e` | test only the given env |
1217
+ | `--scope <scope-name>` | `-s` | DEPRECATED. (use the pattern instead, e.g. "scopeName/\*\*"). name of the scope to test |
1206
1218
 
1207
1219
  ---
1208
1220
 
@@ -1269,9 +1281,9 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1269
1281
  ## use
1270
1282
 
1271
1283
  **Workspace only**: yes
1272
- **Description**: set up aspects in the workspace/scope config
1284
+ **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1273
1285
 
1274
- `bit use [ids...]`
1286
+ `bit use [component-ids...]`
1275
1287
 
1276
1288
  ---
1277
1289