Intro to Bit

Welcome to the Bit documentation. Start your journey here to leverage Bit for reusing your work. Below you will learn to create and release your first component.

Get started

Run the following to install Bit:

$npx @teambit/bvm install
Copiedcopy

Initialize Bit on a new folder or in an existing project by running the following command:

$bit
Copiedcopy

Make sure to create your scope on the Bit platform and use the right org and project name. After running the command, Bit is initialized on the chosen directory, and ready to be used via Bit commands, your editor or the Bit UI!

Create components

After initiatizing your workspace, you can start creating components. Run the following command to generate a component from one of our default templates:

$bit
Copiedcopy

The following command uses the React UI component template to create a new reusable React component:

$bit
Copiedcopy

You can find simple guides for creating NodeJS modules, UI components and apps, backend services and more on our create components page. Run the Bit UI to preview components using the following command:

$bit
Copiedcopy

Use bit run to preview applications during development. To start creating apps follow this guide.

Release components

Authenticate with the Bit platform:

$bit
Copiedcopy

Use semantic versioning to version your components:

$bit
Copiedcopy

You can run tag and export from your CI of choice to automate the release process or use our official CI scripts. After versioning, you can proceed to release your components:

$bit
Copiedcopy

Congrats! 🎉 Your first components are now released! You can now view your components, ready to be used on the Bit platform.

Start using these components all across your projects:

$npm install @my-org/my-project.hello-world
Copiedcopy

Get started

Use your tech of choice

What's next