profile-readme-ai

     

Analyze your repos. Detect your stack. Generate a stunning profile.
One command. AI-powered. 8 themes. 10 languages.

⚡ Quick Start  🔄 Pipeline  🎨 Themes  🧠 AI  📖 Commands  ⚙️ Config

⚡ Quick Start

$ npx profile-readme-ai generate

Zero config. Zero install. One command.

 // more install options

# global install
$ npm install -g profile-readme-ai

# use the short alias
$ prai generate -u your-username -t neon

# dry-run: preview without saving
$ prai generate -u your-username --dry-run

# skip AI, just use GitHub data
$ prai generate -u your-username --no-ai

🔄 Pipeline

  input               process             enhance             output
  ─────               ───────             ───────             ──────

  GitHub API    ───▶   detect      ───▶   GPT-4o      ───▶   README.md
  ├─ profile          ├─ languages       ├─ bio              ├─ themed
  ├─ repos            ├─ frameworks      ├─ tagline          ├─ badges
  └─ stars            └─ topics          └─ suggestions      └─ stats

// what happens under the hood
const analysis  = await analyzeGitHubProfile(username);   // fetch + detect
const { bio }   = await generateBio(analysis, apiKey);    // AI enhance
const readme    = generateReadme(analysis, { theme });    // render
await fs.writeFile('README.md', readme);                  // done

🎨 Themes

  8 built-in themes. Or bring your own.

┌─────────────┐ │ ▪ ▪ ▪ │ │ ───────── │ │ minimal │ └─────────────┘  🎯 Minimal	┌─────────────┐ │ $ whoami │ │ > hacker │ │ $ _ │ └─────────────┘  💻 Hacker	┌─────────────┐ │ ✨ ★ ✨ │ │ creative │ │ ~motion~ │ └─────────────┘  🎨 Creative	┌─────────────┐ │ ┃ Name │ │ ┃ Title │ │ corporate │ └─────────────┘  👔 Corporate
┌─────────────┐ │ ░█▀▀░█▀▀ │ │ ░▀▀█░█▀▀ │ │ retro │ └─────────────┘  🕹️ Retro	┌─────────────┐ │ ╔═══╗ │ │ ║neon║ │ │ ╚═══╝ │ └─────────────┘  💜 Neon	┌─────────────┐ │ ◼◼◼◼◼◼◼ │ │ dark │ │ ◼◼◼◼◼◼◼ │ └─────────────┘  🌑 Dark	┌─────────────┐ │ ◻◻◻◻◻◻◻ │ │ light │ │ ◻◻◻◻◻◻◻ │ └─────────────┘  ☀️ Light

 // custom themes

$ prai init-theme -o my-theme.json
$ prai generate --theme-file my-theme.json

// my-theme.json — full control
{
  "name": "My Theme",
  "headerStyle": "banner",       // banner | text | ascii | none
  "headerColor": "gradient",     // hex | gradient
  "headerAnimation": "twinkling",// twinkling | fadeIn | blink | none
  "badgeStyle": "for-the-badge", // flat | flat-square | for-the-badge
  "statsTheme": "tokyonight",   // github-readme-stats theme
  "sections": { "about": true, "techStack": true, "stats": true, "connect": true }
}

🧠 AI Features

Powered by gpt-4o-mini  ·  Run prai configure to set your key

$ prai analyze -u username 🔍 Deep Analysis Reads repo READMEs, generates an accurate bio based on your actual work, and provides actionable profile improvement suggestions.

$ prai translate -u username 🌍 Multi-Language Generate your bio in 10 languages simultaneously: EN IT ES DE FR PT ZH JA KO RU

$ prai social -u username 🖼️ Social Cards Optimized preview images for Twitter, LinkedIn. Stats cards, language charts, streak counters, trophy shelves.

📖 Commands

  Command              Alias    Description                          AI
  ───────              ─────    ───────────                          ──
  prai generate         g       Generate profile README              ○
  prai analyze          a       Deep analysis + suggestions          ●
  prai translate        t       Multi-language bio                   ●
  prai social           s       Social preview cards
  prai stats                    GitHub statistics
  prai actions                  GitHub Actions workflow
  prai configure        c       Set up API keys
  prai preview          p       Preview any profile README
  prai init-theme               Scaffold custom theme
  prai themes                   List all themes

  ● requires OpenAI key     ○ optional AI enhancement

 // options reference

  Flag                         Description
  ────                         ───────────
  -u, --username <name>        GitHub username
  -t, --theme <name>           minimal | hacker | creative | corporate
                               retro | neon | dark | light
      --theme-file <path>      Custom theme JSON
  -o, --output <path>          Output file (default: ./README.md)
      --dry-run                Preview only, no file write
      --no-ai                  Skip AI generation
      --no-stats               Skip stats cards
      --json                   JSON output (stats)
  -l, --language <code>        Bio language (analyze)
  -s, --schedule <cron>        Cron schedule (actions)

⚙️ Configuration

$ prai configure

  Key                 Status              Purpose
  ───                 ──────              ───────
  OpenAI API Key      Required for AI     Bio, analysis, translation
  GitHub Token        Optional            Rate limit: 60 → 5,000 req/h

_{🔑 platform.openai.com/api-keys · 🔑 github.com/settings/tokens}

📋 Requirements

  ✓  Node.js 18+
  ✓  GitHub account
  ○  OpenAI API key (optional — AI features only)

🏗️ Stack

🤝 Contributing

$ git clone https://github.com/sena-labs/profile-readme-ai.git
$ cd profile-readme-ai && npm install
$ npm run dev generate    # dev mode
$ npm run build           # compile

See CONTRIBUTING.md for guidelines.

📜 License

Apache License 2.0 — Copyright 2026 sena-labs

See LICENSE.

 

_{Built by sena-labs  ·  If this helped you, a ⭐ means a lot}

[sena-labs@github ~]$ exit