Skip to content

docs / faq

FAQ

Common questions: Node versions, output location, overwrites, and more.

Which Node.js versions are supported?

Node.js 16 or newer. The CLI has no native dependencies and is a plain npm package.

Where is the README written?

To your current working directory — the directory you ran the-magic-readme from. The exact file name comes from the fileName prompt (the default for the Classic template is classic.md).

What happens if the file already exists?

The preview step warns you explicitly that the existing file will be overwritten. You can back up the old file or walk away before confirming.

Can I skip the prompts?

Not fully — but every prompt shows a default in brackets and accepts it on Enter, so a fully-defaults run is just a few keystrokes.

Which template should I use for my project type?

See the Templates page for recommendations by project type.

Where do I report bugs or request features?

Please open an issue on GitHub — it’s the best place for reproduction details and discussion.