Capyseo Logo Capyseo

Installation

Installation

Requirements

  • Node.js 18+ or Bun 1.0+
  • For AI features: API key from Gemini, OpenAI, Anthropic, or local Ollama

Install the CLI

# With npm npm install -g @capyseo/cli # With Bun (recommended) bun add -g @capyseo/cli # Or run directly without installing npx @capyseo/cli analyze ./dist bunx @capyseo/cli analyze ./dist

Install as Dev Dependency

For project-specific installation:

# npm npm install -D @capyseo/cli # Bun bun add -D @capyseo/cli # pnpm pnpm add -D @capyseo/cli

Then add to package.json:

{ "scripts": { "seo": "capyseo analyze ./dist", "seo:ci": "capyseo analyze ./dist --ci --min-score 80" } }

Install Core Package

For programmatic usage:

npm install @capyseo/core # or bun add @capyseo/core

Install SvelteKit Adapter

For SvelteKit projects:

npm install -D @capyseo/adapter-sveltekit # or bun add -D @capyseo/adapter-sveltekit

Verify Installation

capyseo --version # Output: 0.1.0 capyseo --help # Shows available commands

Optional Dependencies

AI Features

Set an API key for AI-powered suggestions:

# Gemini (recommended) export GEMINI_API_KEY=your_key_here # OpenAI export OPENAI_API_KEY=your_key_here # Anthropic export ANTHROPIC_API_KEY=your_key_here # Ollama (no key needed, runs locally) ollama serve

SPA/JavaScript Rendering

For analyzing JavaScript-rendered sites:

npm install -D playwright npx playwright install chromium

Then use --spa flag:

capyseo analyze https://spa-site.com --spa

Next Steps