Official CLI v1.1.7 Node >= 18 MIT License

Documentación del CLI: syrax-audit

syrax-audit es la herramienta de línea de comandos oficial de Syrax Analyzer. Audita tu código en local en busca de problemas de SEO técnico, seguridad, accesibilidad, rendimiento y AEO directamente en tu terminal o CI/CD, y genera prompts de corrección inmediata para asistentes de IA.

1 Inicio Rápido

Sin instalación previa. Puedes ejecutar la auditoría sobre cualquier proyecto web en cualquier momento directamente en la raíz de tu proyecto:

$ npx syrax-audit@latest

Cursor · Codex · Antigravity · OpenCode · Claude Code

Protocolo de Auto-reparación con Agentes IA

En lugar de auditar y parchear a mano, entrega este Master Prompt directamente a tu agente de IA (Cursor Composer, Claude Code, OpenCode, Aider). El agente consultará la API de Syrax, analizará el payload de diagnóstico, corregirá cada fallo y repetirá el bucle hasta verificar el 100/100:

Audita y optimiza este proyecto con mi API de Syrax Analyzer:

- API Key: YOUR_SYRAX_API_KEY
- Endpoint API: POST https://syrax-analyzer.moisesvalero.es/api/web-audit/cli-analyze (cabecera 'x-syrax-api-key')

Instrucciones:
1. Audita la URL de producción o el HTML renderizado local del proyecto enviando el payload con la URL, HTML y cabeceras.
2. Analiza el JSON devuelto y corrige de forma autónoma los fallos técnicos (seguridad HTTP, cabeceras, lógica backend, esquemas JSON-LD, etiquetas de rendimiento y tests) sin romper funcionalidad existente.
3. REGLAS DE SEGURIDAD Y PROTECCIÓN DE FRAMEWORKS (ANTI-ROTURA):
   - NUNCA apliques transformaciones de regex en el servidor (ej. transformPageChunk en SvelteKit hooks o middleware en Next.js) para forzar type="module" o defer en etiquetas <script>. Los bundlers (Vite/Webpack/Rollup) ya emiten los módulos optimizados.
   - NUNCA conviertas scripts inline a type="module" (por especificación ECMAScript document.currentScript devuelve null en módulos ES, rompiendo la hidratación y arranque del framework).
   - Al configurar Content-Security-Policy (CSP), escanea previamente todos los fetch() y APIs externas del proyecto (Wikipedia, DuckDuckGo, Supabase, Stripe, etc.) y agrégalos a connect-src para no bloquear peticiones de datos legítimas.
4. Para cambios de diseño, UI, maquetación o nuevas secciones visuales (ej. añadir FAQ, banners, modales, modificar estilos o diseño web): PREGUNTA primero al usuario y ofrece opciones antes de alterar la interfaz.
5. Vuelve a ejecutar la auditoría tras los cambios en bucle hasta conseguir la máxima puntuación (100/100).
6. Ejecuta los tests y linters del proyecto para confirmar que todo sigue en verde antes de terminar.

1. Direct API Endpoint POST /api/web-audit/cli-analyze

2. Zero Hallucinations Strict technical diagnostics & prompts

3. Loop Verification Re-audits until 100/100 score

2 Asistente de Configuración (Setup Wizard)

La primera vez que ejecutas el comando en un proyecto, syrax-audit detectará que no está configurado e iniciará un asistente interactivo en la terminal:

// Step 1

Configuración de API Key

Solicita tu API Key Premium, la guarda en tu .env local y asegura que .env esté en tu .gitignore.

// Step 2

Git Hooks con Husky

Instala y configura hooks pre-push o pre-commit para bloquear subidas con errores críticos sin borrar scripts existentes.

// Step 3

Diagnóstico e Informe para IA

Ejecuta el escaneo, te permite seleccionar errores con flechas/Espacio y exporta un informe JSON detallado con instrucciones de reparación para tu agente de IA.

3 Soporte Universal de Servidores y Detección de Puertos

El CLI cuenta con un motor de detección inteligente adaptable a cualquier entorno:

Ecosistema	Detección	Comando Ejecutado
Node.js (SvelteKit, Next.js, Astro, Vite)	package.json scripts	pnpm dev / npm run dev / bun run dev
Python (Django, Flask, FastAPI)	manage.py / static	python manage.py runserver
PHP (Laravel)	artisan	php artisan serve
Rust (Tauri, Axum, Actix)	Cargo.toml	cargo run
Go	go.mod	go run .

4 Configuración de la API Key (Premium)

Con el plan Premium activo, genera tu clave API en la plataforma web de Syrax y colócala en tu archivo de entorno:

// .env (Project Root)

SYRAX_API_KEY=syx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

5 Integración con Git Hooks (Husky)

Evita subir código roto o sin optimizar a producción añadiendo la auditoría en tus hooks de Husky:

# .husky/pre-commit

#!/bin/sh

# Run Syrax audit in CI mode before pushing or committing code
npx syrax-audit --ci

6 Integración en CI/CD (GitHub Actions)

Automatiza la auditoría en cada Pull Request o push. Crea el archivo `.github/workflows/syrax-audit.yml`:

.github/workflows/syrax-audit.yml

name: Syrax Security & SEO Audit

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install dependencies
        run: pnpm install --no-frozen-lockfile

      - name: Run Syrax Audit CLI
        run: npx syrax-audit --ci
        env:
          SYRAX_API_KEY: ${{ secrets.SYRAX_API_KEY }}

7 Opciones y Flags del Comando

Flag / Opción	Descripción
--url <url>	URL objetivo a auditar (por defecto detecta el puerto local automáticamente).
--ci	Modo no interactivo para CI. Sale con código 1 si hay fallos críticos o puntuación baja.
--json	Emite los resultados de la auditoría en formato JSON puro por stdout.
--category <name>	Filtra las comprobaciones por categoría (seo, security, performance, accessibility, aeo).
--help, -h	Muestra el menú de ayuda y opciones disponibles.
--version, -v	Muestra la versión instalada actualmente.