profile-readme-ai
v1.0.2
Published
π AI-powered GitHub Profile README generator - analyze your repos and generate stunning profiles in seconds
Maintainers
Readme
Β Β Β
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 generateZero config. Zero install. One command.
# 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Β
$ 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Β Β·Β Runprai configureto 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 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 # compileSee CONTRIBUTING.md for guidelines.
π License
Apache License 2.0 β Copyright 2026 sena-labsSee LICENSE.
Β
Built by sena-labs Β Β·Β If this helped you, a β means a lot
[sena-labs@github ~]$ exit