-
Notifications
You must be signed in to change notification settings - Fork 0
Reference CLI Flags
CLI flags let you control PowerAutoDocs behaviour at runtime without changing your config file. Useful for testing a single output format, or forcing a one-off AI refresh.
npx powerautodocs@latest [flags]| Flag | Description |
|---|---|
--wiki |
Generate wiki output only |
--word |
Generate Word output only |
--pdf |
Generate PDF output only |
These flags can be combined:
npx powerautodocs@latest --wiki --word --pdf # all three
npx powerautodocs@latest --wiki --word # wiki and Word onlyOverride behaviour — passing any output flag overrides the config file for that run. Only the formats you specify are generated; any formats enabled in config but not in the flags are suppressed. If no flags are passed, the config drives everything.
| Flag | Description |
|---|---|
--regenerate-ai |
Ignore the AI summary cache and regenerate all summaries from scratch |
Use --regenerate-ai when you want a full fresh pass — for example after upgrading PowerAutoDocs or when you've significantly changed your prompt config. This is the only way to force regeneration of summaries for components that haven't changed.
Passing an unrecognised flag causes PowerAutoDocs to exit immediately with an error listing the valid flags. This is intentional — it catches typos before a run starts.
Getting Started
Configuration
Reference