2323
2424## Usage
2525
26+ Local invocation:
27+
28+ ``` sh
29+ $ npx api-docs-tooling --help
30+ ```
31+
2632```
2733Usage: api-docs-tooling [options] [command]
2834
@@ -37,4 +43,65 @@ Commands:
3743 interactive Launch guided CLI wizard
3844 list <types> List the given type
3945 help [command] display help for command
40- ```
46+ ```
47+
48+ ### ` generate `
49+
50+ ```
51+ Usage: api-docs-tooling generate [options]
52+
53+ Generate API docs
54+
55+ Options:
56+ -i, --input <patterns...> Input file patterns (glob)
57+ --ignore [patterns...] Ignore patterns (comma-separated)
58+ -o, --output <dir> Output directory
59+ -p, --threads <number> (default: "12")
60+ -v, --version <semver> Target Node.js version (default: "v22.14.0")
61+ -c, --changelog <url> Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
62+ --git-ref <url> Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD")
63+ -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")
64+ --no-lint Skip lint before generate
65+ -h, --help display help for command
66+ ```
67+
68+ ### ` lint `
69+
70+ ```
71+ Usage: api-docs-tooling lint [options]
72+
73+ Run linter independently
74+
75+ Options:
76+ -i, --input <patterns...> Input file patterns (glob)
77+ --ignore [patterns...] Ignore patterns (comma-separated)
78+ --disable-rule [rules...] Disable linter rules (choices: "duplicate-stability-nodes", "invalid-change-version", "missing-introduced-in")
79+ --dry-run Dry run mode (default: false)
80+ -r, --reporter <reporter> Linter reporter to use
81+ -h, --help display help for command
82+ ```
83+
84+ ### ` interactive `
85+
86+ ```
87+ Usage: api-docs-tooling interactive [options]
88+
89+ Launch guided CLI wizard
90+
91+ Options:
92+ -h, --help display help for command
93+ ```
94+
95+ ### ` list `
96+
97+ ```
98+ Usage: api-docs-tooling list [options] <types>
99+
100+ List the given type
101+
102+ Arguments:
103+ types The type to list (choices: "generators", "rules", "reporters")
104+
105+ Options:
106+ -h, --help display help for command
107+ ```
0 commit comments