Manage lanes - if no sub-command is used, runs "bit lane list"
$bit lane [sub-command]
$bit l [sub-command]
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --details | -d | show more details on the state of each component in each lane | boolean |
| --json | -j | show lanes details in json format | boolean |
| --remote | -r | show all remote lanes from the specified scope | string |
| --merged | - | list only merged lanes | boolean |
| --not-merged | - | list only lanes that haven't been merged | boolean |
list
list local or remote lanes
$bit lane list
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --details | -d | show more details on the state of each component in each lane | boolean |
| --json | -j | show lanes' details in a json format | boolean |
| --remote | -r | show all remote lanes from the specified scope | string |
| --merged | - | list only merged lanes | boolean |
| --not-merged | - | list only lanes that haven't been merged | boolean |
switch
switch to the specified lane
$bit lane switch <lane>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --head | -h | switch to the head of the lane/main (fetches the latest changes from the remote) | boolean |
| --auto-merge-resolve | -r | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual" | string |
| --get-all | -a | DEPRECATED. this is currently the default behavior | boolean |
| --workspace-only | - | checkout only the components in the workspace to the selected lane | boolean |
| --skip-dependency-installation | -x | do not install dependencies of the imported components | boolean |
| --pattern | -p | switch only the lane components matching the specified component-pattern. only works when the workspace is empty component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/**, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. | string |
| --alias | -n | relevant when the specified lane is a remote lane. create a local alias for the lane (doesnt affect the lane's name on the remote | string |
| --json | -j | return the output as JSON | boolean |
show
show lane details. if no lane specified, show the current lane
$bit lane show [lane-name]
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --json | -j | show the lane details in json format | boolean |
| --remote | -r | show details of the remote head of the provided lane | boolean |
create
creates a new lane and switches to it
$bit lane create <lane-name>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --scope | -s | remote scope to which this lane will be exported, default to the workspace.json's defaultScope (can be changed up to first export of the lane with "bit lane change-scope") | string |
| --remote-scope | - | DEPRECATED. use --scope | string |
| --alias | - | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias") | string |
| --fork-lane-new-scope | - | create the new lane in a different scope than its parent lane (if created from another lane) | boolean |
remove
remove or delete lanes
$bit lane remove <lanes...>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --remote | -r | delete a remote lane. use remote/lane-id syntax e.g. bit lane remove owner.org/my-lane --remote. Delete is immediate, no export required | boolean |
| --force | -f | removes/deletes the lane even when the lane is not yet merged to main | boolean |
| --silent | -s | skip confirmation | boolean |
change-scope
changes the remote scope of a lane
$bit lane change-scope <remote-scope-name>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --lane-name | -l | the name of the lane to change its remote scope. if not specified, the current lane is used | string |
alias
adds an alias to a lane
$bit lane alias <lane-name> <alias>
rename
EXPERIMENTAL. change the lane-name locally
$bit lane rename <new-name>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --lane-name | -l | the name of the lane to rename. if not specified, the current lane is used | string |
diff
show diff between lanes
$bit lane diff [values...]
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --pattern | - | show lane-diff for components conforming to the specified component-pattern only component-pattern format: component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/**, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. | string |
add-readme
EXPERIMENTAL. sets an existing component as the readme of a lane
$bit lane add-readme <component-name> [lane-name]
remove-readme
EXPERIMENTAL. remove lane readme component
$bit lane remove-readme [laneName]
import
import a remote lane to your workspace and switch to that lane
$bit lane import <lane>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --skip-dependency-installation | -x | do not install dependencies of the imported components | boolean |
| --pattern | -p | import only components from the lane that fit the specified component-pattern to the workspace. works only when the workspace is empty | string |
remove-comp
DEPRECATED. remove components when on a lane
$bit lane remove-comp <component-pattern>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --workspace-only | - | do not mark the components as removed from the lane. instead, remove them from the workspace only | boolean |
| --update-main | - | EXPERIMENTAL. remove, i.e. delete, component/s on the main lane after merging this lane into main | boolean |
fetch
fetch component objects from lanes. if no lane-id is provided, it fetches from the current lane
$bit lane fetch [lane-id]
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --all | -a | fetch all remote lanes | boolean |
eject
delete a component from the lane and install it as a package from main
$bit lane eject <component-pattern>
merge
merge a local or a remote lane to the current lane
$bit lane merge <lane> [pattern]
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --manual | - | same as "--auto-merge-resolve manual". in case of merge conflict, write the files with the conflict markers | boolean |
| --auto-merge-resolve | -r | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] | string |
| --ours | - | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications | boolean |
| --theirs | - | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes | boolean |
| --workspace | - | merge only lane components that are in the current workspace | boolean |
| --no-snap | - | do not auto snap after merge completed without conflicts | boolean |
| --tag | - | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) | boolean |
| --build | - | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) | boolean |
| --message | -m | override the default message for the auto snap | string |
| --keep-readme | - | skip deleting the lane readme component after merging | boolean |
| --no-squash | - | relevant for merging lanes into main, which by default squashes all lane snaps | boolean |
| --squash | - | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash | boolean |
| --ignore-config-changes | - | allow merging when components are modified due to config changes (such as dependencies) only and not files | boolean |
| --verbose | - | show details of components that were not merged successfully | boolean |
| --skip-dependency-installation | -x | do not install dependencies of the imported components | boolean |
| --skip-fetch | - | use the local state of target-lane if exits locally, without updating it from the remote | boolean |
| --include-deps | - | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components | boolean |
| --resolve-unrelated | - | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" | string |
| --include-non-lane-comps | - | DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged) | boolean |
| --exclude-non-lane-comps | - | when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged) | boolean |
merge-abort
abort the recent lane-merge. revert the lane object and checkout accordingly
$bit lane merge-abort
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --verbose | - | show details of components that didn't need to be merged | boolean |
| --silent | -s | skip confirmation | boolean |
| --skip-dependency-installation | -x | do not install packages of the imported components | boolean |
merge-move
EXPERIMENT. move the current merge state into a new lane. the current lane will be reset
$bit lane merge-move <new-lane-name>
Options
| Option | Option Alias | Description | Value Type |
|---|---|---|---|
| --scope | -s | remote scope to which this lane will be exported, default to the workspace.json's defaultScope (can be changed up to first export of the lane with "bit lane change-scope") | string |
