@muhammadusmangm/ghme

Generate a polished GitHub profile README in under a minute

ghme is a CLI tool that creates a beautiful, production-ready GitHub profile README.md in seconds. Just run it, answer a few prompts, and get a professional README with typing animations, tech stack badges, stats cards, and more.

Quick Start

npx @muhammadusmangm/ghme

That's it! Answer a few interactive prompts and get a polished README.

Non-Interactive Mode

# Use defaults
npx @muhammadusmangm/ghme --yes --username your-username

# Use a theme preset
npx @muhammadusmangm/ghme --yes --theme developer

Available Options

| Option | Description | |--------|-------------| | --yes, -y | Non-interactive mode with defaults | | --username <name> | GitHub username (for --yes mode) | | --theme <name> | Theme preset: amber-dark, minimal, developer | | --help, -h | Show help message |

Features

• Zero config — no setup required, just run and answer prompts
• Typing SVG headers — animated typing effect with customizable text, colors, and fonts
• Tech stack badges — shields.io badges organized by category (AI, Systems, Frontend, Backend, Infra)
• GitHub stats — stats cards, streaks, top languages, and trophies
• Social links — LinkedIn, portfolio, and email badges
• Smart git push — automatically commits and pushes if you're in a git repo with a remote
• Theme presets — quick start with pre-configured themes
• Image banners — support for custom header images

What It Generates

The tool creates a README.md with:

| Section | Description | |---------|-------------| | Header | Typing SVG animation, static heading, or image banner | | Bio | Short description of yourself | | Tech Stack | Shields.io badges grouped by category | | Social Links | LinkedIn, portfolio, and email badges | | GitHub Stats | Stats cards, streaks, top languages, and trophies |

Tech Stack Categories

• AI/Agents — Python, PyTorch, TensorFlow, OpenAI, LangChain
• Systems — Rust, C, C++, Go, Assembly
• Frontend — React, Vue, Angular, TypeScript, HTML/CSS
• Backend/DB — Node.js, Express, Django, PostgreSQL, MongoDB
• Infra/Tools — Docker, Kubernetes, AWS, Linux, Git

Example Output

Here's what a generated README might look like:

<div align="center">
  <img src="https://readme-typing-svg.herokuapp.com/demo?font=Fira+Code&weight=600&size=30&duration=3000&pause=1000&color=F5A623&center=true&vCenter=true&multiline=true&repeat=true&width=600&height=100&lines=Full+Stack+Developer%0AOpen+Source+Enthusiast" alt="Typing SVG" />
</div>

---

<div align="center">

Full Stack Developer passionate about open source

</div>

---

## Tech Stack

### Frontend

[![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white)](https://react.com)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescript.com)

### Backend/DB

[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://node.js.com)

## GitHub Stats

![GitHub Stats](https://github-readme-stats.vercel.app/api?username=octocat&show_icons=true&theme=radical)

Requirements

• Node.js >= 18

Development

Setup

# Clone the repository
git clone https://github.com/MuhammadUsmanGM/ghme.git
cd ghme

# Install dependencies
npm install

# Build
npm run build

# Test locally
npm link
ghme

Available Scripts

| Script | Description | |--------|-------------| | npm run build | Build the project | | npm run dev | Build with watch mode | | npm start | Run the built output |

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

MIT © MuhammadUsmanGM

If ghme saved you time, consider starring the repo → github.com/MuhammadUsmanGM/ghme