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

# CLI

> Access Orthogonal APIs from the command line

The Orthogonal CLI (`orth`) lets you search, explore, and run tools and APIs from your terminal.

## Installation

```bash theme={null}
npm install -g @orth/cli
```

After installation, the CLI is available as `orth`.

## Authentication

Set your API key as an environment variable:

```bash theme={null}
export ORTHOGONAL_API_KEY=orth_live_your_key_here
```

Or pass it with each command:

```bash theme={null}
orth --key orth_live_your_key_here <command>
```

Get your API key from the [dashboard](https://orthogonal.com/dashboard/settings/api-keys).

## Commands

### Search APIs

Find APIs by keyword:

```bash theme={null}
orth search "web scraping"
```

Output:

```
olostep         Olostep         (4 endpoints)
scrapegraph     ScrapeGraph AI  (3 endpoints)
riveter         Riveter         (2 endpoints)
```

### List All APIs

```bash theme={null}
orth api
```

### View API Endpoints

See all endpoints for an API:

```bash theme={null}
orth api olostep
```

Output:

```
Olostep (olostep)

POST   /v1/scrapes                $0.01
       Scrape any webpage and get clean markdown
POST   /v1/answers                $0.02
       Get AI-powered answers from web content
GET    /v1/scrapes/{id}           free
       Check scrape status
```

### View Endpoint Details

Get full parameter details for an endpoint:

```bash theme={null}
orth api olostep /v1/scrapes
```

Output:

```
olostep/v1/scrapes

Scrape any webpage and get clean markdown

Price: $0.01

Body Parameters:
  url_to_scrape* (string) - URL to scrape
  formats (array) - Output formats (markdown, html, text)
  wait_for (string) - CSS selector to wait for

Example:
  orth run olostep /v1/scrapes --body '{"url_to_scrape": "<url>"}'
```

### Call an API

Execute an API endpoint:

```bash theme={null}
# With query parameters
orth run hunter /v2/domain-search -q domain=orthogonal.com

# With JSON body
orth run olostep /v1/scrapes --body '{
  "url_to_scrape": "https://news.ycombinator.com"
}'
```

### View Account Info

Check your balance and usage:

```bash theme={null}
orth account
```

## Examples

### Find someone's email

```bash theme={null}
orth run hunter /v2/email-finder -q domain=stripe.com -q first_name=Patrick -q last_name=Collison
```

### Scrape a webpage

```bash theme={null}
orth run olostep /v1/scrapes --body '{
  "url_to_scrape": "https://example.com",
  "formats": ["markdown"]
}'
```

### Search the web

```bash theme={null}
orth run tavily /search --body '{
  "query": "latest AI news",
  "search_depth": "advanced"
}'
```

### Verify an email

```bash theme={null}
orth run tomba /v1/email-verifier -q email=hello@orthogonal.com
```

## Options

| Flag          | Description                 |
| ------------- | --------------------------- |
| `--key <key>` | API key (overrides env var) |
| `--json`      | Output raw JSON             |
| `--help`      | Show help                   |
| `--version`   | Show version                |

## Environment Variables

| Variable             | Description             |
| -------------------- | ----------------------- |
| `ORTHOGONAL_API_KEY` | Your Orthogonal API key |

## Source Code

The CLI is open source: [github.com/orthogonal-sh/cli](https://github.com/orthogonal-sh/cli)