CLI Reference

Create or reinitialize an empty workspace

Show dependents of the given component

Diagnose a bit workspace

Enable bash/zsh-completion shortcuts for commands and options

Shows help

Shows bit version

List all globals

Display the component's essential information

Run the ui/development server

Generate an image file with the workspace components' dependencies graph

Eject components configuration (create a `component.json` file)

Set aspects in the workspace/scope config to make them loadable by the workspace/scope

List the component ids matching the given pattern

EXPERIMENTAL. find components that use the specified dependency

Add any subset of files to be tracked as a component(s).

Create a new component (source files and config) using a template.

List available templates for "bit create" and "bit new"

Create a new workspace from a template

Automatically recompile modified components (on save)

Run set of tasks for build.

List and download component artifacts

Locally run an app component (independent of bit's dev server)

Compile components in the workspace

Installs workspace dependencies

Uninstall dependencies

Update dependencies. By default, dependencies are updated to the highest semver compatible versions.

Create links in the node_modules directory, to core aspects and to components in the workspace

Move a component to a different filesystem path (note: this does NOT affect the component's name or scope, just its location in the workspace)

Import components from their remote scopes to the local workspace

Remove component from the workspace and install it instead as a regular npm package.

Remove component(s) from the local workspace

Mark components as deleted on the remote

EXPERIMENTAL. recover component(s) soft-deleted from the workspace, or a remote scope

Export components from the workspace to remote scopes

Create an immutable and exportable component snapshot, tagged with a release version.

Create an immutable and exportable component snapshot (non-release version)

Revert tagged or snapped versions for component(s)

Switch between component versions or remove local changes

Replace the current component files by the specified version, leave the version intact

Test components in the workspace. by default only runs tests for new and modified components

Show the diff between the components' current source files and config, and their latest snapshot or tag

Show components(s) version history

EXPERIMENTAL. show file history

Merge changes of the remote head into local - auto-snaps all merged components

EXPERIMENTAL. communicate with bit cli program via http requests

List components on a workspace or a remote scope (with flag).

Log in to Bit cloud

Log the CLI out of Bit

Display the currently logged in user

Present the current status of components in the workspace, including indication of detected issues

EXPERIMENTAL. basic status for fast execution

Clears Bit's cache from current working machine

Deprecate a component

Undeprecate a deprecated component (local/remote)

Rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component

Create a new component forked from an existing one (copies source files and configs)

Shows the API schema of the specified component/s.

Check typescript types

Format components in the development workspace

Lint components in the development workspace