bit README

The project's README from github.com/teambit/bit. As one markdown file: README.md.

Website | Docs | Community | Bit Cloud

apache prs Circle Status Styled with Prettier Join Discord

Bit is the build system to connect components and apps from development to CI in the AI era. Bit organizes source code into composable components, empowering to build reliable, scalable and consistent applications. It enables AI agents to intelligenly create and reuse components via MCP preventing duplication and accelerating development.

⚡ Features

Bit supports all tooling in the JS ecosystem and comes out of the box with official dev environments for NodeJS, React, Angular, Vue, React Native, NextJS and far more. All are native to TypeScript and ESM and equipped with the best dev tooling.

Bit is a fit to every codebase structure. You can use Bit components in a monorepo, polyrepo, or even without repositories at all.

Getting started

Install Bit

Use the Bit installer to install Bit to be available on your PATH.

npx @teambit/bvm install

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

bit init --default-scope my-org.my-project

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, AI agent, your editor or the Bit UI!

Create shell application

Create the application shell to run, compose and deploy your application:

bit create react-app corporate-website

Run the platform:

bit run corporate-website

Head to http://localhost:3000 to view your application shell. You can start composing the application layout and specific pages to build your application. Learn more on building shell applications.

Compose components

Create the components to compose into the feature. Run the following command to create a new React UI component for the application login route:

bit create react pages/login

Find simple guides for creating NodeJS modules, UI components and apps, backend services and more on the Create Component docs.

Compose the component into the application shell:

import { Login } from '@my-org/users.pages.login';
import { Routes, Route } from 'react-router-dom';

export function CorporateWebsite() {
  return (
    <AcmeTheme>
      <NavigationProvider>
        <Routes>
          <Route path="/" element={<div>Hello world</div>} />
          <Route path="/login" element={<Login />} />
        </Routes>
      </NavigationProvider>
    </AcmeTheme>
  );
}

Head to http://localhost:3000/login to view your new login page. You can use bit templates to list official templates or find guides for creating React hooks, backend services, NodeJS modules, UI components and more on our create components docs. Optionally, use bit start to run the Bit UI to preview components in isolation.

Release and deploy

You can either use hosted scopes on Bit Cloud or by hosting scopes on your own. Use the following command to create your Bit Cloud account and your first scope.

bit login

Use semantic versioning to version your components:

bit tag --message "my first release" --major

By default, Bit uses Ripple CI to build components. You can use the --build flag to build the components on the local machine. To 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 export

Modernize existing projects

Head over to your bit.cloud account to see your components build progress. Once the build process is completed, the components will be available for use using standard package managers:

npm install @my-org/users.pages.login

Next steps

Contributors

Bit is entirely built with Bit and you can find all its components on Bit Cloud.

Your contribution, no matter how big or small, is much appreciated. Before contributing, please read the code of conduct.

See Contributing.

License

Apache License, Version 2.0

bit (teambit/bit)

Searching Database…

18.5K ·GitHub
Bit
What is this?Bit is an open-source build system for the AI era: it organizes source code into composable, reusable components and apps. Developers and AI agents create and reuse these components via MCP, preventing code duplication.
Is Bit a framework I code against, or a tool that wraps my codebase?A tool, not a UI framework: a build system and workspace around your existing code. Your components stay React, Vue, Angular or Node.js — Bit adds versioning, composition and CI on top.
How do I install it and get a first app running?Run npx @teambit/bvm install, then bit init --default-scope my-org.my-project (create the scope on bit.cloud first). Then bit create react-app my-app and bit run my-app serves your shell at localhost:3000.
What do I need installed before that?Node.js 22.13.0 or newer (per the repo's engines field). Bit supports all tooling in the JS ecosystem and is native to TypeScript and ESM.
Do I have to move all my code into a monorepo to use it?No. Bit fits any codebase structure — components can live in a monorepo, a polyrepo, or even without repositories at all. Shared components are hosted in scopes on the Bit Cloud platform.
Does it run on Windows, macOS and Linux?Yes. It installs as a CLI on your PATH via the Node-based installer and works across Windows, macOS and Linux; you drive it from the terminal, your editor, the Bit UI, or an AI agent.
What kinds of things can Bit actually build?Official dev environments ship out of the box for Node.js, React, Angular, Vue, React Native and Next.js, among others — so you can create UI components, backend services, Node modules and full application shells, all with built-in dev tooling.
What does the AI part do in practice?Bit exposes an MCP server so AI agents can intelligently create and reuse existing components instead of duplicating code. Teams also define blueprint templates, so developers and AI build from the same standard building blocks.
What are shell applications and why would I want one?They are application shells you compose from reusable components and features: create one with bit create react-app, compose pages and layout into it, and get simple, safe atomic deployments to testing and production.
What are similar projects?qiankun, tiptap, mitosis, ckeditor5, razzle, generator-jhipster, gin-vue-admin, blobatar
Which topics is it in?composable, node-js, front-end, distributed, build-tool, ai-coding, collaboration, microservices, monorepo, component-library, vue, ui-components
Creator
teambit
Size
247.5 MB
Stars
18.5K
Updated
CommitOct 16Releasev2.0.26Jul 21
Age
9y
Commits · 90 Days