@teambit/harmony.content.cli-reference 1.95.75 → 1.95.76

package/cli-reference.json

@@ -1571,6 +1571,226 @@
       }
     ]
   },
+  {
+    "name": "create <template-name> <component-names...>",
+    "alias": "",
+    "options": [
+      [
+        "n",
+        "namespace <string>",
+        "sets the component's namespace and nested dirs inside the scope"
+      ],
+      [
+        "s",
+        "scope <string>",
+        "sets the component's scope-name. if not entered, the default-scope will be used"
+      ],
+      [
+        "a",
+        "aspect <string>",
+        "aspect-id of the template. helpful when multiple aspects use the same template name"
+      ],
+      [
+        "p",
+        "path <string>",
+        "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
+      ],
+      [
+        "e",
+        "env <string>",
+        "set the component's environment. (overrides the env from variants and the template)"
+      ]
+    ],
+    "description": "create a new component (source files and config) using a template.",
+    "extendedDescription": "",
+    "group": "development",
+    "private": false,
+    "arguments": [
+      {
+        "name": "template-name",
+        "description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
+      },
+      {
+        "name": "component-names...",
+        "description": "a list of component names to generate"
+      }
+    ],
+    "examples": [
+      {
+        "cmd": "bit create react ui/button",
+        "description": "creates a component named 'ui/button' using the 'react' template"
+      },
+      {
+        "cmd": "bit create react ui/button pages/register",
+        "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
+      },
+      {
+        "cmd": "bit create react ui/button --scope my-org.my-scope",
+        "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
+      },
+      {
+        "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
+        "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
+      }
+    ]
+  },
+  {
+    "name": "templates",
+    "alias": "",
+    "options": [
+      [
+        "s",
+        "show-all",
+        "show hidden templates"
+      ]
+    ],
+    "description": "list templates for \"bit create\" and \"bit new\"",
+    "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
+    "group": "development",
+    "private": false
+  },
+  {
+    "name": "new <template-name> <workspace-name>",
+    "alias": "",
+    "options": [
+      [
+        "a",
+        "aspect <aspect-id>",
+        "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
+      ],
+      [
+        "d",
+        "default-scope <scope-name>",
+        "set defaultScope in the new workspace.jsonc"
+      ],
+      [
+        "",
+        "standalone",
+        "DEPRECATED. use --skip-git instead"
+      ],
+      [
+        "s",
+        "skip-git",
+        "skip generation of Git repository"
+      ],
+      [
+        "e",
+        "empty",
+        "empty workspace with no components (relevant for templates that add components by default)"
+      ],
+      [
+        "",
+        "load-from <path-to-template>",
+        "path to the workspace containing the template. helpful during a development of a workspace-template"
+      ]
+    ],
+    "description": "create a new workspace from a template",
+    "extendedDescription": "",
+    "group": "start",
+    "private": false,
+    "arguments": [
+      {
+        "name": "template-name",
+        "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
+      },
+      {
+        "name": "workspace-name",
+        "description": "the name for the new workspace and workspace directory"
+      }
+    ]
+  },
+  {
+    "name": "build [component-pattern]",
+    "alias": "",
+    "options": [
+      [
+        "a",
+        "all",
+        "build all components, not only modified and new"
+      ],
+      [
+        "d",
+        "dev",
+        "run the pipeline in dev mode"
+      ],
+      [
+        "",
+        "install",
+        "install core aspects in capsules"
+      ],
+      [
+        "",
+        "reuse-capsules",
+        "avoid deleting the capsules root-dir before starting the build"
+      ],
+      [
+        "",
+        "tasks <string>",
+        "build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
+      ],
+      [
+        "",
+        "cache-packages-on-capsule-root",
+        "set the package-manager cache on the capsule root"
+      ],
+      [
+        "",
+        "list-tasks <string>",
+        "list tasks of an env or a component-id for each one of the pipelines: build, tag and snap"
+      ],
+      [
+        "",
+        "skip-tests",
+        "skip running component tests during tag process"
+      ]
+    ],
+    "description": "run set of tasks for build",
+    "extendedDescription": "",
+    "group": "development",
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+      }
+    ]
+  },
+  {
+    "name": "artifacts <component-pattern>",
+    "alias": "",
+    "options": [
+      [
+        "",
+        "aspect <aspect-id>",
+        "show/download only artifacts generated by this aspect-id"
+      ],
+      [
+        "",
+        "task <task-id>",
+        "show/download only artifacts generated by this task-id"
+      ],
+      [
+        "",
+        "files <glob>",
+        "show/download only artifacts matching the given files or the glob pattern (wrap glob patterns in quotes)"
+      ],
+      [
+        "",
+        "out-dir <string>",
+        "download the files to the specified dir"
+      ]
+    ],
+    "description": "EXPERIMENTAL. list and download components artifacts",
+    "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
+    "group": "development",
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+      }
+    ]
+  },
   {
     "name": "insights [names...]",
     "alias": "",
@@ -1841,34 +2061,125 @@
       ],
       [
         "",
-        "head",
-        "revert the head tag/snap only (by default, all local tags/snaps are reverted)"
+        "head",
+        "revert the head tag/snap only (by default, all local tags/snaps are reverted)"
+      ],
+      [
+        "",
+        "soft",
+        "revert only soft-tags (components tagged with --soft flag)"
+      ],
+      [
+        "f",
+        "force",
+        "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
+      ]
+    ],
+    "description": "revert tagged or snapped versions for component(s)",
+    "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
+    "group": "development",
+    "private": false,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
+      },
+      {
+        "name": "component-version",
+        "description": "the version to untag (semver for tags. hash for snaps)"
+      }
+    ]
+  },
+  {
+    "name": "_tag <component-id...>",
+    "alias": "",
+    "options": [
+      [
+        "",
+        "push",
+        "export the updated objects to the original scopes once done"
+      ],
+      [
+        "m",
+        "message <message>",
+        "a log message describing latest changes"
+      ],
+      [
+        "v",
+        "ver <version>",
+        "tag with the given version"
+      ],
+      [
+        "l",
+        "increment <level>",
+        "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
+      ],
+      [
+        "",
+        "prerelease-id <id>",
+        "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
+      ],
+      [
+        "p",
+        "patch",
+        "syntactic sugar for \"--increment patch\""
+      ],
+      [
+        "",
+        "minor",
+        "syntactic sugar for \"--increment minor\""
+      ],
+      [
+        "",
+        "major",
+        "syntactic sugar for \"--increment major\""
+      ],
+      [
+        "",
+        "pre-release [identifier]",
+        "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
+      ],
+      [
+        "",
+        "skip-tests",
+        "skip running component tests during tag process"
+      ],
+      [
+        "",
+        "disable-tag-pipeline",
+        "skip the tag pipeline to avoid publishing the components"
+      ],
+      [
+        "",
+        "force-deploy",
+        "run the tag pipeline although the build failed"
       ],
       [
         "",
-        "soft",
-        "revert only soft-tags (components tagged with --soft flag)"
+        "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."
       ],
       [
-        "f",
-        "force",
-        "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
+        "i",
+        "ignore-issues [issues]",
+        "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
+      ],
+      [
+        "I",
+        "ignore-newest-version",
+        "ignore existing of newer versions (default = false)"
+      ],
+      [
+        "b",
+        "build",
+        "EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag"
       ]
     ],
-    "description": "revert tagged or snapped versions for component(s)",
-    "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
+    "description": "create an immutable and exportable component snapshot, tagged with a release version.",
+    "extendedDescription": "you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major",
     "group": "development",
-    "private": false,
-    "arguments": [
-      {
-        "name": "component-pattern",
-        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
-      },
-      {
-        "name": "component-version",
-        "description": "the version to untag (semver for tags. hash for snaps)"
-      }
-    ]
+    "private": true,
+    "remoteOp": true
   },
   {
     "name": "merge [values...]",
@@ -2524,221 +2835,6 @@
     "remoteOp": true,
     "skipWorkspace": true
   },
