Skip to main content

​
Using the Hosted Version

The fastest way to get started is using the hosted version at repolyze.ossium.live.
1

Visit Repolyze

Navigate to repolyze.ossium.live in your browser.
2

Enter Repository URL

Paste a GitHub repository URL into the input field:
https://github.com/vercel/next.js
You can analyze any public GitHub repository. Private repositories require authentication (coming soon).
3

Click Analyze

Press the Analyze button or hit Enter. You’ll see real-time progress as Repolyze:
  • Fetches repository metadata
  • Analyzes file structure
  • Examines dependencies
  • Generates insights with AI
  • Creates architecture diagrams
4

Explore Results

Review the comprehensive analysis:
  • Overall Health Score (0-100)
  • Repository metadata and statistics
  • Tech stack detection
  • AI-generated summary

​
Branch Analysis

Repolyze supports analyzing any branch, not just the default branch.
1

Enter Repository URL

Start by entering a repository URL and clicking analyze.
2

Select Branch

Once the initial analysis completes, click the Branch Selector dropdown in the header.
3

Choose Branch

Select a different branch from the list to re-analyze.
Branch analysis counts toward your daily analysis limit.

​
Rate Limits

Repolyze has tiered rate limits to ensure fair usage:
TierDaily AnalysesCost
Anonymous1 per dayFree
Free Account3 per dayFree
Pro Account44 per dayPaid
Sign in with GitHub to unlock 3 free analyses per day. Upgrade to Pro for 44 analyses.

​
Exporting Results

Share and save your analysis results in multiple formats:

PDF Export

Download a comprehensive PDF report with all insights, scores, and diagrams.How to Export:
  1. Click the share icon in the analysis header
  2. Select Download PDF
  3. Opens in new tab for download

Copy Markdown

Copy the entire analysis as formatted Markdown.How to Copy:
  1. Click the share icon
  2. Select Copy Markdown
  3. Paste into your documentation

Copy Plain Text

Copy a plain text version of the report.How to Copy:
  1. Click the share icon
  2. Select Copy Plain Text
  3. Paste anywhere

Share Card

Generate a beautiful share card image.How to Generate:
  1. Click the share icon
  2. Select Download Share Card
  3. Choose a variant (compact/default/detailed)

​
Social Sharing

Share your analysis results on social media:
1

Open Share Modal

Click the share icon in the analysis header.
2

Select Platform

Choose from:
  • Twitter/X
  • LinkedIn
  • Copy shareable link
3

Share

The share link includes the repository name and directs users to view the analysis.
https://repolyze.ossium.live/share/{owner}/{repo}

​
Running Locally

For self-hosting or development, run Repolyze locally.

​
Prerequisites

Repolyze requires Node.js 18.0 or higher.
# Check your version
node --version
If you need to install or upgrade Node.js, visit nodejs.org.
Repolyze uses pnpm for dependency management.
# Install pnpm globally
npm install -g pnpm

# Verify installation
pnpm --version
Required for authentication and rate limiting.
# Install PostgreSQL
# macOS
brew install postgresql@16

# Ubuntu/Debian
sudo apt install postgresql-16

# Start PostgreSQL
brew services start postgresql@16  # macOS
sudo systemctl start postgresql    # Linux

​
Installation

1

Clone Repository

git clone https://github.com/OssiumOfficial/Repolyze.git
cd Repolyze
2

Install Dependencies

pnpm install
This will also run prisma generate automatically to set up the database client.
3

Configure Environment

Copy the example environment file and add your API keys:
cp .env.example .env.local
Edit .env.local with your keys:
# OpenRouter API Key (get at: https://openrouter.ai/keys)
OPENROUTER_API_KEY=sk-or-v1-your-api-key-here

# GitHub Personal Access Token (get at: https://github.com/settings/tokens)
# Required scopes: repo, read:user
GITHUB_TOKEN=ghp_your-github-token-here

# Database URL
DATABASE_URL=postgresql://user:password@localhost:5432/repolyze

# NextAuth Secret (generate with: npx auth secret)
AUTH_SECRET=your-auth-secret-here
4

Set Up Database

Initialize the PostgreSQL database:
# Create database
createdb repolyze

# Run migrations
pnpm prisma migrate dev

# Generate Prisma client (runs automatically on install)
pnpm prisma generate
5

Start Development Server

pnpm dev
Open http://localhost:3000 in your browser.
The development server supports hot reloading. Changes to code are reflected instantly.

​
Getting API Keys

  1. Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
  2. Click Generate new token (classic)
  3. Give it a descriptive name (e.g., “Repolyze Local Dev”)
  4. Select scopes:
    • ✅ repo (Full control of private repositories)
    • ✅ read:user (Read user profile data)
  5. Click Generate token
  6. Copy the token immediately (you won’t see it again)
  7. Add to .env.local as GITHUB_TOKEN=ghp_...
Keep your token secure. Never commit it to version control.

​
Testing Your Setup

Verify everything is working: 
curl -X POST http://localhost:3000/api/analyze \
  -H "Content-Type: application/json" \
  -d '{"repoUrl": "https://github.com/vercel/next.js"}'
If all endpoints return valid JSON responses, your setup is complete!

​
Next Steps

Understanding Scores

Learn how Repolyze calculates health scores and what they mean.

API Reference

Integrate Repolyze into your development workflow.

Contributing

Help improve Repolyze by contributing to the project.

Feature Guide

Explore all features and capabilities in detail.
Need help? Join our GitHub Discussions or open an issue.

Build docs developers (and LLMs) love

Get started for freeTalk to us