Create a Workspace starter

A workspace starter is a template for Bit workspaces. It allows you to quickly set up a new workspace with pre-defined workspace configuration and (optionally) a few new or imported components.

Choose the 'standalone' option to create a workspace starter that uses a starter plugin and does not require an env to run. Choose the 'env-dependent' option to create a workspace starter that is registered by an env (and requires an env to run).

Env-dependent starter
Standalone starter

A standalone starter is uses a plugin file with the .starter.ts extension to load as a starter.

To create a standalone starter, execute the following command in an existing workspace:

$bit
Copiedcopy

The standalone starter should look like this:

Standalone Starter
template
files
template/files/git-ignore.ts
git-ignore.ts
template/files/workspace-config.ts
workspace-config.ts
index.ts
index.ts
my-starter.docs.mdx
my-starter.docs.mdx
my-starter.starter.ts
my-starter.starter.ts

Using the starter

Plugin-based starters are run independent of an env. To use your starter, follow these steps:

  1. Export the starter to a remote scope (to test a starter locally, see the next section.)
  2. In your terminal, run the command to create a new workspace using the env.

Testing the starter

To test a starter registered by an env that is available in the remote scope (the env and the starter have been exported) see run workspace starters.

To test a starter locally, while developing it set it up and run the following command with template name, the env that registers this template and the path to the workspace maintaining them:

$bit
Copiedcopy