Foglift Documentation

# Scan a website (colored output with scores and issues)
npx foglift scan https://example.com

# Output as JSON (for scripting)
npx foglift scan https://example.com --json

# Output as Markdown
npx foglift scan https://example.com --format=markdown

# Verbose mode (show all issues, not just top 5)
npx foglift scan https://example.com --verbose

$ npx foglift scan https://example.com

  Foglift — Website Intelligence Scanner

  URL: https://example.com
  Scanned: 2026-03-15 14:30:00 (12 seconds)

  ┌──────────────────────────────────────────────┐
  │  Overall: B (74/100)                         │
  ├──────────────────────────────────────────────┤
  │  SEO:           █████████░  85/100  A        │
  │  GEO:           █████░░░░░  52/100  D        │
  │  Performance:   ████████░░  78/100  C        │
  │  Security:      ██████░░░░  60/100  C        │
  │  Accessibility: █████████░  91/100  A        │
  └──────────────────────────────────────────────┘

  Issues Found: 8 (2 critical, 3 warnings, 3 info)

  🔴 [GEO] AI crawlers blocked by robots.txt
  🔴 [GEO] Missing FAQ schema markup
  🟡 [Security] No Content-Security-Policy header
  🟡 [SEO] Missing Open Graph image tag
  🟡 [Security] No Permissions-Policy header

  Full report → https://foglift.io/scan/abc123

curl "https://foglift.io/api/v1/scan?url=https://example.com"

const response = await fetch(
  "https://foglift.io/api/v1/scan?url=https://example.com"
);
const data = await response.json();

console.log(data.scores);
// { overall: 72, seo: 85, geo: 65, performance: 78, security: 60, accessibility: 70 }

console.log(data.issues);
// [{ category: "GEO", severity: "critical", title: "AI crawlers blocked", description: "..." }]

console.log(data.aiSummary);
// "This site has strong SEO fundamentals but needs GEO optimization..."

import requests

response = requests.get(
    "https://foglift.io/api/v1/scan",
    params={"url": "https://example.com"}
)
data = response.json()

print(f"Overall: {data['scores']['overall']}/100")
for issue in data["issues"]:
    print(f"  [{issue['severity']}] {issue['title']}")

{
  "url": "https://example.com",
  "scanId": "scan_abc123",
  "scannedAt": "2026-03-15T12:00:00Z",
  "scores": {
    "overall": 72,          // Weighted average (0-100)
    "seo": 85,              // Traditional SEO health (0-100)
    "geo": 65,              // AI search readiness (0-100)
    "performance": 78,      // Page speed & Core Web Vitals (0-100)
    "security": 60,         // HTTP security headers (0-100)
    "accessibility": 70     // WCAG compliance (0-100)
  },
  "letterGrade": "B",       // A (90+), B (80+), C (60+), D (40+), F (<40)
  "issues": [
    {
      "category": "GEO",         // "GEO" | "SEO" | "Performance" | "Security" | "Accessibility"
      "severity": "critical",    // "critical" | "warning" | "info"
      "title": "AI crawlers blocked by robots.txt",
      "description": "GPTBot and ClaudeBot are blocked. Add User-agent: GPTBot\nAllow: / to robots.txt"
    }
  ],
  "aiSummary": "This site has strong SEO fundamentals but lacks GEO optimization...",
  "totalIssues": 12,          // Total issue count (some may be hidden on free tier)
  "tier": "free",             // "free" | "deep" | "pro" | "agency"
  "gated": true               // true = some issues hidden (free tier)
}

npm install -g foglift-mcp

{
  "mcpServers": {
    "foglift": {
      "command": "npx",
      "args": ["foglift-mcp"]
    }
  }
}

{
  "mcpServers": {
    "foglift": {
      "command": "npx",
      "args": ["foglift-mcp"]
    }
  }
}

{
  "mcpServers": {
    "foglift": {
      "command": "npx",
      "args": ["foglift-mcp"]
    }
  }
}

{
  "url": "https://example.com",
  "scores": { "overall": 72, "seo": 85, "geo": 52, "performance": 78, "security": 60, "accessibility": 91 },
  "issues": [
    { "category": "GEO", "severity": "critical", "title": "AI crawlers blocked by robots.txt", "description": "..." },
    { "category": "GEO", "severity": "critical", "title": "No FAQ schema markup", "description": "..." },
    { "category": "Security", "severity": "warning", "title": "Missing CSP header", "description": "..." }
  ],
  "aiSummary": "Strong SEO but weak GEO. AI crawlers are blocked and no structured data is present..."
}

{
  "error": "rate_limited",
  "message": "Daily scan limit exceeded. Upgrade to Pro for unlimited scans.",
  "limitReached": true
}

name: Website Health Check
on:
  push:
    branches: [main]
  schedule:
    - cron: '0 9 * * 1' # Weekly on Monday

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: banant2/Foglift@main
        id: foglift
        with:
          url: 'https://yoursite.com'
          threshold: '70' # Fail if overall score < 70

      # Optional: Use outputs in subsequent steps
      - run: echo "Score: ${{ steps.foglift.outputs.overall }}/100 (${{ steps.foglift.outputs.grade }})"

foglift-scan:
  stage: test
  script:
    - RESULT=$(curl -s "https://foglift.io/api/v1/scan?url=$SITE_URL")
    - SCORE=$(echo $RESULT | jq '.scores.overall')
    - echo "Foglift Score: $SCORE/100"
    - '[ "$SCORE" -ge 60 ] || (echo "Score below threshold" && exit 1)'

#!/bin/bash
URL=${1:-"https://yoursite.com"}
THRESHOLD=${2:-70}

RESULT=$(curl -s "https://foglift.io/api/v1/scan?url=$URL")
SCORE=$(echo $RESULT | jq '.scores.overall')

echo "Foglift score for $URL: $SCORE/100"

if [ "$SCORE" -lt "$THRESHOLD" ]; then
  echo "FAIL: Score $SCORE is below threshold $THRESHOLD"
  echo $RESULT | jq '.issues[] | select(.severity == "critical") | .title'
  exit 1
fi

echo "PASS: Score meets threshold"
exit 0