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

# Usando el CLI de Olostep

> Estructura de comandos, salida, JSON, banderas globales, variables de entorno y códigos de salida.

## Estructura de comandos

```bash theme={null}
olostep <group> <command> [arguments] [flags]
```

Los comandos están agrupados según lo que trabajan, por ejemplo `olostep keys list` o `olostep monitors pause <monitor_id>`. Los comandos principales de datos web tienen una abreviatura que ejecuta su comando de creación:

| Abreviatura | Ejecuta |
| - | - |
| `olostep scrape <url>` | `olostep scrape create <url>` |
| `olostep search "<query>"` | `olostep search create "<query>"` |
| `olostep map <url>` | `olostep map create <url>` |
| `olostep crawl <url>` | `olostep crawl create <url>` |
| `olostep answer "<task>"` | `olostep answer create "<task>"` |
| `olostep extract <url>` | `olostep extract run <url>` |

`olostep whoami` es lo mismo que `olostep account info`.

## Obtener ayuda

```bash theme={null}
olostep --help                  # cada grupo de comandos
olostep monitors --help         # los comandos en un grupo
olostep monitors create --help  # los argumentos y banderas de un comando
olostep help export logs        # encontrar comandos por lo que hacen
```

`olostep help <words>` lista los comandos cuyo nombre o descripción contiene cada palabra. La ayuda funciona sin iniciar sesión.

## Salida

El CLI elige su salida según a dónde va:

| Dónde va la salida | Qué obtienes |
| - | - |
| Un terminal | Markdown formateado: encabezados, tablas y colores. El rojo se usa solo para errores. |
| Una tubería o un archivo, o si se establece `NO_COLOR` | El mismo Markdown como texto plano, sin colores. |
| Cualquier destino, con `--json` | JSON exacto, para scripts y agentes. |

Los errores van a stderr, por lo que redirigir stdout nunca los mezcla en tus datos.

Los colores también están desactivados cuando se establece `FORCE_COLOR=0` o `TERM=dumb`:

```bash theme={null}
NO_COLOR=1 olostep credits balance
```

### JSON

Agrega `--json` a cualquier comando que lo liste en su ayuda:

```bash theme={null}
olostep scrape https://example.com -f markdown --json
```

Los comandos que llaman a Olostep devuelven un objeto JSON:

```json theme={null}
{
  "operation": "<operation>",
  "mode": "executed",
  "data": {},
  "warnings": []
}
```

| Campo | Descripción |
| - | - |
| `operation` | La operación que se ejecutó. |
| `mode` | Uno de `read`, `executed`, `dry_run`, `browser` o `unavailable`. |
| `data` | El resultado. Su forma depende del comando. |
| `warnings` | Cualquier cosa que debas saber sobre el resultado, como datos parciales. Vacío cuando no hay nada. |

Analiza el JSON, no la salida legible por humanos. La salida humana puede cambiar entre versiones.

### Seleccionar campos

`--fields` mantiene solo los campos que nombras. Separa los campos con comas y alcanza campos anidados con un punto. Cada campo que elijas se imprime bajo la ruta que diste:

```bash theme={null}
olostep whoami --json --fields mode,warnings
```

```json theme={null}
{"mode":"read","warnings":[]}
```

Para elegir campos anidados, mira la salida completa de `--json` una vez, luego nómbralos como `data.<field>`. `--fields` también funciona sin `--json`, y muestra solo esos campos en la tabla.

### Redirigir a jq

```bash theme={null}
olostep credits balance --json | jq '.data'
olostep crawl pages <crawl_id> --json | jq '.data'
```

## Pasar valores

| Tipo de bandera | Cómo pasarla | Ejemplo |
| - | - | - |
| Texto o número | Después de la bandera | `--country US`, `--max-pages 50` |
| Lista repetible | Repite la bandera, o separa con comas | `-f markdown -f html` o `-f markdown,html` |
| JSON | JSON en línea, o `@` y una ruta de archivo | `--metadata '{"project":"q3"}'` o `--items @urls.json` |
| Booleano | Solo la bandera | `--include-subdomain` |
| Elección fija | Uno de los valores mostrados en la ayuda | `--days 7`, `--format csv` |

Las URLs y consultas posicionales también se pueden pasar como banderas, por ejemplo `olostep scrape create --url-to-scrape https://example.com` o `olostep search create --query "olostep"`.

## Comandos que cambian cosas

Los comandos que crean, cambian o eliminan algo, o usan créditos, lo indican en su ayuda. Soportan:

| Bandera | Qué hace |
| - | - |
| `--dry-run` | Muestra la llamada que haría el CLI y no envía nada. |
| `--preview` | Pide a Olostep que prevea el cambio sin realizarlo. |
| `--yes` | Omite la confirmación. Los comandos que pueden eliminar o sobrescribir necesitan `--yes` cuando no hay un terminal para confirmar. Sin él, salen con el código `4`. |

```bash theme={null}
olostep monitors delete <monitor_id> --dry-run
olostep monitors delete <monitor_id> --yes
```

Los comandos que usan créditos, como `scrape`, `search`, `map`, `crawl`, `answer`, `extract`, `batch create`, `monitors create`, `monitors run` y `agents run`, dicen `Esto consume créditos` o `consume créditos` en su ayuda.

## Banderas globales

Estas banderas funcionan en cada comando:

| Bandera | Descripción |
| - | - |
| `-h`, `--help` | Imprime ayuda para el comando y sale. |
| `--server <url>` | El servidor CLI de Olostep a usar. Por defecto es `https://cli.olostep.com/mcp`. |
| `--token <token>` | Usa este token en lugar del inicio de sesión guardado. Ver [Autenticación](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents). |
| `--refresh-tools` | Obtiene la lista actual de comandos y sus entradas del servidor en lugar de la copia en caché. |

Estas banderas funcionan en cada comando que las muestra en su ayuda:

| Bandera | Descripción |
| - | - |
| `--json` | Imprime JSON: para scripts y agentes. |
| `--fields <a,b>` | Solo estos campos, separados por comas (`a.b` para los anidados). |
| `--dry-run` | Muestra la llamada que haría y no envía nada. |
| `--preview` | Previsualiza sin cambiar nada. |
| `--yes` | No preguntar primero (necesario sin un terminal). |

## Variables de entorno

| Variable | Descripción |
| - | - |
| `OLOSTEP_TOKEN` | Un token para usar en lugar del inicio de sesión guardado. Igual que `--token`. |
| `OLOSTEP_SERVER` | La URL del servidor. Igual que `--server`. |
| `OLOSTEP_HOME` | Donde el script de instalación coloca el CLI. Por defecto es `~/.olostep`. Debe ser una ruta absoluta. |
| `NO_COLOR` | Cualquier valor desactiva los colores. |
| `XDG_CONFIG_HOME` | El CLI guarda su inicio de sesión en `$XDG_CONFIG_HOME/olostep`. Por defecto es `~/.config/olostep`. |
| `CI` | Desactiva el aviso de actualización. |

## Códigos de salida

| Código | Significado |
| - | - |
| `0` | Hecho. |
| `1` | El comando falló. El mensaje está en stderr. |
| `2` | Comando o argumentos incorrectos. |
| `3` | Se necesita iniciar sesión. Ejecuta `olostep login` o establece `OLOSTEP_TOKEN`. |
| `4` | El comando necesita `--yes`. |
| `5` | No se pudo alcanzar el servidor. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.