Home

UnauthScout Documentation

Welcome to the official documentation for UnauthScout – the unauthenticated reconnaissance tool for Git platforms.

⚡ Quick Start: Install in 30 seconds

📚 Documentation Philosophy

This wiki follows DRY (Don't Repeat Yourself) principles:

• README.md → Project overview, installation, quick examples
• Wiki → Comprehensive documentation, tutorials, deep dives
• Schemas/ → Source of truth for data contracts
• Code → Self-documenting where possible

Synced with code: This documentation is maintained alongside the codebase. Found an issue? Edit this page.

📢 What's New

Latest version: v0.3.0

• Unified Metadata & Intelligence Layer – Normalized schemas and analytical summaries
• Intelligent reporting with --summarize flag
• Cross-provider repository analysis (total stars, top languages, activity insights)
• Enhanced CLI with --pretty flag for formatted JSON output

Previous version: v0.2.0

• Repository enumeration – Listing of user repositories for GitHub and GitLab
• Expanded API field mapping documentation
• Multilingual documentation updates (EN/PT)
• Improved CLI with --repos flag support

📌 Important Notes

Ethical Use

UnauthScout is designed for legitimate security assessment, auditing, and research. Use responsibly:

• Respect platform rate limits
• Only query public data
• Follow each provider's Terms of Service

Limitations

• No authentication support (by design)
• Rate-limited by providers
• Public data only
• No correlation across platforms

Support & Community

• Issues: Bug reports & feature requests
• Discussions: Q&A and ideas
• Contributing: See how to help

⚡ Quick Reference

# Installation (from source)
git clone https://github.com/rmottanet/unauthscout.git
cd unauthscout
chmod +x bin/unauthscout

# Add to PATH (optional)
export PATH="$PATH:$(pwd)/bin"

# First scan
unauthscout octocat --provider github