Instalador CLI – AuthKit – Documentos de WorkOS
Agregue AuthKit a su proyecto en minutos con un solo comando. WorkOS CLI utiliza IA para detectar su marco, instalar el SDK correcto y escribir el código de integración automáticamente.
Introducción
Ejecute un comando, la CLI se encarga del resto: detección del marco, instalación del SDK, creación de rutas, configuración del entorno y validación de la compilación. Su aplicación pasa de autenticación cero a integración completa de AuthKit en aproximadamente dos minutos.
javascript
La CLI se encarga de todo lo que normalmente harías manualmente:
- Detecta tu marco– Identifica su marco y versión a partir de las dependencias y la estructura de archivos de su proyecto.
- Autentica tu cuenta– Abre su navegador para iniciar sesión de forma segura en WorkOS
- Configura tu panel de control– Establece automáticamente los URI de redireccionamiento, los orígenes de CORS y la URL de la página de inicio.
- Instala el SDK correcto– Agrega el paquete AuthKit correcto para su marco
- Analiza tu proyecto– Lee la estructura de su proyecto para comprender el enrutamiento, el middleware existente y la configuración.
- Crea rutas y middleware.– Escribe rutas de devolución de llamadas de OAuth, middleware/proxy de autenticación y envoltorios de proveedores
- Configura variables de entorno– Escribe claves API y configuración en
.env.local - Valida la integración– Ejecuta tu compilación para verificar que todo se compila sin errores.
La CLI comprende los matices específicos del marco, como los matices de Next.js App Router vs Pages Router, Vite vs Create React App y React Router, y genera el código apropiado para su configuración. Si tiene middleware o configuración existente, lo integra en lugar de reemplazarlo.
La CLI utiliza un agente de IA con permisos restringidos para integrar AuthKit en su proyecto:
- Análisis local– El agente lee los archivos de su proyecto localmente para detectar marcos y comprender la estructura de su proyecto.
- Ejecución restringida– El agente solo puede ejecutar un conjunto limitado de comandos: instalación de paquetes, compilaciones, verificación de tipos y formato. No puede ejecutar comandos de shell arbitrarios.
- Modificaciones de archivos– El agente crea y edita archivos en su proyecto para configurar la integración de AuthKit. Usar
git diffdespués de la instalación para revisar cada cambio. - Configuración del panel– La CLI configura los ajustes del panel de WorkOS (URI de redireccionamiento, CORS) utilizando su sesión autenticada.
La CLI no detectó mi marco
Utilice el --integration bandera para especificar su marco manualmente:
Ejecute la CLI con --debug para obtener resultados detallados. Asegúrese de que su proyecto se genere limpiamente antes de ejecutar la CLI; los errores de compilación preexistentes harán que falle la validación.
quiero ver que cambio
Una vez completada la CLI, utilice git diff para revisar todos los archivos que creó o modificó:
Algo más salió mal
Correr workos doctor para diagnosticar problemas comunes. Si el problema persiste, abrir un problema en GitHub--debug modo.
- Sesiones: comprender la gestión de sesiones
- Marca: personalice la interfaz de usuario de AuthKit
- Aplicaciones de ejemplo: vea ejemplos de trabajo completos
- Inicio rápido: guía de integración manual para un control total
Aplicaciones de ejemploVer aplicaciones de AuthKit de muestra
