Olostep CLI - Olostep Docs

The Olostep CLI is the olostep command. It runs Olostep from your terminal, from scripts, and from AI coding agents, signed in to the same Olostep account you use on the dashboard. With the CLI, you can:

Scrape, search, map, crawl, research and extract web data.
Run and inspect jobs: batches, crawls, monitors, research agents and request logs.
Manage your account: team, API keys, credits and billing.
Ask the Olostep agent for anything in plain words with olostep chat.
Print exact JSON with --json for scripts and AI agents.

Install

The CLI needs Node.js 20.19 or newer. On macOS or Linux, run:

curl -fsSL https://cli.olostep.com | sh

The script installs the CLI into ~/.olostep and puts olostep on your PATH. See Install and update for details, updating and uninstalling.

Quickstart

olostep login

Your browser opens the Olostep sign-in page. Sign in with your Olostep account and return to the terminal.

Check your account

olostep whoami

Prints your account, team, plan and credit balance.

Scrape a page

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

Search the web

olostep search "best hiking trails"

Get JSON for a script

olostep credits balance --json

Common commands

Task	Command
Scrape a page	`olostep scrape https://example.com -f markdown`
Search the web	`olostep search "query"`
List a site’s URLs	`olostep map https://example.com -n 20`
Crawl a site	`olostep crawl https://example.com -n 20`
Research a question	`olostep answer "Compare these products"`
Extract structured data	`olostep extract https://example.com -i "Extract product prices"`
Check your credits	`olostep credits balance`
Save an API key to `.env`	`olostep keys reveal <key> --write-env .env`
Ask the agent	`olostep chat "<request>"`
Find a command	`olostep help <words>`

Every command has help. Help works without signing in:

olostep --help
olostep scrape --help
olostep scrape create --help

Learn more

Install and update

Requirements, updating, and uninstalling.

Authentication

Usage

Output, --json, global flags, environment variables and exit codes.

Use with AI agents

How coding agents run the CLI, and the skill and tools commands.

To use Olostep from an MCP client such as Claude, Cursor or VS Code instead of a terminal, see MCP server.

​Install

​Quickstart

​Common commands

​Learn more