@rankture/cli 0.1.1 → 0.1.3

package/README.md

@@ -74,14 +74,27 @@ rankture check ./src --staged      # Only check git staged files (pre-commit)
 
 | Option | Description | Default |
 |--------|-------------|---------|
-| `-f, --format <format>` | Output format: `terminal`, `json`, `html` | `terminal` |
+| `-f, --format <format>` | Output format: `terminal`, `json`, `html`, `sarif`, `markdown` | `terminal` |
 | `-o, --output <file>` | Write output to file | stdout |
-| `--fail-on <level>` | Exit code 1 on: `none`, `critical`, `warning`, `any` | `none` |
+| `--fail-on <level>` | Exit code 1 on: `none`, `critical`, `warning`, `any`, `new` | `none` |
 | `--ignore <patterns...>` | Glob patterns to ignore | `[]` |
 | `--config <file>` | Config file path | - |
 | `-w, --watch` | Watch for file changes and re-run checks | `false` |
 | `--changed` | Only check files changed in git (staged + unstaged) | `false` |
 | `--staged` | Only check git staged files (for pre-commit hooks) | `false` |
+| `--quiet` | Suppress progress and informational terminal output | `false` |
+| `--no-color` | Disable ANSI colors | `false` |
+| `--baseline <file>` | Suppress known issues from a committed baseline | - |
+| `--update-baseline` | Write current failures to the baseline | `false` |
+| `--max-warnings <number>` | Fail when fresh warnings exceed this count | - |
+| `--max-critical <number>` | Fail when fresh critical issues exceed this count | - |
+| `--min-score <number>` | Fail when the overall score is below this percentage | - |
+| `--annotations` | Emit GitHub Actions workflow-command annotations | `false` |
+| `--serve` | Validate links through an ephemeral localhost server | `false` |
+| `--serve-port <number>` | Preferred localhost port (`0` chooses one) | `0` |
+| `--open` | Open a generated HTML report | `false` |
+| `--sync` | Upload the report to Rankture | `false` |
+| `--website-id <id>` | Associate a synced report with a website | - |
 
 **Output Formats:**
 
@@ -94,6 +107,22 @@ rankture check ./dist -f json -o seo-report.json
 
 # HTML output - visual report to open in browser
 rankture check ./dist -f html -o seo-report.html
+
+# SARIF output - upload to GitHub code scanning
+rankture check ./dist -f sarif -o rankture.sarif
+
+# Compact Markdown for pull requests and AI agents
+rankture check ./dist -f markdown -o rankture.md
+
+# Establish a baseline, then fail only on regressions
+rankture check ./dist --baseline .rankture-baseline.json --update-baseline
+rankture check ./dist --baseline .rankture-baseline.json --fail-on new
+
+# Resolve links exactly as a local web server would
+rankture check ./dist --serve
+
+# Sync a pre-deploy run to Rankture
+rankture check ./dist --serve --sync --website-id YOUR_WEBSITE_ID
 ```
 
 ### `init`
@@ -112,7 +141,8 @@ Validate SEO assets like sitemaps, robots.txt, or schema.
 ```bash
 rankture validate sitemap ./public/sitemap.xml
 rankture validate robots ./public/robots.txt
-rankture validate schema ./schema.json  # Coming soon
+rankture validate schema ./schema.json
+rankture validate schema ./dist/index.html
 ```
 
 **Robots.txt Validation:**
@@ -131,15 +161,42 @@ rankture validate schema ./schema.json  # Coming soon
 - File size warnings (Google limit: 50MB, 50,000 URLs)
 - URL accessibility sampling
 
-### `audit <url>` (Coming Soon)
+### Hosted login, sync, and audits
+
+Create a CLI key under **Account Settings → Rankture CLI**, then:
+
+```bash
+rankture login --api-key rk_live_xxx
+rankture whoami
+rankture websites
+rankture check ./dist --sync --website-id YOUR_WEBSITE_ID
+rankture audit https://example.com --pages 10
+rankture audit https://example.com --pages 10 --wait --format json
+```
+
+The server stores only a SHA-256 hash of each key. The local credential file is
+created with owner-only permissions. `RANKTURE_API_KEY` and `RANKTURE_API_URL`
+can be used instead of storing credentials, which is recommended in CI.
 
-Audit a live URL with optional Pro features.
+### Local MCP and framework integrations
 
 ```bash
