Saltar al contenido principal
Si estás ejecutando Kodus en tu propia infraestructura, el CLI funciona de la misma manera: solo necesitas apuntarlo a tu API.

​
Conectar a Tu Instancia

1

Establecer la URL de la API

Indica al CLI dónde vive tu API de Kodus. Elige un método:
export KODUS_API_URL=https://kodus-api.yourcompany.com
Agrega esto a tu perfil de shell (~/.bashrc, ~/.zshrc, etc.) para que sea permanente:
echo 'export KODUS_API_URL=https://kodus-api.yourcompany.com' >> ~/.zshrc
source ~/.zshrc
Se requiere HTTPS. El CLI rechaza las URLs no-HTTPS por seguridad. La única excepción es localhost y 127.0.0.1 para el desarrollo local.
Orden de prioridad: Variable de entorno KODUS_API_URL > apiUrl en ~/.kodus/config.json > predeterminado (https://api.kodus.io).
2

Autenticarse

Genera una clave de equipo desde tu panel de Kodus auto-alojado y configúrala:
kodus auth team-key --key kodus_xxxxx
O usa el instalador con tanto la URL de la API como la clave de equipo:
curl -fsSL https://review-skill.com/install | bash -s -- --team-key kodus_xxxxx
Las claves de equipo son ideales para entornos compartidos y configuraciones de agentes de IA: no se requiere inicio de sesión individual.
3

Verificar la Conexión

kodus auth status
Deberías ver tu modo de autenticación, el nombre de la organización y que el token es válido. Si usas el modo detallado, se registra la URL de la API utilizada:
kodus auth status --verbose

​
Cloudflare Access (Zero Trust)

Si tu API auto-alojada está detrás de Cloudflare Access, el CLI admite la autenticación con token de servicio. 
export KODUS_API_URL=https://kodus-api.yourcompany.com
export CF_ACCESS_CLIENT_ID=your-client-id.access
export CF_ACCESS_CLIENT_SECRET=your-client-secret
El CLI envía los encabezados CF-Access-Client-Id y CF-Access-Client-Secret en cada solicitud de la API cuando está configurado. Prioridad: variables de entorno > archivo de configuración.

​
Referencia del Archivo de Configuración

El CLI almacena la configuración en ~/.kodus/config.json: 
{
  "apiUrl": "https://kodus-api.yourcompany.com",
  "teamKey": "kodus_xxxxx",
  "teamName": "Engineering",
  "organizationName": "Acme Corp",
  "cfAccessClientId": "your-client-id.access",
  "cfAccessClientSecret": "your-client-secret"
}
CampoRequeridoDescripción
apiUrlNoTu URL de API auto-alojada. Anulada por la variable de entorno KODUS_API_URL.
teamKeyNoClave de API del equipo (comienza con kodus_). Anulada por la variable de entorno KODUS_TEAM_KEY.
teamNameNoNombre de visualización del equipo.
organizationNameNoNombre de visualización de la organización.
cfAccessClientIdNoID de cliente de Cloudflare Access. Anulado por la variable de entorno CF_ACCESS_CLIENT_ID.
cfAccessClientSecretNoSecreto de cliente de Cloudflare Access. Anulado por la variable de entorno CF_ACCESS_CLIENT_SECRET.
El archivo de configuración se crea con permisos 0600 (solo lectura/escritura del propietario). El directorio ~/.kodus/ se crea con permisos 0700.

​
Resumen de Variables de Entorno

VariableDescripción
KODUS_API_URLEndpoint de la API auto-alojada (se requiere HTTPS, excepto localhost)
KODUS_TEAM_KEYClave de equipo para acceso compartido
KODUS_TOKENToken de CI/CD para pipelines
CF_ACCESS_CLIENT_IDID de cliente de Cloudflare Access
CF_ACCESS_CLIENT_SECRETSecreto de cliente de Cloudflare Access
KODUS_VERBOSEEstablecer en true para ver la URL de API resuelta y los detalles de las solicitudes

​
Integración con CI/CD

Para instancias auto-alojadas en pipelines de CI/CD, establece la URL de la API y la autenticación como variables de entorno: 
- name: Kodus Review
  env:
    KODUS_API_URL: ${{ secrets.KODUS_API_URL }}
    KODUS_TEAM_KEY: ${{ secrets.KODUS_TEAM_KEY }}
  run: npx @kodus/cli review --format json --fail-on error
Usa --fail-on error o --fail-on critical para que el pipeline falle cuando se encuentren problemas por encima de un umbral de severidad.

​
Distribución a Tu Equipo

Para incorporar a tu equipo con un solo comando, combina la URL de la API con el instalador de skills: 
KODUS_API_URL=https://kodus-api.yourcompany.com \
  curl -fsSL https://review-skill.com/install | bash -s -- --team-key kodus_xxxxx
Esto instala el CLI, configura la clave de equipo y despliega los skills de revisión en los agentes de IA detectados (Claude Code, Cursor, Windsurf), todo apuntando a tu instancia auto-alojada.

​
Solución de Problemas

El CLI requiere HTTPS para todas las URLs que no sean localhost. Asegúrate de que tu instancia auto-alojada tenga un certificado TLS válido. Si estás probando localmente, usa http://localhost:<port> en su lugar.
  • Verifica que la URL sea accesible: curl -I https://kodus-api.yourcompany.com
  • Comprueba si un firewall o VPN está bloqueando la conexión
  • Si está detrás de Cloudflare Access, asegúrate de que CF_ACCESS_CLIENT_ID y CF_ACCESS_CLIENT_SECRET estén configurados
  • Usa --verbose para ver la URL exacta que se está usando
  • Ejecuta kodus auth status para verificar tu estado de autenticación actual
  • Si usas una clave de equipo, verifica que sea válida en tu panel auto-alojado
  • Si usas inicio de sesión personal, los tokens expiran después de 1 hora: el CLI los actualiza automáticamente, pero es posible que necesites volver a iniciar sesión si el token de actualización también expiró
  • Asegúrate de que KODUS_API_URL apunte a la instancia correcta
Esto generalmente significa que la URL está llegando a un proxy inverso, balanceador de carga o página de Cloudflare Access en lugar de la API real. Comprueba:
  • La ruta de la URL es correcta (sin /api u otro sufijo adicional)
  • Las credenciales de Cloudflare Access están configuradas si corresponde
  • El proxy inverso está reenviando las solicitudes correctamente
Tu instancia auto-alojada puede aplicar límites de dispositivos por organización. Contacta a tu administrador para aumentar el límite o eliminar dispositivos antiguos del panel.