{
"name": "ncu",
"description": "Upgrade your npm package.json dependencies to the latest versions, ignoring specified versions",
"options": [
{
"names": [
"--cache"
],
"description": "Cache versions to a local cache file. Default --cacheFile is ~/.ncu-cache.json and default --cacheExpiration is 10 minutes"
},
{
"names": [
"--cacheClear"
],
"description": "Clear the default cache, or the cache file specified by --cacheFile"
},
{
"names": [
"--cacheExpiration"
],
"description": "Cache expiration in minutes. Only works with --cache. (default: 10)",
"takes_arg": true,
"arg": {
"name": "min"
}
},
{
"names": [
"--cacheFile"
],
"description": "Filepath for the cache file. Only works with --cache. (default: \"~/.ncu-cache.json\")",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--color"
],
"description": "Force color in terminal"
},
{
"names": [
"--concurrency"
],
"description": "Max number of concurrent HTTP requests to registry. (default: 8)",
"takes_arg": true,
"arg": {
"name": "n"
}
},
{
"names": [
"--configFileName"
],
"description": "Config file name. (default: .ncurc.{json,yml,js,cjs})",
"takes_arg": true,
"arg": {
"name": "s",
"template": "filepaths"
}
},
{
"names": [
"--configFilePath"
],
"description": "Directory of .ncurc config file. (default: directory of packageFile)",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--cwd"
],
"description": "Working directory in which npm will be executed",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--deep"
],
"description": "Run recursively in current working directory. Alias of (--packageFile '**/package.json')"
},
{
"names": [
"--dep"
],
"description": "Check one or more sections of dependencies only: dev, optional, peer, prod, or packageManager (comma-delimited). (default: [\"prod\",\"dev\",\"optional\"])",
"takes_arg": true,
"arg": {
"name": "value",
"suggestions": [
"dev",
"optional",
"peer",
"prod",
"packageManager"
]
}
},
{
"names": [
"--deprecated"
],
"description": "Include deprecated packages"
},
{
"names": [
"--doctor",
"-d"
],
"description": "Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires -u to execute. Run \"ncu --help --doctor\" for details"
},
{
"names": [
"--doctorInstall"
],
"description": "Specifies the install script to use in doctor mode. (default: npm install/yarn)",
"takes_arg": true,
"arg": {
"name": "command"
}
},
{
"names": [
"--doctorTest"
],
"description": "Specifies the test script to use in doctor mode. (default: npm test)",
"takes_arg": true,
"arg": {
"name": "command"
}
},
{
"names": [
"--enginesNode"
],
"description": "Include only packages that satisfy engines.node as specified in the package file"
},
{
"names": [
"--errorLevel",
"-e"
],
"description": "Set the error level. 1: exits with error code 0 if no errors occur. 2: exits with error code 0 if no packages need updating (useful for continuous integration). (default: 1)",
"takes_arg": true,
"arg": {
"name": "n"
}
},
{
"names": [
"--filter",
"-f"
],
"description": "Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function",
"takes_arg": true,
"arg": {
"name": "p"
}
},
{
"names": [
"--filterResults"
],
"description": "Filters out upgrades based on a user provided function. Run \"ncu --help --filterResults\" for details"
},
{
"names": [
"--filterVersion"
],
"description": "Filter on package version using comma-or-space-delimited list, /regex/, or predicate function",
"takes_arg": true,
"arg": {
"name": "p"
}
},
{
"names": [
"--format"
],
"description": "Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines. Run \"ncu --help --format\" for details. (default: [])",
"takes_arg": true,
"arg": {
"name": "value",
"suggestions": [
"group",
"ownerChanged",
"repo",
"time",
"lines"
]
}
},
{
"names": [
"--global",
"-g"
],
"description": "Check global packages instead of in the current project"
},
{
"names": [
"--groupFunction"
],
"description": "Customize how packages are divided into groups when using --format group. Run \"ncu --help --groupFunction\" for details"
},
{
"names": [
"--help",
"-h"
],
"description": "Show help"
},
{
"names": [
"--interactive",
"-i"
],
"description": "Enable interactive prompts for each dependency; implies -u unless one of the json options are set"
},
{
"names": [
"--jsonAll",
"-j"
],
"description": "Output new package file instead of human-readable message"
},
{
"names": [
"--jsonDeps"
],
"description": "Like jsonAll but only lists dependencies, devDependencies, optionalDependencies, etc of the new package data"
},
{
"names": [
"--jsonUpgraded"
],
"description": "Output upgraded dependencies in json"
},
{
"names": [
"--loglevel",
"-l"
],
"description": "Amount to log: silent, error, minimal, warn, info, verbose, silly. (default: \"warn\")",
"takes_arg": true,
"arg": {
"name": "n",
"suggestions": [
"silent",
"error",
"minimal",
"warn",
"info",
"verbose",
"silly"
]
}
},
{
"names": [
"--mergeConfig"
],
"description": "Merges nested configs with the root config file for --deep or --packageFile options. (default: false)"
},
{
"names": [
"--minimal",
"-m"
],
"description": "Do not upgrade newer versions that are already satisfied by the version range according to semver"
},
{
"names": [
"--packageData"
],
"description": "Package file data (you can also use stdin)",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"--packageFile"
],
"description": "Package file(s) location. (default: ./package.json)",
"takes_arg": true,
"arg": {
"name": "path|glob",
"template": "filepaths"
}
},
{
"names": [
"--packageManager",
"-p"
],
"description": "Npm, yarn, pnpm, deno, staticRegistry (default: npm). Run \"ncu --help --packageManager\" for details",
"takes_arg": true,
"arg": {
"name": "s",
"suggestions": [
"npm",
"yarn",
"pnpm",
"deno",
"staticRegistry"
]
}
},
{
"names": [
"--peer"
],
"description": "Check peer dependencies of installed packages and filter updates to compatible versions. Run \"ncu --help --peer\" for details"
},
{
"names": [
"--pre"
],
"description": "Include prerelease versions, e.g. -alpha.0, -beta.5, -rc.2. Automatically set to 1 when --target is newest or greatest, or when the current version is a prerelease. (default: 0)",
"takes_arg": true,
"arg": {
"name": "n"
}
},
{
"names": [
"--prefix"
],
"description": "Current working directory of npm",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--registry",
"-r"
],
"description": "Third-party npm registry. Run \"ncu --help --registry\" for details",
"takes_arg": true,
"arg": {
"name": "uri"
}
},
{
"names": [
"--reject",
"-x"
],
"description": "Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function",
"takes_arg": true,
"arg": {
"name": "p"
}
},
{
"names": [
"--rejectVersion"
],
"description": "Exclude package.json versions using comma-or-space-delimited list, /regex/, or predicate function",
"takes_arg": true,
"arg": {
"name": "p"
}
},
{
"names": [
"--removeRange"
],
"description": "Remove version ranges from the final package version"
},
{
"names": [
"--retry"
],
"description": "Number of times to retry failed requests for package info. (default: 3)",
"takes_arg": true,
"arg": {
"name": "n"
}
},
{
"names": [
"--root"
],
"description": "Runs updates on the root project in addition to specified workspaces. Only allowed with --workspace or --workspaces. (default: false)"
},
{
"names": [
"--silent",
"-s"
],
"description": "Don't output anything. Alias for --loglevel silent"
},
{
"names": [
"--stdin"
],
"description": "Read package.json from stdin"
},
{
"names": [
"--target",
"-t"
],
"description": "Determines the version to upgrade to: latest, newest, greatest, minor, patch, @[tag], or [function]. (default: latest) Run \"ncu --help --target\" for details",
"takes_arg": true,
"arg": {
"name": "value",
"suggestions": [
"latest",
"newest",
"greatest",
"minor",
"patch"
]
}
},
{
"names": [
"--timeout"
],
"description": "Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch)",
"takes_arg": true,
"arg": {
"name": "ms"
}
},
{
"names": [
"--upgrade",
"-u"
],
"description": "Overwrite package file with upgraded versions instead of just outputting to console"
},
{
"names": [
"--verbose"
],
"description": "Log additional information for debugging. Alias for --loglevel verbose"
},
{
"names": [
"--version",
"-v"
],
"description": "Output the version number of npm-check-updates"
},
{
"names": [
"--workspace",
"-w"
],
"description": "Run on one or more specified workspaces. Add --root to also upgrade the root project. (default: [])",
"takes_arg": true,
"arg": {
"name": "s"
}
},
{
"names": [
"--workspaces",
"-ws"
],
"description": "Run on all workspaces. Add --root to also upgrade the root project"
}
],
"args": [
{
"name": "filter",
"description": "A list or regex of package names to check (all others will be ignored)",
"is_variadic": true
}
]
}