GitHub - Vswaroop04/link-guardian: A tool to scan GitHub repositories and websites for broken links

# Clone the repository (or navigate to the project folder)
cd link-guardian

# Build in release mode (optimized)
cargo build --release

# The binary will be at target/release/link-guardian

cargo install --path .

# Now you can run 'link-guardian' from anywhere

# Check links in a GitHub repo's README
link-guardian github https://github.com/rust-lang/rust

# With JSON output
link-guardian github https://github.com/rust-lang/rust --json

# With custom concurrency (default: 500)
link-guardian github https://github.com/rust-lang/rust --concurrency 1000

# Scan just the homepage
link-guardian site https://example.com

# Scan homepage + all linked pages (depth 2)
link-guardian site https://example.com --max-depth 2

# With JSON output
link-guardian site https://example.com --json

# With custom concurrency for faster checking
link-guardian site https://example.com --concurrency 1000 --max-depth 2

link-guardian --help

Commands:
  github  Scan a GitHub repository for broken links
  site    Scan a website for broken links
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

link-guardian github --help

Scan a GitHub repository for broken links in README and docs/

Usage: link-guardian github [OPTIONS] <REPO_URL>

Arguments:
  <REPO_URL>  GitHub repository URL (e.g., https://github.com/user/repo)

Options:
      --json  Output results in JSON format instead of a table
  -h, --help  Print help

link-guardian site --help

Scan a website for broken links

Usage: link-guardian site [OPTIONS] <WEBSITE_URL>

Arguments:
  <WEBSITE_URL>  Website URL to scan (e.g., https://example.com)

Options:
      --json              Output results in JSON format instead of a table
      --max-depth <MAX_DEPTH>  Maximum crawl depth (default: 1) [default: 1]
  -h, --help              Print help

🔍 Scanning website: https://example.com
📊 Max crawl depth: 1
📄 Crawled 1 page(s)
   5 links found on https://example.com

🌐 Checking 5 unique link(s)...

URL                                                          STATUS          MESSAGE
=========================================================================================================
https://example.com/about                                    ✅ OK           HTTP 200
https://example.com/contact                                  ✅ OK           HTTP 200
https://example.com/old-page                                 🔀 REDIRECT     HTTP 301 -> /new-page
https://example.com/missing                                  ❌ BROKEN       HTTP 404
https://example.com/timeout                                  ⏱️  TIMEOUT     Request timed out

📊 Summary:
   ✅ OK: 2
   ❌ Broken: 3
   📋 Total: 5

link-guardian site https://example.com --json

[
  {
    "url": "https://example.com/about",
    "status": "ok",
    "message": "HTTP 200"
  },
  {
    "url": "https://example.com/old-page",
    "status": "redirect",
    "redirect": "https://example.com/new-page",
    "message": "HTTP 301 -> https://example.com/new-page"
  },
  {
    "url": "https://example.com/missing",
    "status": "broken",
    "message": "HTTP 404"
  }
]

#!/bin/bash
# In your CI script

link-guardian github https://github.com/youruser/yourrepo

if [ $? -eq 1 ]; then
  echo "❌ Broken links detected!"
  exit 1
else
  echo "✅ All links are healthy!"
fi

link-guardian/
├── Cargo.toml              # Project metadata and dependencies
├── README.md               # This file
└── src/
    ├── main.rs             # Entry point, orchestrates everything
    ├── cli.rs              # Command-line parsing (clap)
    ├── checker/
    │   ├── mod.rs          # Checker module exports
    │   ├── http.rs         # HTTP link checking logic
    │   ├── markdown.rs     # Extract links from Markdown
    │   └── html.rs         # Extract links from HTML
    ├── github/
    │   ├── mod.rs          # GitHub module exports
    │   └── fetch.rs        # Fetch files from GitHub repos
    └── crawl/
        ├── mod.rs          # Crawl module exports
        └── queue.rs        # Website crawling with BFS

# Run all tests
cargo test

# Run tests with output
cargo test -- --nocapture

# Run a specific test
cargo test test_check_valid_link

# Run without building a release binary
cargo run -- github https://github.com/rust-lang/rust

cargo run -- site https://example.com --max-depth 2

# Format code
cargo fmt

# Check for common mistakes
cargo clippy