Skip to content

prompt

Displays a series of prompts to fix mismatches which syncpack cannot fix automatically.

CLI Options

source

Override your source configuration to run syncpack prompt on only some package.json files.

# only the root package
syncpack prompt --source 'package.json'
# only packages matching a glob
syncpack prompt --source 'packages/beta-*'
# multiple values can be provided
syncpack prompt --source 'package.json' --source 'packages/beta-*'

filter

Only run syncpack prompt on dependencies whose names match the given string, which will be passed to new RegExp().

# only include react, react-dom, preact etc
syncpack prompt --filter 'react'
# only include typescript or eslint packages
syncpack prompt --filter 'typescript|eslint'

config

Syncpack uses cosmiconfig to discover your config file, but a custom location can be provided instead.

syncpack prompt --config ./config/.syncpackrc

specs

Override your specifierTypes configuration to run syncpack prompt against dependency instances with version specifiers of the given types, such as exact, range, or workspace-protocol.

# only include exact versions
syncpack prompt --specs 'exact'
# only include latest and range versions
syncpack prompt --specs 'latest,range'
# exclude unsupported versions
syncpack prompt --specs '!unsupported'

types

Override your dependencyTypes configuration to run syncpack prompt on only eg. peerDependencies in every package in your monorepo.

# only include peerDependencies
syncpack prompt --types 'peer'
# only include dependencies and devDependencies
syncpack prompt --types 'prod,dev'
# exclude local package.json versions
syncpack prompt --types '!local'

help

Display a list of CLI options and other help information.

syncpack prompt --help

Troubleshooting

Verbose logging can be enabled by prefixing syncpack with the following environment variable:

SYNCPACK_VERBOSE=true syncpack prompt