---
name: bit-cli
description: Bit CLI command reference. Use before running bit commands to get correct syntax and flags.
---
# Bit CLI Quick Reference
<!-- This content is auto-generated by: bit cli generate --skill commands -->
usage: bit [--version] [--help] <command> [<args>]
bit documentation: https://bit.dev/
System & Utility
help display available commands and usage information
version display the installed Bit version
config manage Bit configuration settings
globals display global directories and paths used by Bit
system access system-level operations and debugging tools
doctor diagnose and troubleshoot workspace issues
clear-cache remove cached data to resolve stale data issues
Information & Analysis
show display component metadata, dependencies, and configuration
graph visualize component dependencies as a graph image
pattern test and validate component patterns
list display components in workspace or remote scope
diff compare component changes between versions or against the current workspace
status show workspace component status and issues
schema display component API schema and type definitions
Component Configuration
envs show components and their assigned environments
scope manage component scope names and assignments
eject-conf create component.json configuration files for components
local-only manage components that exist only in the workspace
aspect manage component aspects and their configurations
Collaboration & Remote
remote manage remote scopes for self-hosted environments
deprecate mark a component as deprecated to discourage its use
undeprecate remove the deprecation status from a component
import bring components from remote scopes into your workspace
delete soft-delete components from remote scopes
recover restore soft-deleted components
export upload components to remote scopes
lane manage lanes for parallel development
ci continuous integration commands for automated workflows
fork create a new component by copying from an existing one
Run & Serve
start launch the Bit development server
run start an application component locally
app manage application components
Advanced/Debug
capsule manage isolated component environments
mcp-server start Model Context Protocol server for AI assistants
Develop components
script run a script defined by the environment
Workspace Tools
ws-config generate IDE configuration files
git Git utilities for Bit repositories
refactor automatically refactor component source code
Component Development
add track existing directory contents as new components in the workspace
create scaffold new component(s) from a template (sources, config, and env)
templates list available templates for creating components and workspaces
watch watch and compile components on file changes
build run build pipeline tasks in isolated environments
compile transpile component source files
move relocate a component to a different directory
remove untrack components from the workspace
rename change a component name
Workspace & Project Setup
new create a new Bit workspace from a template
init initialize a Bit workspace in an existing project
Testing & Quality
artifacts view and download build artifacts
test run component tests
check-types validate TypeScript type correctness
lint analyze component code for issues and style violations
validate run type-checking, linting, and testing in sequence
format auto-format component source code
Dependencies & Packages
install install workspace dependencies
uninstall remove dependencies from workspace
update update workspace dependencies to newer versions
link create links between components and node_modules
eject remove component from workspace and install it as npm package
deps manage component dependencies
why find components that use the specified dependency
set-peer configure component to always be installed as peer dependency
unset-peer remove always-peer configuration from component
dependents show components that depend on the specified component
Version Control
checkout switch between component versions or remove local changes
revert replace component files with specified version while preserving current version
tag create immutable component snapshots with semantic version tags
snap create immutable component snapshots for development versions
reset revert local tags and snaps to previous versions
merge merge diverged component history when local and remote have different versions
stash temporarily save and restore component changes
log display component version history
log-file EXPERIMENTAL. display history of changes to a specific file
blame EXPERIMENTAL. show line-by-line authorship and modification history
Authentication & Cloud
login authenticate with Bit Cloud for component publishing and collaboration
logout sign out of Bit Cloud and clear authentication tokens
whoami display the currently authenticated Bit Cloud user
npmrc configure .npmrc file with Bit Cloud registry and authentication settings
Dot-bit
sign complete the build process for components
For flag details, see [CLI_FLAGS.md](CLI_FLAGS.md).
Run 'bit <command> --help' for more information on a specific command.
