Run the command from the directory where you want the README to land:
the-magic-readmeThe CLI then walks you through four steps. Every prompt has a sensible default — press Enter to accept it, or type your own value.
Step 1 — Choose an action
You’re asked what you want to do:
- Generate a README — pick a template and answer a few prompts.
- Create custom template — save your own Markdown recipe to reuse later (see Custom Templates).
Step 2 — Pick a template
Templates are grouped by category: Classic, Minimal, Modern, Production, and Useful / Specialty — with any of your custom templates listed last. Ten templates are available out of the box; see the Templates page for the full list.
Step 3 — Project details
You’re prompted for the values that fill the template:
| Prompt | Example default |
|---|---|
authorName |
Your Name |
repoName |
your-project |
repoUrl |
https://github.com/username/your-project |
logo |
https://placehold.co/96x96/png?text=Logo |
email |
[email protected] |
linkedin |
your-linkedin |
fileName |
classic.md |
Press Enter at any prompt to accept the default shown in brackets.
Step 4 — Preview & confirm
The CLI renders the finished Markdown for you to review. If the target file already exists, you’ll get an explicit warning that it will be overwritten. Confirm, and the file is written to your current working directory.
That’s it — open the file in your project and push it to GitHub.