Subcommands132 subcommands
bit init
Create or reinitialize an empty workspace
bit new
Create a new workspace from a template
bit config
Global config management
bit config set
Set a global configuration
bit config del
Delete given key from global configuration
bit config get
Get a value from global configuration
bit config list
List all configuration(s)
bit scope-config
Scope config management
bit scope-config
bit scope-config set
Set a scope configuration.
Usage: scope-config set <key> <val>
bit scope-config del
Delete given key from global configuration.
Usage: scope-config del <key>
bit scope-config get
Get a scope configuration.
Usage: scope-config get <key>
bit scope-config list
List all scope configuration(s).
Usage: scope-config list
bit login
Log in to Bit cloud
bit logout
Log the CLI out of Bit
bit doctor
Diagnose a bit workspace
bit completion
Enable bash/zsh-completion shortcuts for commands and options
bit cli
EXPERIMENTAL: Enters bit cli program and generates commands list
bit cli generate
Generate an .md file with all commands details
bit clear-cache
Clears Bit's cache from current working machine
bit remote
Manage set of tracked bit scope(s)
bit remote add
Add a bare-scope as a remote, usage: remote add <url>
bit remote del
Remove a tracked bit remote: usage: remote del <name>
bit remove
Remove component(s) from the local workspace
bit import
Import components from their remote scopes to the local workspace
bit pack
Create tar for npm publish
bit deprecate
Deprecate a component
bit undeprecate
Undeprecate a deprecated component (local/remote).
bit undeprecate <id>
bit rename
Rename a component
bit fork
Create a new component forked from an existing one (copies source files and configs)
bit export
Export components from the workspace to remote scopes
bit dependents
Show dependents of the given component
bit show
Display the component's essential information
bit show <component-name>
bit deps
Manage dependencies
bit deps get
Show direct and indirect dependencies of the given component
bit deps remove
Remove a dependency to component(s)
bit deps unset
Unset a dependency to component(s) that was previously set by 'bit deps set'
bit deps debug
Show the immediate dependencies and how their versions were determined
bit deps set
Set a dependency to component(s)
bit deps reset
Reset dependencies to the default values (revert any previously 'bit deps set')
bit deps eject
Write dependencies that were previously set via 'bit deps set' into .bitmap
bit deps blame
EXPERIMENTAL: Find out which snap/tag changed a dependency version
bit deps usage
EXPERIMENTAL: Find components that use the specified dependency
bit log
Show components(s) version history
bit add
Add any subset of files to be tracked as a component(s)
bit move
Move a component to a different filesystem path
bit diff
Show the diff between the components' current source files and config, and their latest snapshot or tag
bit envs
List all components maintained by the workspace and their corresponding envs
bit envs list
List all envs currently used in the workspace
bit envs get
Show config information from a component's env
bit envs set
Assigns one or more components a development environment (env)
bit envs unset
Un-sets an env from components
bit envs replace
Replace an existing env with another env for all components using the old env
bit envs update
Update a version of an env for all components using that env
bit start
Run the UI/development server
bit start [component-pattern]
bit ui-build
Build production assets for deployment
bit checkout
Switch between component versions or remove local changes
bit install
Installs workspace dependencies
bit uninstall
Uninstall dependencies.
bit uninstall [packages...]
bit update
Update dependencies.
bit update [package-patterns...]
bit link
Create links in the node_modules directory, to core aspects and to components in the workspace
bit component-issues
List available component-issues
bit tag
Create an immutable and exportable component snapshot, tagged with a release version.
If no patterns are provided, it will tag all new and modified components.
If patterns are entered, you can specify a version per pattern using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
bit tag [component-patterns...]
bit reset
Revert tagged or snapped versions for component(s)
bit merge
Merge changes of the remote head into local and creates snaps for merged components
bit create
Create a new component using a template
bit templates
List available templates for "bit create" and "bit new"
List components templates when inside bit-workspace (for bit-create), otherwise, list workspace templates (for bit-new).
bit templates
bit build
Run set of tasks for build. By default, only new and modified components are built
bit artifacts
List and download component artifacts
bit refactor
Source code refactoring / codemod
bit refactor dependency-name
Replace the dependency's old package-name with a new one in the code, usage: refactor dependency-name <old-id> <new-id>
bit status
Present the current status of components in the workspace, including indication of detected issues
bit status
bit compile
Compile components in the workspace
bit test
Test components in the workspace. By default only runs tests for new and modified components.
bit test [component-pattern]
bit schema
Shows the API schema of the specified component/s
bit check-types
Check typescript types
bit aspect
EXPERIMENTAL. Manage aspects
bit eject
Remove component from the workspace and install it instead as a regular npm package. By default the component files will be removed from the workspace
bit format
Format components in the development workspace
bit lint
Lint components in the development workspace
bit graph
Generate an image file with the workspace components' dependencies graph
bit list
List components on a workspace or a remote scope
bit globals
List all globals
bit run
Locally run an app component (independent of bit's dev server)
bit app list
List all registered apps
bit app run
Locally run an app component (independent of bit's dev server)
bit capsule
Manage capsules
bit capsule list
List the capsules generated for this workspace
bit capsule create
Create capsules for components
bit capsule delete
Delete capsules
bit delete
Mark components as deleted on the remote
bit eject-conf
Eject components configuration (create a component.json file). Note this can be reversed at any time by snapping/tagging changes and deleting the component.json file
bit git
Perform git operations
bit git set-merge-driver
Setup bit's git merge driver for bitmap files
bit git merge-bitmaps
Merge conflicting bitmap files during git merge
bit lane
Manage lanes - if no sub-command is used, runs 'bit lane list'
bit lane list
List local lanes
bit lane switch
Switch to the specified lane
bit lane show
Show lane details. If no lane specified, show the current lane
bit lane create
Creates a new lane and switches to it
bit lane remove
Remove or delete lanes
bit lane change-scope
Changes the remote scope of a lane
bit lane alias
Adds an alias to a lane
bit lane rename
EXPERIMENTAL. Change the lane-name locally and on the remote (if exported)
bit lane diff
Show diff between lanes
bit lane merge-abort
Abort the recent lane-merge. Revert the lane object and checkout accordingly
bit lane merge
Merge a local or a remote lane to the current lane. By default, the provided lane will be fetched from the remote before merging. To merge the lane from the local scope without updating it first, use '--skip-fetch' flag
bit lane add-readme
EXPERIMENTAL. Sets an existing component as the readme of a lane
bit lane remove-readme
EXPERIMENTAL. Remove lane readme component
bit lane import
Import a remote lane to your workspace and switch to that lane
bit lane remove-comp
DEPRECATED. Remove components when on a lane
bit log-file
EXPERIMENTAL: Show file history
bit mini-status
EXPERIMENTAL. Basic status for fast execution
bit pattern
List the component ids matching the given pattern
bit recover
EXPERIMENTAL. Recover component(s) soft-deleted from the workspace, or a remote scope
bit revert
Replace the current component files by the specified version, leave the version intact
bit scope
Manage the scope-name for components
bit scope <sub-command>
bit scope set
Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace. Default scopes for components are set in the bitmap file. The default scope for a workspace is set in the workspace.jsonc. A component is set with a scope (as opposed to default scope) only once it is versioned. You can use a pattern for multiple component ids, such as bit scope set scope-name "org.scope/utils/**". Use comma to separate patterns and '!' to exclude. Always wrap the pattern with single quotes to avoid collision with shell commands.
Usage: scope set <scope-name> [component-pattern]
bit scope rename
Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged. If <current-scope-name> is also the defaultScope for the workspace, this command will set <new-scope-name> as the defaultScope instead.
Usage: scope rename <current-scope-name> <new-scope-name>
bit scope rename-owner
Renames the owner part of the scope-name for all components with the specified 'current owner name'.
Usage: scope rename-owner <current-owner-name> <new-owner-name>
bit scope fork
Fork all components of the original-scope and refactor the source-code to use the new scope name.
Usage: scope fork <original-scope> <new-scope>
bit server
EXPERIMENTAL. Communicate with bit CLI program via HTTP requests
bit server
bit system
System operations
bit system <sub-command>
bit system log
Print debug.log to the screen
Usage: system log
bit snap
Create an immutable and exportable component snapshot (non-release version)
bit snap [component-pattern]
bit watch
Automatically recompile modified components (on save). By default, the watcher doesn't use polling, to keep the CPU idle. In some rare cases, this could result in missing file events (files are not watched). To fix it, try to stop other watchers on the same machine. Alternatively, to use polling, run "bit config set watch_use_polling true".
bit watch
bit use
Set aspects in the workspace/scope config to make them loadable by the workspace/scope.
bit use <component-id>
bit ws-config
Manage workspace config files.
bit ws-config <sub-command>
bit ws-config ws-config write
EXPERIMENTAL. Write config files in the workspace. Useful for IDEs.
ws-config write
bit ws-config ws-config clean
EXPERIMENTAL. Clean (delete) written config files in the workspace. Useful for IDEs.
ws-config clean
bit ws-config ws-config list
EXPERIMENTAL. List config writers.
ws-config list