-  {
-    "name": "create <template-name> <component-names...>",
-    "alias": "",
-    "options": [
-      [
-        "n",
-        "namespace <string>",
-        "sets the component's namespace and nested dirs inside the scope"
-      ],
-      [
-        "s",
-        "scope <string>",
-        "sets the component's scope-name. if not entered, the default-scope will be used"
-      ],
-      [
-        "a",
-        "aspect <string>",
-        "aspect-id of the template. helpful when multiple aspects use the same template name"
-      ],
-      [
-        "p",
-        "path <string>",
-        "relative path in the workspace. by default the path is `<scope>/<namespace>/<name>`"
-      ],
-      [
-        "e",
-        "env <string>",
-        "set the component's environment. (overrides the env from variants and the template)"
-      ]
-    ],
-    "description": "create a new component (source files and config) using a template.",
-    "extendedDescription": "",
-    "group": "development",
-    "private": false,
-    "arguments": [
-      {
-        "name": "template-name",
-        "description": "the template for generating the component \n(run 'bit templates' for a list of available templates)"
-      },
-      {
-        "name": "component-names...",
-        "description": "a list of component names to generate"
-      }
-    ],
-    "examples": [
-      {
-        "cmd": "bit create react ui/button",
-        "description": "creates a component named 'ui/button' using the 'react' template"
-      },
-      {
-        "cmd": "bit create react ui/button pages/register",
-        "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
-      },
-      {
-        "cmd": "bit create react ui/button --scope my-org.my-scope",
-        "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
-      },
-      {
-        "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
-        "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
-      }
-    ]
-  },
-  {
-    "name": "templates",
-    "alias": "",
-    "options": [
-      [
-        "s",
-        "show-all",
-        "show hidden templates"
-      ]
-    ],
-    "description": "list templates for \"bit create\" and \"bit new\"",
-    "extendedDescription": "list components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new)",
-    "group": "development",
-    "private": false
-  },
-  {
-    "name": "new <template-name> <workspace-name>",
-    "alias": "",
-    "options": [
-      [
-        "a",
-        "aspect <aspect-id>",
-        "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
-      ],
-      [
-        "d",
-        "default-scope <scope-name>",
-        "set defaultScope in the new workspace.jsonc"
-      ],
-      [
-        "",
-        "standalone",
-        "DEPRECATED. use --skip-git instead"
-      ],
-      [
-        "s",
-        "skip-git",
-        "skip generation of Git repository"
-      ],
-      [
-        "e",
-        "empty",
-        "empty workspace with no components (relevant for templates that add components by default)"
-      ],
-      [
-        "",
-        "load-from <path-to-template>",
-        "path to the workspace containing the template. helpful during a development of a workspace-template"
-      ]
-    ],
-    "description": "create a new workspace from a template",
-    "extendedDescription": "",
-    "group": "start",
-    "private": false,
-    "arguments": [
-      {
-        "name": "template-name",
-        "description": "the name of the workspace template (run 'bit templates', outside of a workspace, to get a list of available templates)"
-      },
-      {
-        "name": "workspace-name",
-        "description": "the name for the new workspace and workspace directory"
-      }
-    ]
-  },
-  {
-    "name": "build [component-pattern]",
-    "alias": "",
-    "options": [
-      [
-        "a",
-        "all",
-        "build all components, not only modified and new"
-      ],
-      [
-        "d",
-        "dev",
-        "run the pipeline in dev mode"
-      ],
-      [
-        "",
-        "install",
-        "install core aspects in capsules"
-      ],
-      [
-        "",
-        "reuse-capsules",
-        "avoid deleting the capsules root-dir before starting the build"
-      ],
-      [
-        "",
-        "tasks <string>",
-        "build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
-      ],
-      [
-        "",
-        "cache-packages-on-capsule-root",
-        "set the package-manager cache on the capsule root"
-      ],
-      [
-        "",
-        "list-tasks <string>",
-        "list tasks of an env or a component-id for each one of the pipelines: build, tag and snap"
-      ]
-    ],
-    "description": "run set of tasks for build",
-    "extendedDescription": "",
-    "group": "development",
-    "private": false,
-    "arguments": [
-      {
-        "name": "component-pattern",
-        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
-      }
-    ]
-  },
-  {
-    "name": "artifacts <component-pattern>",
-    "alias": "",
-    "options": [
-      [
-        "",
-        "aspect <aspect-id>",
-        "show/download only artifacts generated by this aspect-id"
-      ],
-      [
-        "",
-        "task <task-id>",
-        "show/download only artifacts generated by this task-id"
-      ],
-      [
-        "",
-        "files <glob>",
-        "show/download only artifacts matching the given files or the glob pattern (wrap glob patterns in quotes)"
-      ],
-      [
-        "",
-        "out-dir <string>",
-        "download the files to the specified dir"
-      ]
-    ],
-    "description": "EXPERIMENTAL. list and download components artifacts",
-    "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
-    "group": "development",
-    "private": false,
-    "arguments": [
-      {
-        "name": "component-pattern",
-        "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
-      }
-    ]
-  },
   {
     "name": "pack <componentId> [scopePath]",
     "alias": "",

package/cli-reference.mdx

@@ -142,6 +142,7 @@ and a package.tgz file generated by pkg aspect.
 | specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
 | `--cache-packages-on-capsule-root`                                                                          |                  | set the package-manager cache on the capsule root                                               |
 | `--list-tasks <string>`                                                                                     |                  | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap       |
+| `--skip-tests`                                                                                              |                  | skip running component tests during tag process                                                 |
 
 ---