GPRM CLI: GitHub Profile README Maker

GPRM CLI is a command-line interface tool for generating beautiful GitHub profile READMEs. It's the CLI version of the popular GPRM web application, bringing all the power and flexibility of GPRM to your terminal.

🚀 Features

• Generate comprehensive GitHub profile READMEs
• Include GitHub stats, streaks, trophies, and more
• Add social media links and funding options
• Showcase your tech stack
• Multiple themes support
• Easy to use CLI interface

🛠 Installation

You can install GPRM CLI globally using npm or yarn:

npm install -g gprm-cli
# or
yarn global add gprm-cli

🎨 Supported Themes

You can specify a theme using the --theme option.

| Theme | Theme | Theme | Theme | |-------|-------|-------|-------| | default | default_repocard | transparent | shadow_red | | shadow_green | shadow_blue | dark | radical | | merko | gruvbox | gruvbox_light | tokyonight | | onedark | cobalt | synthwave | highcontrast | | dracula | prussian | monokai | vue | | vue-dark | shades-of-purple | nightowl | buefy | | blue-green | algolia | great-gatsby | darcula | | bear | solarized-dark | solarized-light | chartreuse-dark | | nord | gotham | material-palenight | graywhite | | vision-friendly-dark | ayu-mirage | midnight-purple | calm | | flag-india | omni | react | jolly | | maroongold | yeblu | blueberry | slateorange | | kacho_ga | outrun | ocean_dark | city_lights | | github_dark | github_dark_dimmed | discord_old_blurple | aura_dark | | panda | noctis_minimus | cobalt2 | swift | | aura | apprentice | moltack | codeSTACKr | | rose_pine | catppuccin_latte | catppuccin_mocha | date_night | | one_dark_pro | rose | holi | neon | | blue_navy | calm_pink | ambient_gradient | |

Example usage:

gprm generate --username yourusername --theme nord

If no theme is specified, a random theme will be selected.

🚦 Usage

Here's a basic example of how to use GPRM CLI:

gprm generate --username yourusername --theme merko --stats --streaks

This will generate a README.md file in the current directory with your GitHub stats, streaks with merko theme.

For a more comprehensive README, you can use:

gprm generate \
  --username yourusername \
  --theme radical \
  --stats \
  --streaks \
  --trophies \
  --top-langs \
  --top-repos \
  --visitors \
  --social twitter:yourtwitter linkedin:yourlinkedin github:yourgithub instagram:yourinstagram \
  --tech "JavaScript, TypeScript, Shell Script, React, Node.js, Python, Docker" \
  --funding paypal:yourusername ko-fi:yourusername github:yourgithub patreon:yourpatreon \
  --output ./custom-README.md

This command will generate a detailed README.md file that includes:

• GitHub username
• Custom theme (radical)
• GitHub stats
• GitHub streaks
• GitHub trophies
• Top languages
• Top contributed repositories
• Visitors count
• Social media links (Twitter, LinkedIn, GitHub, Instagram)
• Technologies/skills
• Funding links (PayPal, Ko-fi, GitHub Sponsors, Patreon)
• Custom output file path

To see all the available options, you can use:

gprm generate --help

🎛 Options

| Flag | Description | |------|-------------| | -u, --username <username> | Your GitHub username (required) | | -t, --theme <theme> | Theme for the README | | -s, --stats | Include GitHub stats | | -k, --streaks | Include GitHub streaks | | -r, --trophies | Include GitHub trophies | | -l, --top-langs | Include top languages | | -p, --top-repos | Include top contributed repositories | | -v, --visitors | Include visitors count | | -m, --social <socials...> | Include social media links (format: platform:username) | | -c, --tech <technologies...> | Technologies you know (comma-separated list) | | -f, --funding <links...> | Include funding links (format: platform:username) | | -o, --output <path> | Output file path (default: ./README.md) |

Supported Technologies

When specifying languages or technologies in your configuration, please use the exact names as listed in the Languages section below.

🔮 Upcoming Features

• Interactive mode for easier README generation.
• Support for .gprmrc configuration file.

🛠️ Development

This project is bootstrapped with Modern.js and uses Biome for linting and formatting.

To set up the development environment:

git clone [email protected]:Technologeek/github-readme-maker-cli.git
cd github-readme-maker-cli
yarn install

To Build the project:

## Execute the build.
yarn build
## Execute the build in listening mode.
yarn build --watch

📝 Note

After generating your README, feel free to edit it further on GitHub to personalize it even more.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

🙏 Acknowledgements

• GPRM Web App - The original inspiration for this CLI tool.

Languages

