Find every broken link and redirect on your website.

# Crawl a site, skip /docs (still listed), save an Excel report
npx check-http-status https://www.example.com --exclude /docs -o report.xlsx

# Optional: add a sitemap to also find orphan pages; HTML report
npx check-http-status crawl example.com -s https://example.com/sitemap_index.xml -o report.html

# Only check specific URLs, or every URL in a sitemap
npx check-http-status check https://example.com/old-page https://example.com/pricing
npx check-http-status check -s https://example.com/sitemap.xml --issues-only

# Password-protected staging site
CHS_AUTH=user:pass npx check-http-status https://staging.example.com

# Install globally
npm install -g check-http-status
check-http-status --help

const checkHttpStatus = require('check-http-status');

// Just the website URL: pages are found by crawling, no sitemap needed
const report = await checkHttpStatus({
  crawl: 'https://www.example.com',
  exclude: ['/docs'],
  maxPages: 2000,
  export: [
    { format: 'xlsx', location: './reports/' },
    { format: 'html', file: './reports/report.html' }
  ],
  options: {
    auth: { username: 'user', password: 'pass' },
    headers: { 'Accept-Language': 'en' },
    timeout: 15000
  }
});

// report.summary.counts → { OK: 412, Redirect: 9, 'Not Found': 3, ... }
for (const r of report.results.filter((r) => r.category === 'Not Found')) {
  console.log(r.url, 'found on', r.foundOn.map((s) => s.page));
}

# .github/workflows/links.yml
name: Check links
on:
  schedule: [{ cron: '0 6 * * 1' }]
  workflow_dispatch:
jobs:
  links:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-node@v4
        with: { node-version: 20 }
      - run: npx check-http-status https://www.example.com --fail -o report.html
      - uses: actions/upload-artifact@v4
        if: always()
        with: { name: link-report, path: report.html }