Skip to content

docs: sync README CLI help output with actual CLI #984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
btea wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −13
Open

docs: sync README CLI help output with actual CLI #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65cb47b
docs: sync README CLI help output with actual CLI
btea Aug 2, 2026
1792f92
fix(core): accept a value for the --git-ref option
btea Aug 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,13 @@ Usage: @node-core/doc-kit [options] [command]
CLI tool to generate the Node.js API documentation

Options:
-h, --help display help for command
--log-level <level> Log level (choices: "debug", "info", "warn", "error",
"fatal", default: "info")
-h, --help display help for command

Commands:
generate [options] Generate API docs
help [command] display help for command
generate [options] Generate API docs
help [command] display help for command
```

### `generate`
Expand All @@ -70,15 +72,26 @@ Usage: @node-core/doc-kit generate [options]
Generate API docs

Options:
-i, --input <patterns...> Input file patterns (glob)
--ignore [patterns...] Ignore patterns (comma-separated)
-o, --output <dir> Output directory
-p, --threads <number> (default: "12")
-v, --version <semver> Target Node.js version (default: "v22.14.0")
-c, --changelog <url> Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
--git-ref <url> Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD")
-t, --target [modes...] Target generator modes (choices: "json-simple", "legacy-html", "legacy-html-all", "man-page", "legacy-json", "legacy-json-all", "addon-verify", "api-links", "orama-db", "llms-txt")
-h, --help display help for command
--config-file <path> Config file
-i, --input <patterns...> Input file patterns (glob)
-t, --target <generator...> Target generator(s): a built-in name
(json-simple, legacy-html, legacy-html-all,
man-page, legacy-json, legacy-json-all,
addon-verify, api-links, orama-db, llms-txt,
sitemap, web) or an import specifier for a custom
generator
--ignore <patterns...> Ignore file patterns (glob)
-o, --output <directory> The output directory
-p, --threads <number> Number of threads to use (minimum: 1)
--chunk-size <number> Number of items to process per worker thread
(minimum: 1)
-v, --version <semver> Target Node.js version
-c, --changelog <url> Changelog URL or path
--git-ref <ref> Git ref
--index <url> index.md URL or path
Comment thread
btea marked this conversation as resolved.
--minify Minify?
--type-map <url> Type map URL or path
-h, --help display help for command
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion packages/core/bin/commands/generate.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export default new Command('generate')
)
.addOption(new Option('-v, --version <semver>', 'Target Node.js version'))
.addOption(new Option('-c, --changelog <url>', 'Changelog URL or path'))
.addOption(new Option('--git-ref', 'Git ref URL'))
.addOption(new Option('--git-ref <ref>', 'Git ref'))
.addOption(new Option('--index <url>', 'index.md URL or path'))
.addOption(new Option('--minify', 'Minify?'))
.addOption(new Option('--type-map <url>', 'Type map URL or path'))
Expand Down
Loading