| | | | | |------------|------------|------------|------------| | Apache Groovy | Assembly Script | C | C# | | C++ | Clojure | Crystal | CSS3 | | Dart | Elixir | Elm | Erlang | | Fortran | Go/Golang | GraphQL | Haskell | | HTML5 | Java | JavaScript | Julia | | Kotlin | LaTeX | Lua | Markdown | | Nim | Nix | Objective-C | OCaml | | Octave | Org Mode | Perl | PHP | | PowerShell | Python | R | ReScript | | Ruby | Rust | Scala | Shell Script | | Solidity | Swift | TypeScript | Windows Terminal | | YAML | Zig | | |

Frameworks & Libraries

| | | | | |------------|------------|------------|------------| | .NET | AdonisJS | Alpine.js | Anaconda | | Angular | Angular.js | Ant Design | Apollo GraphQL | | Astro | Aurelia | Backbone.js | Bootstrap | | Buefy | Bun | Capacitor | Celery | | Chakra UI | Chart.js | CodeIgniter | Context API | | DaisyUI | Deno JS | Directus | Django | | DjangoREST | Drupal | Electron.js | Ember | | Expo | Express.js | FastAPI | Fastify | | Flask | Flutter | Framer | Gatsby | | Green Sock | Gulp | Haxe | Hugo | | Ionic | Jasmine | Jest | Joomla | | jQuery | JWT | Laravel | Less | | MUI | Meteor JS | Mantine | NestJS | | Next.js | Node.js | Nodemon | Node-RED | | Nuxt.js | OpenCV | OpenGL | P5.js | | PNPM | Pandas | Phoenix | Pinia | | Playwright | Polymer | Prefect | Prisma | | Processing | PyCharm | PyTorch | Qiskit | | Quasar | RabbitMQ | Rails | React | | React Native | React Query | React Router | ReactiveX | | Redux | Remix | Rollup | ROS | | Ruby on Rails | RxJS | RxDB | Sass | | Scikit-learn | SciPy | Selenium | Semantic UI React | | Sentry | Socket.io | Solid JS | Spring | | Spring Boot | Strapi | Styled Components | Stylus | | Svelte | Symfony | Tailwind CSS | Tauri | | TensorFlow | Three.js | Thymeleaf | Uno CSS | | Unity | Unreal Engine | Vaadin | Vim | | Vite | Vue.js | Vuetify | Webpack | | Windi CSS | Xamarin | Yarn | |

Hosting & Cloud Platforms

| | | | | |------------|------------|------------|------------| | Alibaba Cloud | Azure | Cloudflare | Codeberg | | Datadog | DigitalOcean | Firebase | Glitch | | Google Cloud | Heroku | Linode | Netlify | | Oracle | OpenStack | OVH | PythonAnywhere | | Render | Scaleway | Vercel | Vultr |

Databases & ORMs

| | | | | |------------|------------|------------|------------| | Amazon DynamoDB | Cassandra | Cockroach Labs | Couchbase | | Firebase | InfluxDB | MariaDB | MusicBrainz | | Microsoft SQL Server | MongoDB | MySQL | Neo4j | | PlanetScale | Postgres | Realm | Redis | | Single Store | SQLite | Supabase | SurrealDB | | Teradata | Hibernate | Prisma | Sequelize | | Quill | | | |

Design Tools

| | | | | |------------|------------|------------|------------| | Adobe Suite | Affinity Designer | Affinity Photo | Aseprite | | Blender | Canva | Dribbble | Figma | | Framer | GIMP | Inkscape | InVision | | Krita | Material Design | Proto.io | Sketch | | Storybook | | | |

DevOps & Version Control

| | | | | |------------|------------|------------|------------| | Apache (various) | Bitbucket | CircleCI | CodePen | | Docker | ESLint | Elasticsearch | Gerrit | | GitBook | Gitea | GitHub | GitHub Actions | | GitHub Pages | GitLab | Gradle | Grafana | | Gunicorn | Jenkins | Kubernetes | Mercurial | | NGINX | Perforce Helix | Prometheus | Terraform |

Other Tools & Platforms

| | | | | |------------|------------|------------|------------| | Airbnb | Alfred | Ansible | Aqua Sec | | Arduino | Babel | Bitwarden | Cisco | | CMake | CodeCov | Confluence | Crowdin | | Espressif | Home Assistant | Homebridge | Jellyfin | | Jira | Meta | Mosquitto | Notion | | OpenSea | Packer | Pi-Hole | Plex | | Postman | Power BI | Prezi | Rancher | | Raspberry Pi | SonarLint | SonarQube | Splunk | | Swagger | Tor | Trello | Twilio | | Uber | Ubiquiti | Vagrant | WireGuard | | XFCE | Zigbee | | |

When specifying technologies in your GPRM configuration, use the exact names as listed above. The search is case-insensitive, so you can use lowercase if you prefer.

For the most up-to-date list of supported technologies, refer to the techData.ts file in the GPRM source code.