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

# Olostep CLI

> Scrape websites, search the web and manage your Olostep account from the terminal.

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](https://docs.olostep.com/cli/reference/web-data.md) web data.
* [Run and inspect jobs](https://docs.olostep.com/cli/reference/jobs.md): batches, crawls, monitors, research agents and request logs.
* [Manage your account](https://docs.olostep.com/cli/reference/account-billing.md): team, API keys, credits and billing.
* [Ask the Olostep agent](https://docs.olostep.com/cli/reference/cli-commands.md#olostep-chat) for anything in plain words with `olostep chat`.
* Print exact JSON with `--json` for scripts and [AI agents](https://docs.olostep.com/cli/ai-agents.md).

## Install

The CLI needs [Node.js](https://nodejs.org) 20.19 or newer. On macOS or Linux, run:

```bash theme={null}
curl -fsSL https://cli.olostep.com | sh
```

The script installs the CLI into `~/.olostep` and puts `olostep` on your `PATH`. See [Install and update](https://docs.olostep.com/cli/install.md) for details, updating and uninstalling.

## Quickstart

**1. Sign in**

```bash theme={null}
olostep login
```

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

**2. Check your account**

```bash theme={null}
olostep whoami
```

Prints your account, team, plan and credit balance.

**3. Scrape a page**

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

**4. Search the web**

```bash theme={null}
olostep search "best hiking trails"
```

**5. Get JSON for a script**

```bash theme={null}
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:

```bash theme={null}
olostep --help
olostep scrape --help
olostep scrape create --help
```

## Learn more

> **[Install and update](https://docs.olostep.com/cli/install.md)**
>
> Requirements, updating, and uninstalling.

> **[Authentication](https://docs.olostep.com/cli/authentication.md)**
>
> Sign in, sign out, and tokens for CI.

> **[Usage](https://docs.olostep.com/cli/usage.md)**
>
> Output, `--json`, global flags, environment variables and exit codes.

> **[Use with AI agents](https://docs.olostep.com/cli/ai-agents.md)**
>
> 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](https://docs.olostep.com/integrations/mcp-server.md).


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