sitescope

v1.0.0

Published

a month ago

One-command website health report. Performance, SEO, security, and accessibility — zero config, zero dependencies.

0High
0Medium
0Low

seo audit performance website health-check security-headers accessibility cli npx web-audit site-audit lighthouse-alternative zero-config

  sitescope
  -------------------------------------------------------
  Report for https://example.com
  -------------------------------------------------------
  Overall Grade:  A  (92/100)
  -------------------------------------------------------
  Category          Score   Grade
  -------------------------------------------------------
  SEO               92      A
  Performance       88      A
  Security          75      C
  Accessibility     95      A
  Links            100      A
  Indexing         100      A
  -------------------------------------------------------

npx sitescope https://yoursite.com

That's it. No install. No config. No API keys.

✨ Why sitescope?

Every existing website audit tool requires Docker, Playwright, browser downloads, API keys, or a PhD in YAML. We built the opposite.

| Feature | sitescope | Lighthouse CLI | seo-audit-skill | site-audit-seo | | :--- | :---: | :---: | :---: | :---: | | Zero dependencies | ✅ | ❌ | ❌ | ❌ | | Works with npx | ✅ | ❌ | ❌ | ❌ | | No browser/Playwright needed | ✅ | ❌ | ❌ | ❌ | | No API keys | ✅ | ✅ | ❌ | ✅ | | HTML report export | ✅ | ✅ | ✅ | ✅ | | JSON output for CI | ✅ | ✅ | ✅ | ✅ | | Security header checks | ✅ | ❌ | ✅ | ❌ | | Broken link detection | ✅ | ❌ | ✅ | ✅ | | robots.txt / sitemap checks | ✅ | ❌ | ❌ | ❌ | | Runs in < 5 seconds | ✅ | ❌ | ❌ | ❌ |

Philosophy: Most audit tools try to be everything. They end up slow, complex, and full of checks nobody cares about. sitescope checks what actually matters for 90% of websites and gives you a clear letter grade in seconds.

🚀 Quick Start

# Audit any website — no install needed
npx sitescope https://yoursite.com

Or install globally:

npm install -g sitescope
sitescope https://yoursite.com

🔍 What It Checks

sitescope runs 37+ checks across 6 categories and grades each A through F.

SEO

Performance

Security

Accessibility

Links

Indexing

📖 Usage & Options

# Basic audit
npx sitescope example.com

# Save HTML report
npx sitescope https://mysite.com --output report.html

# JSON output (for CI/CD pipelines)
npx sitescope mysite.com --json

# Run specific categories only
npx sitescope mysite.com --checks seo,security,indexing

# Verbose mode (checks more links)
npx sitescope mysite.com --verbose

# CI mode — exit code 1 if score below threshold
npx sitescope mysite.com --ci --min-score 80

📊 HTML Report

Generate a beautiful, standalone dark-theme HTML report:

npx sitescope https://mysite.com --output report.html

The report includes:

Overall letter grade with score
Category breakdown with individual grades
Every check with pass/warn/fail status
Actionable fix suggestions
Shareable — single HTML file, no external assets

🔄 CI/CD Integration

GitHub Actions

name: Website Audit
on:
  push:
    branches: [main]
  pull_request:

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - name: Run sitescope
        run: npx sitescope https://staging.yoursite.com --ci --min-score 80

      - name: Generate report
        if: always()
        run: npx sitescope https://staging.yoursite.com --output audit-report.html

      - name: Upload report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: audit-report
          path: audit-report.html

GitLab CI

audit:
  image: node:20
  script:
    - npx sitescope https://staging.yoursite.com --ci --min-score 80 --output audit-report.html
  artifacts:
    paths:
      - audit-report.html
    when: always

JSON Processing

