---
name: bit-cli
description: 'MUST consult before running ANY bit command. Do NOT guess bit commands from memory. This skill tells you the right command, correct syntax, subcommands, 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
Subcommands: set, del, get, list
globals - display global directories and paths used by Bit
system <sub-command> - access system-level operations and debugging tools
Subcommands: log, tail-log
doctor [diagnosis-name] - diagnose and troubleshoot workspace issues
clear-cache - remove cached data to resolve stale data issues

Information & Analysis
show <component-name> - display component metadata, dependencies, and configuration
graph [id] - visualize component dependencies as a graph image
pattern <pattern> - test and validate component patterns
list [remote-scope] - display components in workspace or remote scope
diff [component-pattern] [version] [to-version] - compare component changes between versions or against the current workspace
status - show workspace component status and issues
schema <pattern> - display component API schema and type definitions

Component Configuration
envs - show components and their assigned environments
Subcommands: list, get, set, unset, replace, update
scope <sub-command> - manage component scope names and assignments
Subcommands: set, rename, rename-owner, fork
eject-conf <pattern> - create component.json configuration files for components
local-only <sub-command> - manage components that exist only in the workspace
Subcommands: set, unset, list
aspect <sub-command> - manage component aspects and their configurations
Subcommands: list, list-core, get, set, unset, update

Collaboration & Remote
remote - manage remote scopes for self-hosted environments
Subcommands: add, del, list
deprecate <component-name> - mark a component as deprecated to discourage its use
undeprecate <id> - remove the deprecation status from a component
import [component-patterns...] - bring components from remote scopes into your workspace
delete <component-pattern> - soft-delete components from remote scopes
recover <component-pattern> - restore soft-deleted components
export [component-patterns...] - upload components to remote scopes
lane [sub-command] - manage lanes for parallel development
Subcommands: list, show, create, remove, change-scope, alias, rename, remove-readme, import, remove-comp, fetch, eject, history, history-diff, checkout, revert, merge-move
ci <sub-command> - continuous integration commands for automated workflows
Subcommands: verify, pr, merge
fork <pattern> [target-component-name] - create a new component by copying from an existing one

Run & Serve
start [component-pattern] - launch the Bit development server
run [app-name] - start an application component locally
app [sub-command] - manage application components
Subcommands: list, run

Advanced/Debug
capsule - manage isolated component environments
Subcommands: list, create, delete
mcp-server [sub-command] - start Model Context Protocol server for AI assistants
Subcommands: start, setup, rules

Develop components
script [script-name] - run a script defined by the environment

Workspace Tools
ws-config <sub-command> - generate IDE configuration files
Subcommands: write, clean, list
git <sub-command> - Git utilities for Bit repositories
Subcommands: set-merge-driver
refactor <sub-command> - automatically refactor component source code
Subcommands: dependency-name

Component Development
add [path...] - track existing directory contents as new components in the workspace
create <template-name> <component-names...> - 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 [component-pattern] - run build pipeline tasks in isolated environments
compile [component-names...] - transpile component source files
move <current-component-dir> <new-component-dir> - relocate a component to a different directory
remove <component-pattern> - untrack components from the workspace
rename <current-name> <new-name> - change a component name

Workspace & Project Setup
new <template-name> <workspace-name> - create a new Bit workspace from a template
init [path] - initialize a Bit workspace in an existing project

Testing & Quality
artifacts <component-pattern> - view and download build artifacts
test [component-pattern] - run component tests
check-types [component-pattern] - validate TypeScript type correctness
lint [component-pattern] - analyze component code for issues and style violations
validate [component-pattern] - run type-checking, linting, and testing in sequence
format [component-pattern] - auto-format component source code

Dependencies & Packages
install [packages...] - install workspace dependencies
uninstall [packages...] - remove dependencies from workspace
update [package-patterns...] - update workspace dependencies to newer versions
link [component-names...] - create links between components and node_modules
eject <component-pattern> - remove component from workspace and install it as npm package
deps <sub-command> - manage component dependencies
Subcommands: get, remove, unset, debug, set, reset, eject, blame, usage, diagnose, write
why <dependency-name> - find components that use the specified dependency
set-peer <component-id> <range> - configure component to always be installed as peer dependency
unset-peer <component-id> - remove always-peer configuration from component
dependents <component-name> - show components that depend on the specified component

Version Control
checkout <to> [component-pattern] - switch between component versions or remove local changes
revert <component-pattern> <to> - replace component files with specified version while preserving current version
tag [component-patterns...] - create immutable component snapshots with semantic version tags
snap [component-pattern] - create immutable component snapshots for development versions
reset [component-pattern] - revert local tags and snaps to previous versions
merge [component-pattern] - merge diverged component history when local and remote have different versions
stash <sub-command> - temporarily save and restore component changes
Subcommands: save, load, list
log <id> - display component version history
log-file <filepath> - EXPERIMENTAL. display history of changes to a specific file
blame <filepath> - 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 [sub-command] - configure .npmrc file with Bit Cloud registry and authentication settings
Subcommands: generate

IMPORTANT: When you need flags, arguments, or subcommand details, READ the file CLI_REFERENCE.md in this same directory using the Read tool. Only fall back to 'bit <command> --help' if the reference file doesn't cover what you need.