Skip to content

docs / installation

Installation

Install The Magic README globally with npm and verify the setup.

Requirements

  • Node.js 16 or newer — check with node --version. The CLI is a plain npm package with no native dependencies, so any recent LTS works.

Install

Install globally so the the-magic-readme command is available in any directory:

npm install -g the-magic-readme

Verify

Confirm the install worked:

the-magic-readme --version
the-magic-readme --help

You should see the version number and a list of the available commands and flags.

Uninstall

npm uninstall -g the-magic-readme

This removes the CLI itself. Custom templates stored in ~/.the-magic-readme/templates are left in place.