> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Referencia

> Opciones globales, variables de entorno, archivos, autocompletado del shell y solución de problemas de la Famulor CLI

## Opciones globales

Estas opciones funcionan con todos los comandos de la API.

| Opción | Finalidad |
| - | - |
| `-o, --output json\|table\|jsonl` | Formato de salida (predeterminado: `json`) |
| `-i, --input <file\|->` | Cuerpo de solicitud JSON desde un archivo, o desde stdin con `-` |
| `-F, --field key=value` | Define un campo del cuerpo; reconoce números, `true`/`false`, `null` y JSON |
| `-f, --raw-field key=value` | Define un campo del cuerpo como texto |
| `--all` | Obtiene todas las páginas de una lista |
| `--columns a,b,c` | Columnas de la salida en tabla |
| `--output-file <path>` | Escribe la respuesta en un archivo |
| `--dry-run` | Muestra la solicitud sin enviarla |
| `-y, --yes` | Confirma las eliminaciones y otras acciones irreversibles sin preguntar |
| `-p, --profile <name>` | Usa un inicio de sesión guardado |
| `--base-url <domain>` | Host de la API, por ejemplo tu dominio de marca blanca |
| `--timeout <seconds>` | Plazo para todo el comando, reintentos incluidos |
| `-q, --quiet` | Sin salida de progreso |
| `--debug` | Detalles de la solicitud y la respuesta en stderr |
| `--no-color` | Sin colores ni animación |
| `-h, --help` | Ayuda de un comando |

Ejecuta `famulor help options` para ver la misma lista en tu terminal.

## Comandos de la CLI

| Comando | Finalidad |
| - | - |
| `famulor auth login` | Guarda una clave de API para un espacio de trabajo (también `famulor login`) |
| `famulor auth status` | Muestra los inicios de sesión guardados y comprueba el activo |
| `famulor auth whoami` | Espacio de trabajo, nombre de la clave y alcances del inicio de sesión activo (también `famulor whoami`) |
| `famulor auth switch <profile>` | Cambia el perfil predeterminado |
| `famulor auth logout` | Elimina una clave guardada de este equipo (también `famulor logout`) |
| `famulor commands [search]` | Busca los comandos de la API; `--full` añade todas las opciones |
| `famulor api <METHOD> <path>` | Envía cualquier solicitud a la API |
| `famulor doctor` | Comprueba la configuración |
| `famulor completion bash\|zsh\|fish` | Autocompletado del shell |

## Variables de entorno

| Variable | Finalidad |
| - | - |
| `FAMULOR_API_KEY` | Clave de API; tiene prioridad sobre los inicios de sesión guardados |
| `FAMULOR_BASE_URL` | Host de la API, por ejemplo tu dominio de marca blanca |
| `FAMULOR_PROFILE` | Inicio de sesión guardado que se usará |
| `FAMULOR_OUTPUT` | Formato de salida predeterminado |
| `FAMULOR_TIMEOUT` | Plazo predeterminado en segundos; `--timeout` tiene prioridad |
| `FAMULOR_MAX_RETRIES` | Reintentos ante límites de solicitudes y errores de gateway, de 0 a 10 (predeterminado: 3) |
| `FAMULOR_CONFIG_DIR` | Dónde se guardan los inicios de sesión |
| `FAMULOR_NO_KEYRING` | Guarda las claves en un archivo al que solo tú tienes acceso en lugar del llavero del sistema |
| `FAMULOR_THEME` | `light` o `dark`, si los colores se leen mal sobre el fondo de tu terminal |
| `NO_COLOR` | Salida sin colores ni animación |

## Archivos

Los inicios de sesión se guardan en `~/.config/famulor` (en Windows, en `%APPDATA%\famulor`). `config.json` contiene los perfiles, nunca la propia clave. La clave se guarda en el llavero del sistema o, si no hay ningún llavero disponible, en `credentials.json` con permisos solo para ti.

## Autocompletado del shell

```bash theme={null}
# zsh or bash: add to your shell profile
eval "$(famulor completion zsh)"

# fish
famulor completion fish > ~/.config/fish/completions/famulor.fish
```

El autocompletado cubre los comandos, los verbos de cada área, las opciones, los valores permitidos y los nombres de los perfiles guardados. El script de zsh también funciona cuando `compinit` aún no está configurado.

## Solución de problemas

Empieza con `famulor doctor`. Comprueba la versión de Node.js, el inicio de sesión guardado, el host, la conexión de red y API Access.

| Mensaje | Qué hacer |
| - | - |
| `You are not logged in.` | Ejecuta `famulor auth login` o define `FAMULOR_API_KEY`. |
| `403 api_access_required` | El plan de tu espacio de trabajo no incluye API Access. Añádelo en **Settings → Plan**. |
| `missing the required scope` | La clave no tiene ese permiso. Usa una clave con ese alcance. |
| `429 rate_limited` | La CLI reintentó la solicitud cuando la API lo permitía. Los límites de uso, como un límite diario de llamadas, no se reintentan; el mensaje indica el límite. |
| `Refusing to … without confirmation` | Añade `--yes` para eliminar algo o ejecutar una acción irreversible desde un script o un agente de código. |

<Tip>
  Los límites de solicitudes, el formato de respuesta y los códigos de error son los mismos que en la API REST. Consulta la [introducción a la API](/es/api-reference/introduction) para más detalles.
</Tip>