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

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 +225 -113
  2. package/cli-reference.mdx +47 -77
  3. package/dist/cli-reference.json +225 -113
  4. package/dist/cli-reference.mdx.js +50 -166
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.34.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1655436530187.js → preview-1656041300679.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.31.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -12,15 +12,15 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
12
12
 
13
13
  `bit add [path...]`
14
14
 
15
- | **Option** | **Option alias** | **Description** |
16
- | ---------------------------------- | :--------------: | ---------------------------------------------------------------------------------------- |
17
- | `--id <name>` | `-i` | manually set component id |
18
- | `--main <file>` | `-m` | define entry point for the components |
19
- | `--tests <file>/"<file>,<file>"` | `-t` | specify test files to track. use quotation marks to list files or use a glob pattern |
20
- | `--namespace <namespace>` | `-n` | organize component in a namespace |
21
- | `--exclude <file>/"<file>,<file>"` | `-e` | exclude file from being tracked. use quotation marks to list files or use a glob pattern |
22
- | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
23
- | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
15
+ | **Option** | **Option alias** | **Description** |
16
+ | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
17
+ | `--id <name>` | `-i` | manually set component id |
18
+ | `--main <file>` | `-m` | define entry point for the components |
19
+ | `--tests <file>/"<file>,<file>"` | `-t` | LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern |
20
+ | `--namespace <namespace>` | `-n` | organize component in a namespace |
21
+ | `--exclude <file>/"<file>,<file>"` | `-e` | LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern |
22
+ | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
23
+ | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
24
24
 
25
25
  ---
26
26
 
@@ -73,11 +73,7 @@ and a package.tgz file generated by pkg aspect.
73
73
 
74
74
  **Usage**: `aspect list [pattern]`
