uselink-repo-summary

Repo Summary → Uselink

Scan a codebase, generate a clean architecture overview as HTML, and publish it to uselink as a shareable link.

When to Use

• "Summarize this repo and share it"
• "Create an architecture overview for the PM"
• "Share the codebase structure with the new hire"
• User provides a GitHub URL and wants a summary page

Prerequisites

which uselink || echo "MISSING"
test -f ~/.uselink/config.json && echo "OK" || echo "NO_CONFIG"

If either fails, tell the user to install (npm install -g uselink) or configure (uselink login). Do not proceed.

Workflow

1. Get the repo

Local repo (current directory):

git remote get-url origin 2>/dev/null
basename "$(git rev-parse --show-toplevel)"

Remote GitHub URL:

gh repo clone <owner/repo> /tmp/uselink-repo-<name> -- --depth 1
cd /tmp/uselink-repo-<name>

2. Gather data

# Project name and description
gh repo view --json name,description 2>/dev/null

# Languages
gh repo view --json languages 2>/dev/null
find . -type f -not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/build/*" \
  | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -10

# Directory structure (top 2 levels)
find . -maxdepth 2 -type d -not -path "*/.git*" -not -path "*/node_modules*" -not -path "*/build*" | sort

# Key files
for f in README.md CLAUDE.md package.json build.gradle.kts settings.gradle.kts Cargo.toml go.mod pyproject.toml Makefile docker-compose.yml; do
  test -f "$f" && echo "FOUND: $f"
done

# Git stats
git log --oneline -20
git shortlog -sn --no-merges | head -10
git log -1 --format="%ai"

3. Read key files

Read the first 100 lines of:

• README.md (project description)
• CLAUDE.md (architecture notes, if present)
• Main config file (package.json, build.gradle.kts, etc.)
• Entry point files (scan for main, index, app)

4. Generate HTML

Write to /tmp/uselink-repo-summary-<name>-<timestamp>.html.

Use the base HTML template with these sections: