diff --git a/README.md b/README.md
index 8016f306..504cc75d 100644
--- a/README.md
+++ b/README.md
@@ -167,11 +167,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
Clear the default cache, or the cache file specified by --cacheFile. |
- | --cacheExpiration |
+ --cacheExpiration <min> |
Cache expiration in minutes. Only works with --cache. (default: 10) |
- | --cacheFile |
+ --cacheFile <path> |
Filepath for the cache file. Only works with --cache. (default: "~/.ncu-cache.json") |
@@ -179,19 +179,19 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Force color in terminal. |
- | --concurrency |
+ --concurrency <n> |
Max number of concurrent HTTP requests to registry. (default: 8) |
- --configFileName |
+ --configFileName <s> |
Config file name. (default: .ncurc.{json,yml,js,cjs}) |
- | --configFilePath |
+ --configFilePath <path> |
Directory of .ncurc config file. (default: directory of packageFile) |
- | --cwd |
+ --cwd <path> |
Working directory in which npm will be executed. |
@@ -199,7 +199,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
Run recursively in current working directory. Alias of (--packageFile '**/package.json'). |
- | --dep |
+ --dep <value> |
Check one or more sections of dependencies only: dev, optional, peer, prod, or packageManager (comma-delimited). (default: ["prod","dev","optional"]) |
@@ -207,15 +207,15 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Include deprecated packages. |
- | -d, --doctor |
+ -d, --doctor |
Iteratively installs upgrades and runs tests to identify breaking upgrades. Requires -u to execute. |
- | --doctorInstall |
+ --doctorInstall <command> |
Specifies the install script to use in doctor mode. (default: npm install/yarn) |
- | --doctorTest |
+ --doctorTest <command> |
Specifies the test script to use in doctor mode. (default: npm test) |
@@ -223,23 +223,23 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Include only packages that satisfy engines.node as specified in the package file. |
- | -e, --errorLevel |
+ -e, --errorLevel <n> |
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) |
- | -f, --filter |
+ -f, --filter <p> |
Include only package names matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. |
- | filterResults |
+ filterResults <fn> |
Filters out upgrades based on a user provided function. |
- | --filterVersion |
+ --filterVersion <p> |
Filter on package version using comma-or-space-delimited list, /regex/, or predicate function. |
- | --format |
+ --format <value> |
Modify the output formatting or show additional information. Specify one or more comma-delimited values: group, ownerChanged, repo, time, lines. (default: []) |
@@ -247,11 +247,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Check global packages instead of in the current project. |
- | groupFunction |
+ groupFunction <fn> |
Customize how packages are divided into groups when using --format group. |
- | --install |
+ --install <value> |
Control the auto-install behavior: always, never, prompt. (default: "prompt") |
@@ -271,7 +271,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Output upgraded dependencies in json. |
- | -l, --loglevel |
+ -l, --loglevel <n> |
Amount to log: silent, error, minimal, warn, info, verbose, silly. (default: "warn") |
@@ -283,15 +283,15 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Do not upgrade newer versions that are already satisfied by the version range according to semver. |
- | --packageData |
+ --packageData <value> |
Package file data (you can also use stdin). |
- | --packageFile |
+ --packageFile <path|glob> |
Package file(s) location. (default: ./package.json) |
- -p, --packageManager |
+ -p, --packageManager <s> |
npm, yarn, pnpm, deno, bun, staticRegistry (default: npm). |
@@ -299,27 +299,27 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Check peer dependencies of installed packages and filter updates to compatible versions. |
- | --pre |
+ --pre <n> |
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) |
- | --prefix |
+ --prefix <path> |
Current working directory of npm. |
- | -r, --registry |
+ -r, --registry <uri> |
Specify the registry to use when looking up package versions. |
- | --registryType |
+ --registryType <type> |
Specify whether --registry refers to a full npm registry or a simple JSON file or url: npm, json. (default: npm) |
- | -x, --reject |
+ -x, --reject <p> |
Exclude packages matching the given string, wildcard, glob, comma-or-space-delimited list, /regex/, or predicate function. |
- | --rejectVersion |
+ --rejectVersion <p> |
Exclude package.json versions using comma-or-space-delimited list, /regex/, or predicate function. |
@@ -327,7 +327,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Remove version ranges from the final package version. |
- | --retry |
+ --retry <n> |
Number of times to retry failed requests for package info. (default: 3) |
@@ -343,11 +343,11 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
| Read package.json from stdin. |
- | -t, --target |
+ -t, --target <value> |
Determines the version to upgrade to: latest, newest, greatest, minor, patch, semver, @[tag], or [function]. (default: latest) |
- | --timeout |
+ --timeout <ms> |
Global timeout in milliseconds. (default: no global timeout and 30 seconds per npm-registry-fetch) |
@@ -359,7 +359,7 @@ Options that take no arguments can be negated by prefixing them with `--no-`, e.
Log additional information for debugging. Alias for --loglevel verbose. |
- -w, --workspace |
+ -w, --workspace <s> |
Run on one or more specified workspaces. Add --root to also upgrade the root project. (default: []) |
diff --git a/src/scripts/build-options.ts b/src/scripts/build-options.ts
index eead2ce3..9a062a6a 100644
--- a/src/scripts/build-options.ts
+++ b/src/scripts/build-options.ts
@@ -17,9 +17,9 @@ const injectReadme = async () => {
const optionRows = cliOptions
.map(option => {
return `
- | ${option.short ? `-${option.short}, ` : ''}${option.help ? `` : ''}${
+ | ${option.help ? `` : ''}${option.short ? `-${option.short}, ` : ''}${
option.cli !== false ? '--' : ''
- }${option.long}${option.help ? '' : ''}${option.arg ? ` <${option.arg}>` : ''} |
+ }${option.long}${option.arg ? ` <${option.arg}>` : ''}${option.help ? '' : ''}
${codeHtml(option.description)}${option.default ? ` (default: ${JSON.stringify(option.default)})` : ''} |
`
})