75
75
 
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/**"`.
78
- use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
79
- always wrap the pattern with quotes to avoid collision with shell commands.
80
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
76
+ **Description**: list all aspects configured on component(s)
81
77
 
82
78
  | **Option** | **Option alias** | **Description** |
83
79
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -85,9 +81,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
85
81
 
86
82
  ### aspect get
87
83
 
88
- **Usage**: `aspect get <component-id>`
84
+ **Usage**: `aspect get <component-name>`
89
85
 
90
- **Description**: show aspects' data and configuration of the given component
86
+ **Description**: list the aspects set on a component, as well as their config and data
91
87
 
92
88
  | **Option** | **Option alias** | **Description** |
93
89
  | ---------- | :--------------: | ------------------------------------------------- |
@@ -98,38 +94,19 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
98
94
 
99
95
  **Usage**: `aspect set <pattern> <aspect-id> [config]`
100
96
 
101
- **Description**: set an aspect to component(s) with optional config.
102
- enter the config as stringified JSON (e.g. '{"foo":"bar"}' ).
103
- if no config entered, the aspect will be set with empty config ({}).
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"
106
- always wrap the pattern with quotes to avoid collision with shell commands.
107
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
97
+ **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
108
98
 
109
99
  ### aspect unset
110
100
 
111
101
  **Usage**: `aspect unset <pattern> <aspect-id>`
112
102
 
113
- **Description**: unset an aspect from component(s).
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"
116
- always wrap the pattern with quotes to avoid collision with shell commands.
117
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
103
+ **Description**: unset an aspect from component(s).
118
104
 
119
105
  ### aspect update
120
106
 
121
107
  **Usage**: `aspect update <aspect-id> [pattern]`
122
108
 
123
- **Description**: update a version of an aspect
124
- default to all components using the aspect, unless "pattern" is provided.
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"
127
- always wrap the pattern with quotes to avoid collision with shell commands.
128
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
129
-
130
- examples:
131
- "bit aspect update scope.org/aspect '**/ui/**'" - update "ui" components that use scope.org/aspect to the latest version
132
- "bit aspect update scope.org/aspect@2.0.0" - updates all components using scope.org/aspect to version 2.0.0.
109
+ **Description**: update a version of an aspect
133
110
 
134
111
  ---
135
112
 
@@ -157,7 +134,7 @@ examples:
157
134
 
158
135
  **Workspace only**: yes
159
136
  **Description**: manage capsules
160
- a capsule is a directory contains the component code, isolated from the workspace.
137
+ a capsule is a directory containing the component code, isolated from the workspace.
161
138
  normally, capsules are created during the build process, the component files are copied and the packages are installed
162
139
  via the configured package-manager. the purpose is to compile/test them in isolation to make sure they will work for
163
140
  other users after publishing/exporting them.
@@ -168,7 +145,7 @@ other users after publishing/exporting them.
168
145
 
169
146
  **Usage**: `capsule list`
170
147
 
171
- **Description**: list all capsules
148
+ **Description**: list the capsules generated for this workspace
172
149
 
173
150
  | **Option** | **Option alias** | **Description** |
174
151
  | ---------- | :--------------: | --------------- |
@@ -176,9 +153,9 @@ other users after publishing/exporting them.
176
153
 
177
154
  ### capsule create
178
155
 
179
- **Usage**: `capsule create [componentIds...]`
156
+ **Usage**: `capsule create [component-id...]`
180
157
 
181
- **Description**: create capsules
158
+ **Description**: create capsules for components
182
159
 
183
160
  | **Option** | **Option alias** | **Description** |
184
161
  | -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------- |
@@ -388,6 +365,7 @@ https://bit.dev/docs/config/bit-config
388
365
 
389
366
  | **Option** | **Option alias** | **Description** |
390
367
  | ---------- | :--------------: | -------------------------------------------------------------------- |
368
+ | `--tree` | `-t` | render dependencies as a tree, similar to "npm ls" |
391
369
  | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
392
370
 
393
371
  ---
@@ -418,7 +396,7 @@ https://bit.dev/docs/config/bit-config
418
396
  ## diff
419
397
 
420
398
  **Workspace only**: yes
421
- **Description**: show diff between components files
399
+ **Description**: show the diff between the components' source files and config
422
400
  bit diff => compare all modified components to their model version
423
401
  bit diff [ids...] => compare the specified components against their modified states
424
402
  bit diff [id] [version] => compare the specified version to used or modified files
@@ -453,13 +431,9 @@ bit diff => compare all modified components to their model version
453
431
 
454
432
  **Alias**: `E`
455
433
  **Workspace only**: yes
456
- **Description**: replaces the components from the local scope with the corresponding packages
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"
459
- always wrap the pattern with quotes to avoid collision with shell commands.
460
- use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.
434
+ **Description**: replace components maintained in the workspace with their corresponding packages
461
435
 
462
- `bit eject <pattern>`
436
+ `bit eject <component-pattern>`
463
437
 
464
438
  | **Option** | **Option alias** | **Description** |
465
439
  | -------------- | :--------------: | --------------------------------------------------------------------------------- |
@@ -556,7 +530,7 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
556
530
  | `--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 |
557
531
  | `--force` | `-f` | force changing a component remote without asking for a confirmation |
558
532
  | `--all-versions` | | export not only staged versions but all of them |
559
- | `--origin-directly` | | HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
533
+ | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
560
534
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
561
535
  | `--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 |
562
536
  | `--json` | `-j` | show output in json format |
@@ -708,10 +682,10 @@ when no package is specified, all workspace dependencies are installed and all w
708
682
  ## link
709
683
 
710
684
  **Workspace only**: yes
711
- **Description**: link components and core aspects
685
+ **Description**: create links in the node_modules directory, to core aspects and to components in the workspace
712
686
  https://bit.dev/docs/workspace/component-links
713
687
 
714
- `bit link [ids...]`
688
+ `bit link [component-names...]`
715
689
 
716
690
  | **Option** | **Option alias** | **Description** |
717
691
  | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
@@ -752,8 +726,6 @@ https://bit.dev/docs/reference/cli-reference#list
752
726
  | ---------------------- | :--------------: | ------------------------------------------------------------------------------- |
753
727
  | `--ids` | `-i` | show only component ids unformatted |
754
728
  | `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
755
- | `--bare` | `-b` | DEPRECATED. use --raw instead |
756
- | `--raw` | `-r` | show raw output (only components ids, no styling) |
757
729
  | `--outdated` | `-o` | show latest versions from remotes |
758
730
  | `--json` | `-j` | show the output in JSON format |
759
731
  | `--namespace <string>` | `-n` | show only specified namespace by using wildcards |
@@ -779,7 +751,7 @@ https://bit.dev/docs/reference/cli-reference#log
779
751
  ## login
780
752
 
781
753
  **Workspace only**: no
782
- **Description**: log the CLI into Bit Cloud
754
+ **Description**: log in to Bit cloud
783
755
 
784
756
  `bit login`
785
757
 
@@ -789,7 +761,7 @@ https://bit.dev/docs/reference/cli-reference#log
789
761
  | `--suppress-browser-launch` | | do not open a browser for authentication |
790
762
  | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
791
763
  | `--skip-registry-config` | | don't configure bit.cloud registry |
792
- | `--machine-name <string>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
764
+ | `--machine-name <name>` | | specify machine-name to pair with the token (useful for CI to avoid accidentally revoke the token) |
793
765
 
794
766
  ---
795
767
 
@@ -834,11 +806,11 @@ merge changes of different component versions
834
806
  move files or directories of component(s)
835
807
  https://bit.dev/docs/workspace/moving-components
836
808
 
837
- `bit move <existing-dir> <new-dir>`
809
+ `bit move <current-component-dir> <new-component-dir>`
838
810
 
839
- | **Option** | **Option alias** | **Description** |
840
- | ------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
841
- | `--component` | `-c` | move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
811
+ | **Option** | **Option alias** | **Description** |
812
+ | ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
813
+ | `--component` | `-c` | LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
842
814
 
843
815
  ---
844
816
 
@@ -953,16 +925,16 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
953
925
 
954
926
  **Alias**: `rm`
955
927
  **Workspace only**: no
956
- **Description**: remove component(s) from your workspace, or a remote scope
928
+ **Description**: remove component(s) from the workspace, or a remote scope
957
929
  https://bit.dev/docs/components/removing-components
958
930
  you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
959
931
 
960
- `bit remove <ids...>`
932
+ `bit remove <component-ids...>`
961
933
 
962
934
  | **Option** | **Option alias** | **Description** |
963
935
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
964
936
  | `--remote` | `-r` | remove a component from a remote scope |
965
- | `--track` | `-t` | keep tracking component (default = false) |
937
+ | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
966
938
  | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
967
939
  | `--keep-files` | | keep component files (just untrack the component) |
968
940
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
@@ -973,17 +945,15 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
973
945
  ## rename
974
946
 
975
947
  **Workspace only**: no
976
- **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component
977
- the `<target-name>` should include the component-name only, without the scope-name.
978
- to assign a default-scope to this component, please use "--scope" flag
948
+ **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component
979
949
 
980
- `bit rename <source-name> <target-name>`
950
+ `bit rename <current-name> <new-name>`
981
951
 
982
- | **Option** | **Option alias** | **Description** |
983
- | ------------------ | :--------------: | --------------------------------------------------------------------------------------- |
984
- | `--scope <string>` | `-s` | default scope for the newly created component |
985
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
986
- | `--refactor` | `-r` | change the source code of all components using this component with the new package-name |
952
+ | **Option** | **Option alias** | **Description** |
953
+ | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------- |
954
+ | `--scope <scope-name>` | `-s` | default scope for the newly created component |
955
+ | `--path <relative-path>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
956
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
987
957
 
988
958
  ---
989
959
 
@@ -1149,7 +1119,7 @@ if no patterns are provided, it will tag all new and modified components.
1149
1119
  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
1120
  https://bit.dev/components/tags
1151
1121
 
1152
- `bit tag [patterns...]`
1122
+ `bit tag [component-patterns...]`
1153
1123
 
1154
1124
  | **Option** | **Option alias** | **Description** |
1155
1125
  | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -1250,11 +1220,11 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1250
1220
  ## untag
1251
1221
 
1252
1222
  **Workspace only**: yes
1253
- **Description**: revert versions tagged for component(s)
1223
+ **Description**: revert tagged or snapped versions for component(s)
1254
1224
  https://bit.dev/docs/components/tags#undoing-a-tag
1255
1225
  you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1256
1226
 
1257
- `bit untag [id] [version]`
1227
+ `bit untag [component-name] [component-version]`
1258
1228
 
1259
1229
  | **Option** | **Option alias** | **Description** |
1260
1230
  | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
@@ -1290,13 +1260,13 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1290
1260
  ## watch
1291
1261
 
1292
1262
  **Workspace only**: yes
1293
- **Description**: watch a set of components
1263
+ **Description**: automatically recompile modified components (on save)
1294
1264
 
1295
1265
  `bit watch`
1296
1266
 
1297
1267
  | **Option** | **Option alias** | **Description** |
1298
1268
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1299
- | `--verbose` | `-v` | showing npm verbose output for inspection and prints stack trace |
1269
+ | `--verbose` | `-v` | show npm verbose output for inspection and print the stack trace |
1300
1270
  | `--skip-pre-compilation` | | skip the compilation step before starting to watch |
1301
1271
  | `--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 |
1302
1272