@teambit/harmony.content.cli-reference 1.95.32 → 1.95.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/cli-reference.json +185 -58
  2. package/cli-reference.mdx +49 -77
  3. package/dist/cli-reference.json +185 -58
  4. package/dist/cli-reference.mdx.js +57 -141
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.35.tgz +0 -0
  7. package/package.json +2 -2
  8. package/preview-1656339215962.js +5 -0
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.32.tgz +0 -0
  10. package/preview-1655522887639.js +0 -2
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
 
@@ -51,7 +51,7 @@ artifacts are created on isolated capsules during tag or snap commands.
51
51
  example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
52
52
  and a package.tgz file generated by pkg aspect.
53
53
 
54
- `bit artifacts <pattern...>`
54
+ `bit artifacts <component-pattern>`
55
55
 
56
56
  | **Option** | **Option alias** | **Description** |
57
57
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
@@ -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
  | ------------------------- | :--------------: | -------------------------------------------------------------------------------------------------------------- |
@@ -777,7 +751,7 @@ https://bit.dev/docs/reference/cli-reference#log
777
751
  ## login
778
752
 
779
753
  **Workspace only**: no
780
- **Description**: log the CLI into Bit Cloud
754
+ **Description**: log in to Bit cloud
781
755
 
782
756
  `bit login`
783
757
 
@@ -787,7 +761,7 @@ https://bit.dev/docs/reference/cli-reference#log
787
761
  | `--suppress-browser-launch` | | do not open a browser for authentication |
788
762
  | `--npmrc-path <path>` | | path to npmrc file to configure bit.cloud registry |
789
763
  | `--skip-registry-config` | | don't configure bit.cloud registry |
790
- | `--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) |
791
765
 
792
766
  ---
793
767
 
@@ -832,11 +806,11 @@ merge changes of different component versions
832
806
  move files or directories of component(s)
833
807
  https://bit.dev/docs/workspace/moving-components
834
808
 
835
- `bit move <existing-dir> <new-dir>`
809
+ `bit move <current-component-dir> <new-component-dir>`
836
810
 
837
- | **Option** | **Option alias** | **Description** |
838
- | ------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
839
- | `--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>` |
840
814
 
841
815
  ---
842
816
 
@@ -951,16 +925,16 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
951
925
 
952
926
  **Alias**: `rm`
953
927
  **Workspace only**: no
954
- **Description**: remove component(s) from your workspace, or a remote scope
928
+ **Description**: remove component(s) from the workspace, or a remote scope
955
929
  https://bit.dev/docs/components/removing-components
956
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)
957
931
 
958
- `bit remove <ids...>`
932
+ `bit remove <component-ids...>`
959
933
 
960
934
  | **Option** | **Option alias** | **Description** |
961
935
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
962
936
  | `--remote` | `-r` | remove a component from a remote scope |
963
- | `--track` | `-t` | keep tracking component (default = false) |
937
+ | `--track` | `-t` | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new |
964
938
  | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
965
939
  | `--keep-files` | | keep component files (just untrack the component) |
966
940
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
@@ -971,17 +945,15 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
971
945
  ## rename
972
946
 
973
947
  **Workspace only**: no
974
- **Description**: EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the source-component
975
- the `<target-name>` should include the component-name only, without the scope-name.
976
- 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
977
949
 
978
- `bit rename <source-name> <target-name>`
950
+ `bit rename <current-name> <new-name>`
979
951
 
980
- | **Option** | **Option alias** | **Description** |
981
- | ------------------ | :--------------: | --------------------------------------------------------------------------------------- |
982
- | `--scope <string>` | `-s` | default scope for the newly created component |
983
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
984
- | `--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) |
985
957
 
986
958
  ---
987
959
 
@@ -1147,7 +1119,7 @@ if no patterns are provided, it will tag all new and modified components.
1147
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
1148
1120
  https://bit.dev/components/tags
1149
1121
 
1150
- `bit tag [patterns...]`
1122
+ `bit tag [component-patterns...]`
1151
1123
 
1152
1124
  | **Option** | **Option alias** | **Description** |
1153
1125
  | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -1160,8 +1132,8 @@ https://bit.dev/components/tags
1160
1132
  | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1161
1133
  | `--minor` | | syntactic sugar for "--increment minor" |
1162
1134
  | `--major` | | syntactic sugar for "--increment major" |
1135
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1163
1136
  | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1164
- | `--pre-release [identifier]` | | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead |
1165
1137
  | `--skip-tests` | | skip running component tests during tag process |
1166
1138
  | `--skip-auto-tag` | | skip auto tagging dependents |
1167
1139
  | `--soft` | | do not persist. only keep note of the changes to be made |
@@ -1248,11 +1220,11 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1248
1220
  ## untag
1249
1221
 
1250
1222
  **Workspace only**: yes
1251
- **Description**: revert versions tagged for component(s)
1223
+ **Description**: revert tagged or snapped versions for component(s)
1252
1224
  https://bit.dev/docs/components/tags#undoing-a-tag
1253
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)
1254
1226
 
1255
- `bit untag [id] [version]`
1227
+ `bit untag [component-name] [component-version]`
1256
1228
 
1257
1229
  | **Option** | **Option alias** | **Description** |
1258
1230
  | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
@@ -1288,13 +1260,13 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1288
1260
  ## watch
1289
1261
 
1290
1262
  **Workspace only**: yes
1291
- **Description**: watch a set of components
1263
+ **Description**: automatically recompile modified components (on save)
1292
1264
 
1293
1265
  `bit watch`
1294
1266
 
1295
1267
  | **Option** | **Option alias** | **Description** |
1296
1268
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
1297
- | `--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 |
1298
1270
  | `--skip-pre-compilation` | | skip the compilation step before starting to watch |
1299
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 |
1300
1272