Skip to content

QUICKSTART.md

Latest commit

 

History

History
114 lines (85 loc) · 2.67 KB

QUICKSTART.md

File metadata and controls

114 lines (85 loc) · 2.67 KB
Raw

Quick Start Guide

Installation (One-Time Setup)

# 1. Navigate to the directory
cd /home/coder/projects/repo_map

# 2. Run installer
./installer.sh

# 3. Set your Claude API key
export ANTHROPIC_API_KEY='your-anthropic-api-key-here'

Usage

Easy Mode (All-in-One)

./run.sh

Manual Mode (Step-by-Step)

# Activate environment
source activate.sh

# Step 1: Fetch repos from GitHub
./repo_mapper.sh

# Step 2: Analyze with AI
python3 analyze_repos.py

# Step 3: Generate outputs
python3 generate_xmind.py

View Results

  • XMind: Import output/repo_map.xmind.json into XMind app
  • Markdown: Open output/repo_map.md in any text editor
  • Stats: View output/repo_statistics.json

Automation Setup

GitHub Actions (Cloud)

  1. Push this repo to GitHub
  2. Add ANTHROPIC_API_KEY secret in Settings → Secrets
  3. Runs automatically every Monday at 9 AM UTC

Cron Job (Local)

crontab -e

# Add this line:
0 9 * * 1 cd /home/coder/projects/repo_map && ./run.sh

Troubleshooting

Issue Solution
gh: command not found Install GitHub CLI: https://cli.github.com/
gh is not authenticated Run: gh auth login
ANTHROPIC_API_KEY not set Export your key: export ANTHROPIC_API_KEY='...'
Virtual environment not found Run: ./installer.sh again

Configuration

Edit config.yaml to customize:

  • Analysis frequency (default: 7 days)
  • AI model selection
  • Repository filters
  • Output formats
  • And more!

Files Overview

File Purpose
installer.sh Sets up environment and dependencies
run.sh Runs complete pipeline
activate.sh Activates virtual environment
repo_mapper.sh Fetches GitHub repos and READMEs
analyze_repos.py AI-powered categorization
generate_xmind.py Creates visualizations
config.yaml Configuration options
.github/workflows/weekly-update.yml GitHub Actions automation

What It Does

  1. Discovers all your GitHub orgs and repos
  2. Reads every README file
  3. Analyzes each project with Claude AI
  4. Categorizes by cybersecurity domain
  5. Visualizes as an XMind mind map
  6. Updates weekly automatically

Output Categories

The system maps your repos to:

  • 14 Cybersecurity Categories (Offensive, Defensive, AppSec, NetSec, CloudSec, etc.)
  • 4 General Categories (Development, Data Science, Infrastructure, Other)

Each repo gets:

  • Primary category
  • Specific subcategory
  • Confidence level (high/medium/low)
  • Cybersecurity relevance (direct/indirect/none)
  • Relevant tags

Need more details? Check the full README.md