@linkrivers-webops/cli

Install LinkRivers SEO scanner functions to your Vercel or Netlify project with a single command.

Quick Start

npx @linkrivers-webops/cli

Or use the shorter alias after global install:

npm install -g @linkrivers-webops/cli
linkrivers
# or
lr

That's it! The CLI will:

1. Detect your platform (Vercel or Netlify)
2. Ask for your LinkRivers site key
3. Install the SEO scanner functions
4. Configure environment variables

What Gets Installed

Files Added

For Vercel:

your-project/
  api/
    linkrivers/
      health.js
      seo-scan.js
      broken-links.js
  lib/
    linkrivers/
      config.js
      fetcher.js
      parser.js
      reporter.js
      index.js
  .env.local (updated)
  vercel.json (updated)

For Netlify:

your-project/
  netlify/
    functions/
      lr-health.js
      lr-seo-scan.js
      lr-broken-links.js
      lr-security-headers.js
  lib/
    linkrivers/
      config.cjs
      fetcher.cjs
      parser.cjs
      reporter.cjs
      index.cjs
  .env (updated)
  netlify.toml (updated)

Environment Variables

The following environment variables are configured:

| Variable | Description | |----------|-------------| | LINKRIVERS_SITE_KEY | Your LinkRivers site key (required) | | LINKRIVERS_API_KEY | Your LinkRivers API key (for reporting results) | | LINKRIVERS_API_URL | LinkRivers API URL (default: https://api.linkrivers.com) |

After Installation

1. Deploy your project:

   git add . && git commit -m "Add LinkRivers SEO scanner" && git push

2. Test the health endpoint:

   • Vercel: https://your-site.vercel.app/api/linkrivers/health
   • Netlify: https://your-site.netlify.app/.netlify/functions/lr-health

3. Run SEO scans from LinkRivers dashboard

Manual Installation

If you prefer manual installation, download the functions from: https://github.com/linkrivers/linkrivers-serverless

Requirements

• Node.js 14+
• Vercel or Netlify project

Getting Your Site Key

1. Log in to LinkRivers Dashboard
2. Go to Integrations
3. Click on Vercel or Netlify
4. Your site key will be displayed

Support

• Documentation: https://linkrivers.com/docs/serverless-seo
• Issues: https://github.com/linkrivers-webops/cli/issues

License

MIT