beachball
Home
Getting started
GitHub
Home
Getting started
GitHub
  • Overview

    • Getting started
    • Installation
    • Configuration
  • Concepts

    • Bump algorithm
    • Change files
    • CI integration
    • Groups
  • CLI commands

    • Common options
    • bump
    • change
    • check
    • publish
    • sync

Beachball CLI options

For the latest full list of supported options, see CliOptions in this file.

Most options can also be specified in the configuration file, which is generally preferable as it's easier to read and maintain.

General options

The options below apply to most CLI commands.

OptionAliasDefaultDescription
--branch, -b-btarget branch; see config docs for details
--config-path-ccosmiconfig defaultscustom beachball config path
--no-fetchskip fetching from the remote
--change-dir'change'name of the directory to store change files
--scopeonly consider matching package paths (can be specified multiple times); see config docs
--sinceonly consider changes or change files since this git ref (branch name, commit SHA)
--verboseprints additional information to the console
Last Updated:: 6/4/25, 1:22 AM
Contributors: dependabot[bot]
Next
bump