🗺️ Codemap Generator - Apify Actor

Generate instant, AI-optimized codebase maps from any GitHub repository

Give ChatGPT, Claude, and other AI coding assistants instant understanding of your codebase without burning thousands of tokens.

🎯 What It Does

This Apify actor analyzes any public GitHub repository and generates a compact, structured "brain map" that shows:

• 📁 Complete directory structure
• 📊 File statistics and sizes
• 💻 Top programming languages
• 🔗 Import/dependency relationships (optional)
• ⚡ Highlighted important files

Perfect for:

• 🤖 AI coding assistants (ChatGPT, Claude, Cursor, etc.)
• 👥 Developer onboarding
• 📖 Project documentation
• 🔍 Code reviews and analysis

💡 Why Use This?

Before (Without Codemap)

You: "Help me add a new feature"
AI: "Where should I add this? Can you show me your structure?"
You: *paste 50 files, 10,000 tokens*
AI: *burns tokens analyzing*
Cost: $$$

After (With Codemap)

You: *paste codemap* "Help me add a new feature"
AI: "I see exactly where to add this - updating file X at line Y"
Cost: 85% less tokens = $

🚀 Quick Start

Using the Actor

1. Open the actor in Apify Console
2. Enter repository URL: https://github.com/user/repo
3. Click "Start"
4. Get your codemap in seconds!

Input Parameters

Parameter	Type	Required	Description
repositoryUrl	string	✅ Yes	GitHub repository URL
branch	string	No	Branch to analyze (default: main)
outputFormat	string	No	markdown, json, or both (default: markdown)
includeDependencies	boolean	No	Show import relationships (default: false)
languageFilter	string	No	Filter by language (e.g., python, javascript)
excludePatterns	array	No	Additional glob patterns to exclude
maxFileSize	number	No	Skip files larger than X MB (default: 10)

Example Input

{
  "repositoryUrl": "https://github.com/facebook/react",
  "branch": "main",
  "outputFormat": "both",
  "includeDependencies": true,
  "languageFilter": "javascript"
}

Example Output

{
  "repository": "facebook/react",
  "repositoryUrl": "https://github.com/facebook/react",
  "generatedAt": "2025-11-30T13:00:00.000Z",
  "fileCount": 1234,
  "totalSize": "45.2MB",
  "topLanguages": [
    { "language": "js", "count": 856 },
    { "language": "ts", "count": 234 }
  ],
  "directories": 142,
  "codemap": "# Codemap: facebook/react\n\n...",
  "usage": {
    "forAI": "Copy the codemap content and paste it...",
    "forDocs": "Use the markdown output for...",
    "forAPI": "Use the JSON output for..."
  }
}

📊 Use Cases

1. AI Coding Assistant Context

# ChatGPT Prompt
Here's the structure of my project (generated by Codemap):

[paste codemap here]

Now help me add user authentication to this app.

Result: AI understands your entire project instantly!

2. Project Documentation

Use the markdown output in your README or docs to show project structure.

3. Code Review

Quickly understand unfamiliar codebases before reviewing PRs.

4. Developer Onboarding

New team members get instant architecture overview.

5. API Integration

Use JSON output for automated tools and workflows.

💰 Pricing

Consumption

• Free tier: 10 runs/month
• Cost: ~$0.02-0.05 per run (depending on repo size)
• Average run time: 10-30 seconds

Subscription Options

• Basic: $9/month - 100 runs
• Pro: $29/month - 500 runs
• Enterprise: Custom pricing

🛠️ Technical Details

Supported Languages

✅ Python, JavaScript, TypeScript, Go, Rust, C/C++, C#, Java, Kotlin, Swift, Ruby, PHP, Dart, Bash, R

Repository Requirements

• Must be a public GitHub repository
• Maximum recommended size: 500MB
• Works with any branch

Performance

• Small repos (<100 files): ~5 seconds
• Medium repos (100-1000 files): ~15 seconds
• Large repos (>1000 files): ~30-60 seconds

Limitations

• Public repositories only (no private repo support yet)
• 5-minute timeout for very large repos
• GitHub rate limits apply

🔧 Local Development

Prerequisites

• Node.js 16+
• npm or yarn
• Apify CLI

Setup

# Clone this repo
git clone <this-repo>
cd codemap-apify-actor

# Install dependencies
npm install

# Download codemap binary
# (See Dockerfile for Linux binary download)
# For local testing, use your OS binary

# Run locally
npm start

Testing

# Set input
export APIFY_INPUT_KEY='{
  "repositoryUrl": "https://github.com/JordanCoin/codemap",
  "branch": "main"
}'

# Run
npm start

📈 Roadmap

Current Features

• ✅ GitHub repository cloning
• ✅ Codemap generation
• ✅ Markdown output
• ✅ JSON output
• ✅ Language filtering
• ✅ Dependency analysis

Planned Features

• 🔜 Private repository support (with token)
• 🔜 GitLab/Bitbucket support
• 🔜 Incremental updates (branch diff)
• 🔜 HTML output with syntax highlighting
• 🔜 PDF export
• 🔜 Webhook integration
• 🔜 Custom branding

🤝 Support

• Issues: Report on GitHub
• Questions: support@example.com
• Documentation: Full docs

📄 License

MIT License - feel free to use commercially!

🌟 Credits

Powered by Codemap by JordanCoin.

---

🎁 Special Offer

First 100 users: Get 50% off Pro tier for 3 months!

Use code: CODEMAP50 at checkout

---

Made with ❤️ for developers and AI enthusiasts