-rankture audit https://example.com
-rankture audit https://example.com --api-key YOUR_KEY --sync
+rankture mcp --root .
 ```
 
+The stdio MCP exposes `check_path`, `validate_schema`, `list_rules`, and
+`explain_rule`, and rejects paths outside the configured root. Astro and Vite
+build hooks are available from the package API:
+
+```ts
+import { ranktureAstro, ranktureVite } from '@rankture/cli';
+```
+
+Authenticated keys also include read-only dashboard MCP access at
+`https://rankture.com/api/mcp`. Send the key as a Bearer token. The hosted
+server exposes `list_websites`, `list_check_runs`, `get_check_run`,
+`get_latest_audit`, and `list_audit_issues`; it has no mutation tools.
+
 ## Checks Performed
 
 The CLI runs **21 offline checks** across 5 categories:
@@ -460,7 +517,9 @@ const imageResults = checkImages(parsed);
 
 ## Configuration
 
-Create a `rankture.config.json` in your project root:
+Create a `rankture.config.json` in your project root. The CLI also discovers
+`rankture.config.js`, `rankture.config.mjs`, or a `rankture` object in
+`package.json`:
 
 ```json
 {
@@ -470,14 +529,24 @@ Create a `rankture.config.json` in your project root:
     "**/_*.html"
   ],
   "checks": {
-    "title-length": { "min": 30, "max": 60 },
-    "meta-description-length": { "min": 120, "max": 160 },
-    "h1-count": { "expected": 1 }
+    "meta-title": true,
+    "meta-description": true,
+    "schema-howto": false
+  },
+  "rules": {
+    "image-alt": "critical",
+    "open-graph": "info"
   },
-  "failOn": "critical"
+  "thresholds": {
+    "titleLength": { "min": 30, "max": 60 },
+    "descriptionLength": { "min": 120, "max": 160 }
+  }
 }
 ```
 
+Command-line `--ignore` patterns are combined with config ignores. Unknown
+check IDs, invalid severities, and invalid thresholds fail with exit code 1.
+
 ## Output Formats
 
 ### Terminal (default)
@@ -549,14 +618,13 @@ jobs:
       
       - name: Build site
         run: npm run build
-      
-      # Option 1: Check only changed files (fast)
-      - name: SEO Check (changed files)
-        run: npx @rankture/cli check ./dist --changed --fail-on critical
 
-      # Option 2: Full check on all files
-      - name: SEO Check (full)
-        run: npx @rankture/cli check ./dist --fail-on critical
+      - uses: ChrisDrinks/Rankture/packages/github-action@v0.1.3
+        with:
+          path: dist
+          fail-on: new
+          baseline: .rankture-baseline.json
+          serve: true
 ```
 
 ### Pre-commit Hook (with Husky)
@@ -598,7 +666,6 @@ seo-check:
 With a [Rankture Pro](https://rankture.com/pricing/) subscription, unlock:
 
 - 🌐 **Live URL auditing** - Check live sites, not just static files
-- 📱 **Mobile & desktop** - Separate audits for each viewport
 - 🔗 **Broken link checking** - HTTP validation of all links
 - ⚡ **Core Web Vitals** - LCP, CLS, FID/INP metrics
 - 📊 **Dashboard sync** - Track progress over time
@@ -606,7 +673,8 @@ With a [Rankture Pro](https://rankture.com/pricing/) subscription, unlock:
 - 📄 **PDF reports** - Branded reports for clients
 
 ```bash
-rankture audit https://example.com --api-key YOUR_KEY --sync
+rankture login --api-key rk_live_xxx
+rankture audit https://example.com --pages 10 --wait
 ```
 
 Get your API key at [rankture.com/dashboard/settings](https://rankture.com/dashboard/settings/)
@@ -620,7 +688,7 @@ Get your API key at [rankture.com/dashboard/settings](https://rankture.com/dashb
 | CI/CD integration | ✅ | ✅ |
 | Live URL auditing | ❌ | ✅ |
 | Mobile/Desktop audits | ❌ | ✅ |
-| Broken link checking | ❌ | ✅ |
+| Local HTTP link checking | ✅ | ✅ |
 | Core Web Vitals | ❌ | ✅ |
 | Dashboard sync | ❌ | ✅ |
 | AI suggestions | ❌ | ✅ |