De Olostep CLI gebruiken

Commando-structuur

olostep <group> <command> [arguments] [flags]

Commando’s zijn gegroepeerd op basis van waar ze op werken, bijvoorbeeld olostep keys list of olostep monitors pause <monitor_id>. De belangrijkste web-data commando’s hebben een verkorte notatie die hun create commando uitvoert:

Verkorte notatie	Voert uit
`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 is hetzelfde als olostep account info.

Hulp krijgen

olostep --help                  # elke commando-groep
olostep monitors --help         # de commando's in een groep
olostep monitors create --help  # de argumenten en vlaggen van één commando
olostep help export logs        # vind commando's op basis van wat ze doen

olostep help <woorden> geeft een lijst van commando’s waarvan de naam of beschrijving elk woord bevat. Hulp werkt zonder in te loggen.

Output

De CLI kiest zijn output op basis van waar het naartoe gaat:

Waar output naartoe gaat	Wat je krijgt
Een terminal	Opgemaakt Markdown: koppen, tabellen en kleuren. Rood wordt alleen gebruikt voor fouten.
Een pipe of een bestand, of `NO_COLOR` is ingesteld	Dezelfde Markdown als platte tekst, zonder kleuren.
Elke bestemming, met `--json`	Exact JSON, voor scripts en agents.

Fouten gaan naar stderr, zodat piping van stdout ze nooit in je data mengt. Kleuren zijn ook uitgeschakeld wanneer FORCE_COLOR=0 of TERM=dumb is ingesteld:

NO_COLOR=1 olostep credits balance

JSON

Voeg --json toe aan elk commando dat het in zijn hulp vermeldt:

olostep scrape https://example.com -f markdown --json

Commando’s die Olostep aanroepen, geven één JSON-object terug:

{
  "operation": "<operation>",
  "mode": "executed",
  "data": {},
  "warnings": []
}

Veld	Beschrijving
`operation`	De uitgevoerde operatie.
`mode`	Een van `read`, `executed`, `dry_run`, `browser` of `unavailable`.
`data`	Het resultaat. De vorm hangt af van het commando.
`warnings`	Alles wat je moet weten over het resultaat, zoals gedeeltelijke data. Leeg wanneer er niets is.

Parseer de JSON, niet de mensvriendelijke output. De menselijke output kan tussen versies veranderen.

Velden selecteren

--fields behoudt alleen de velden die je noemt. Scheid velden met komma’s en bereik geneste velden met een punt. Elk veld dat je kiest, wordt afgedrukt onder het pad dat je hebt gegeven:

olostep whoami --json --fields mode,warnings

{"mode":"read","warnings":[]}

Om geneste velden te kiezen, bekijk je een keer de volledige --json output en noem je ze als data.<field>. --fields werkt ook zonder --json en toont alleen die velden in de tabel.

Pipe naar jq

olostep credits balance --json | jq '.data'
olostep crawl pages <crawl_id> --json | jq '.data'

Waarden doorgeven

Soort vlag	Hoe door te geven	Voorbeeld
Tekst of nummer	Na de vlag	`--country US`, `--max-pages 50`
Herhaalbare lijst	Herhaal de vlag, of scheid met komma’s	`-f markdown -f html` of `-f markdown,html`
JSON	Inline JSON, of `@` en een bestandspad	`--metadata '{"project":"q3"}'` of `--items @urls.json`
Boolean	Alleen de vlag	`--include-subdomain`
Vaste keuze	Een van de waarden getoond in hulp	`--days 7`, `--format csv`

Positieve URL’s en queries kunnen ook als vlaggen worden doorgegeven, bijvoorbeeld olostep scrape create --url-to-scrape https://example.com of olostep search create --query "olostep".

Commando’s die dingen veranderen

Commando’s die iets creëren, veranderen of verwijderen, of credits gebruiken, geven dit aan in hun hulp. Ze ondersteunen:

Vlag	Wat het doet
`--dry-run`	Toont de oproep die de CLI zou maken, en stuurt niets.
`--preview`	Vraagt Olostep om een voorbeeld van de verandering te tonen zonder deze uit te voeren.
`--yes`	Slaat de bevestiging over. Commando’s die kunnen verwijderen of overschrijven hebben `--yes` nodig wanneer er geen terminal is om in te bevestigen. Zonder dit stoppen ze met code `4`.

olostep monitors delete <monitor_id> --dry-run
olostep monitors delete <monitor_id> --yes

Commando’s die credits gebruiken, zoals scrape, search, map, crawl, answer, extract, batch create, monitors create, monitors run en agents run, zeggen This consumes credits of consumes credits in hun hulp.

Globale vlaggen

Deze vlaggen werken bij elk commando:

Vlag	Beschrijving
`-h`, `--help`	Print hulp voor het commando en stopt.
`--server <url>`	De Olostep CLI-server om te gebruiken. Standaard is `https://cli.olostep.com/mcp`.
`--token <token>`	Gebruik deze token in plaats van de opgeslagen inloggegevens. Zie Authenticatie.
`--refresh-tools`	Haal de huidige lijst van commando’s en hun invoer op van de server in plaats van de gecachte kopie.

Deze vlaggen werken bij elk commando dat ze in zijn hulp toont:

Vlag	Beschrijving
`--json`	Print JSON: voor scripts en agents.
`--fields <a,b>`	Alleen deze velden, komma-gescheiden (`a.b` voor geneste).
`--dry-run`	Toon de oproep die het zou maken, en stuur niets.
`--preview`	Voorbeeld zonder iets te veranderen.
`--yes`	Vraag niet eerst (nodig zonder een terminal).

Omgevingsvariabelen

Variabele	Beschrijving
`OLOSTEP_TOKEN`	Een token om te gebruiken in plaats van de opgeslagen inloggegevens. Zelfde als `--token`.
`OLOSTEP_SERVER`	De server-URL. Zelfde als `--server`.
`OLOSTEP_HOME`	Waar het installatiescript de CLI plaatst. Standaard is `~/.olostep`. Moet een absoluut pad zijn.
`NO_COLOR`	Elke waarde schakelt kleuren uit.
`XDG_CONFIG_HOME`	De CLI bewaart zijn inloggegevens in `$XDG_CONFIG_HOME/olostep`. Standaard is `~/.config/olostep`.
`CI`	Schakelt de update-melding uit.

Exitcodes

Code	Betekenis
`0`	Klaar.
`1`	Het commando is mislukt. Het bericht staat op stderr.
`2`	Verkeerd commando of argumenten.
`3`	Inloggen vereist. Voer `olostep login` uit of stel `OLOSTEP_TOKEN` in.
`4`	Het commando heeft `--yes` nodig.
`5`	De server kon niet worden bereikt.

​Commando-structuur

​Hulp krijgen

​Output

​JSON

​Velden selecteren

​Pipe naar jq

​Waarden doorgeven

​Commando’s die dingen veranderen

​Globale vlaggen

​Omgevingsvariabelen

​Exitcodes