> ## 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.

# Utilizzo della CLI di Olostep

> Struttura dei comandi, output, JSON, flag globali, variabili d’ambiente e codici di uscita.

## Struttura dei comandi

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

I comandi sono raggruppati in base a ciò su cui lavorano, ad esempio `olostep keys list` o `olostep monitors pause <monitor_id>`. I principali comandi web-data hanno una scorciatoia che esegue il loro comando di creazione:

| Scorciatoia | Esegue |
| - | - |
| `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` è lo stesso di `olostep account info`.

## Ottenere aiuto

```bash theme={null}
olostep --help                  # ogni gruppo di comandi
olostep monitors --help         # i comandi in un gruppo
olostep monitors create --help  # argomenti e flag di un comando
olostep help export logs        # trova comandi in base a ciò che fanno
```

`olostep help <words>` elenca i comandi il cui nome o descrizione contiene ogni parola. L'aiuto funziona senza effettuare l'accesso.

## Output

La CLI sceglie il suo output in base a dove va:

| Dove va l'output | Cosa ottieni |
| - | - |
| Un terminale | Markdown formattato: intestazioni, tabelle e colori. Il rosso è usato solo per gli errori. |
| Una pipe o un file, o se `NO_COLOR` è impostato | Lo stesso Markdown come testo semplice, senza colori. |
| Qualsiasi destinazione, con `--json` | JSON esatto, per script e agenti. |

Gli errori vanno a stderr, quindi il piping di stdout non li mescola nei tuoi dati.

I colori sono anche disattivati quando `FORCE_COLOR=0` o `TERM=dumb` è impostato:

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

### JSON

Aggiungi `--json` a qualsiasi comando che lo elenca nel suo aiuto:

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

I comandi che chiamano Olostep restituiscono un oggetto JSON:

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

| Campo | Descrizione |
| - | - |
| `operation` | L'operazione eseguita. |
| `mode` | Uno tra `read`, `executed`, `dry_run`, `browser` o `unavailable`. |
| `data` | Il risultato. La sua forma dipende dal comando. |
| `warnings` | Qualsiasi cosa tu debba sapere sul risultato, come dati parziali. Vuoto quando non c'è nulla. |

Analizza il JSON, non l'output leggibile dall'uomo. L'output umano può cambiare tra le versioni.

### Selezionare campi

`--fields` mantiene solo i campi che nomini. Separa i campi con virgole e raggiungi i campi annidati con un punto. Ogni campo scelto viene stampato sotto il percorso che hai dato:

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

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

Per scegliere campi annidati, guarda l'output completo di `--json` una volta, poi nominali come `data.<field>`. `--fields` funziona anche senza `--json` e mostra solo quei campi nella tabella.

### Pipe in jq

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

## Passare valori

| Tipo di flag | Come passarlo | Esempio |
| - | - | - |
| Testo o numero | Dopo il flag | `--country US`, `--max-pages 50` |
| Lista ripetibile | Ripeti il flag o separa con virgole | `-f markdown -f html` o `-f markdown,html` |
| JSON | JSON inline o `@` e un percorso file | `--metadata '{"project":"q3"}'` o `--items @urls.json` |
| Booleano | Solo il flag | `--include-subdomain` |
| Scelta fissa | Uno dei valori mostrati nell'aiuto | `--days 7`, `--format csv` |

URL e query posizionali possono anche essere passati come flag, ad esempio `olostep scrape create --url-to-scrape https://example.com` o `olostep search create --query "olostep"`.

## Comandi che cambiano le cose

I comandi che creano, cambiano o eliminano qualcosa, o usano crediti, lo dicono nel loro aiuto. Supportano:

| Flag | Cosa fa |
| - | - |
| `--dry-run` | Mostra la chiamata che la CLI farebbe, e non invia nulla. |
| `--preview` | Chiede a Olostep di visualizzare in anteprima la modifica senza effettuarla. |
| `--yes` | Salta la conferma. I comandi che possono eliminare o sovrascrivere necessitano `--yes` quando non c'è un terminale per confermare. Senza di esso escono con codice `4`. |

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

I comandi che usano crediti, come `scrape`, `search`, `map`, `crawl`, `answer`, `extract`, `batch create`, `monitors create`, `monitors run` e `agents run`, dicono `Questo consuma crediti` o `consuma crediti` nel loro aiuto.

## Flag globali

Questi flag funzionano su ogni comando:

| Flag | Descrizione |
| - | - |
| `-h`, `--help` | Stampa l'aiuto per il comando ed esci. |
| `--server <url>` | Il server CLI di Olostep da usare. Predefinito a `https://cli.olostep.com/mcp`. |
| `--token <token>` | Usa questo token invece dell'accesso salvato. Vedi [Autenticazione](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents). |
| `--refresh-tools` | Recupera l'elenco corrente dei comandi e dei loro input dal server invece della copia cache. |

Questi flag funzionano su ogni comando che li mostra nel suo aiuto:

| Flag | Descrizione |
| - | - |
| `--json` | Stampa JSON: per script e agenti. |
| `--fields <a,b>` | Solo questi campi, separati da virgole (`a.b` per quelli annidati). |
| `--dry-run` | Mostra la chiamata che farebbe, e non invia nulla. |
| `--preview` | Visualizza in anteprima senza cambiare nulla. |
| `--yes` | Non chiedere prima (necessario senza un terminale). |

## Variabili d’ambiente

| Variabile | Descrizione |
| - | - |
| `OLOSTEP_TOKEN` | Un token da usare invece dell'accesso salvato. Uguale a `--token`. |
| `OLOSTEP_SERVER` | L'URL del server. Uguale a `--server`. |
| `OLOSTEP_HOME` | Dove lo script di installazione mette la CLI. Predefinito a `~/.olostep`. Deve essere un percorso assoluto. |
| `NO_COLOR` | Qualsiasi valore disattiva i colori. |
| `XDG_CONFIG_HOME` | La CLI mantiene il suo accesso in `$XDG_CONFIG_HOME/olostep`. Predefinito a `~/.config/olostep`. |
| `CI` | Disattiva l'avviso di aggiornamento. |

## Codici di uscita

| Codice | Significato |
| - | - |
| `0` | Fatto. |
| `1` | Il comando è fallito. Il messaggio è su stderr. |
| `2` | Comando o argomenti errati. |
| `3` | È necessario effettuare l'accesso. Esegui `olostep login` o imposta `OLOSTEP_TOKEN`. |
| `4` | Il comando necessita `--yes`. |
| `5` | Il server non può essere raggiunto. |


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