# Get the overall score programmatically
SCORE=$(npx sitescope mysite.com --json | node -e "
  let d='';process.stdin.on('data',c=>d+=c);
  process.stdin.on('end',()=>console.log(JSON.parse(d).overallScore))
")
echo "Score: $SCORE"

💻 Programmatic API

Use sitescope as a library in your Node.js projects:

import { runAudit } from "sitescope";

const result = await runAudit("https://example.com", {
  checks: "seo,security",
  json: true,
});

console.log(result.overallScore); // 85
console.log(result.categories);   // [{ category: "SEO", score: 89, results: [...] }, ...]

📋 Comparison with Alternatives

When to use sitescope: You want a fast health check with zero setup. Perfect for CI pipelines, quick audits, and portfolio sites.

When NOT to use sitescope: You need full browser rendering metrics (LCP, CLS measured in-browser), multi-page crawls, or deep JavaScript-rendered content analysis. Use Lighthouse or Playwright-based tools for that.

🗺️ Roadmap

Planned

[ ] Custom rules config (.sitescoperc)
[ ] Multi-page crawl
[ ] Lighthouse integration (optional, opt-in)
[ ] Watch mode for local development
[ ] GitHub Action (uses: omlahore/sitescope-action@v1)
[ ] Badge generation (![Score](https://sitescope.dev/badge/...))
[ ] PDF report export

Completed

[x] SEO checks (title, meta, H1, canonical, OG, alt text, structured data)
[x] Performance checks (TTFB, page size, render-blocking scripts, lazy loading)
[x] Security header checks (HTTPS, HSTS, CSP, XFO, XCTO, Referrer-Policy, Permissions-Policy)
[x] Accessibility checks (lang, viewport, charset, headings, favicon)
[x] Broken link detection
[x] robots.txt and sitemap.xml checks
[x] --ci --min-score <n> flag for CI/CD gating
[x] Beautiful terminal output with letter grades
[x] Standalone HTML report export
[x] JSON output for CI/CD
[x] Zero dependencies — Node.js built-ins only

Contributions and feature requests welcome! Open an issue to discuss.

🤝 Contributing

We welcome contributions! Here's how to get started:

Fork the repository and create your branch from main.

Clone and run — no npm install needed for the core tool:

git clone https://github.com/omlahore/sitescope.git
cd sitescope
node bin/cli.js https://example.com

Make your changes and add tests.
Open a Pull Request with a clear description.

Project Structure

sitescope/
├── bin/cli.js              # CLI entry point
├── public/
│   ├── logo.svg            # Project logo
│   └── screenshot.svg      # Terminal output preview
├── src/
│   ├── index.js            # Main orchestrator
│   ├── config.js           # Thresholds and constants
│   ├── checks/
│   │   ├── seo.js          # SEO audit checks
│   │   ├── performance.js  # Performance checks
│   │   ├── security.js     # Security header checks
│   │   ├── accessibility.js # Accessibility checks
│   │   ├── links.js        # Broken link checker
│   │   └── indexing.js     # robots.txt & sitemap checks
│   ├── reporters/
│   │   ├── terminal.js     # Terminal output
│   │   └── html.js         # HTML report generator
│   └── utils/
│       ├── colors.js       # ANSI color constants
│       ├── grading.js      # Shared grade/score logic
│       ├── fetcher.js      # HTTP client (Node built-in fetch)
│       ├── parser.js       # HTML parser (regex-based)
│       └── terminal.js     # Spinner, formatting helpers
├── package.json
├── README.md
├── CONTRIBUTING.md
└── LICENSE

Adding a New Check

Create or edit a file in src/checks/
Return { category: string, results: Array<{ id, status, label, detail }> }
status must be "pass", "warn", or "fail"
Register in src/index.js

Rules

Zero runtime dependencies. This is a hard rule. Node.js 18+ built-ins only.
Keep it fast. Audits complete in under 10 seconds for most sites.
Be opinionated. Every check should matter. Don't add noise.

See CONTRIBUTING.md for full guidelines.

⭐ Star History

If you find sitescope useful, consider giving it a star — it helps others discover the project!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Table of Contents

✨ Why sitescope?

🚀 Quick Start

🔍 What It Checks

SEO

Performance

Security

Accessibility

Links

Indexing

📖 Usage & Options

📊 HTML Report

🔄 CI/CD Integration

GitHub Actions

GitLab CI

JSON Processing

💻 Programmatic API

📋 Comparison with Alternatives

🗺️ Roadmap

Planned

Completed

🤝 Contributing

Project Structure

Adding a New Check

Rules

⭐ Star History

📜 License