smooth-browser

# Smooth Browser

Smooth CLI is a browser for AI agents to interact with websites, authenticate, scrape data, and perform complex web-based tasks using natural language.

## Prerequisites

Assume the Smooth CLI is already installed. If not, you can install it by running:

```bash
pip install smooth-py
```

Assume an API key is already configured. If you encounter authentication errors, configure it with:

```bash
smooth config --api-key <api-key>
```

To verify the configuration:
```bash
smooth config --show
```

Get an API key at https://app.smooth.sh

If the account is out of credits, ask the user to upgrade their plan at https://app.smooth.sh

## Basic Workflow

### 1. Create a Profile (Optional)

Profiles are useful to persist cookies, login sessions, and browser state between sessions.

```bash
smooth create-profile --profile-id "my-profile"
```

List existing profiles:
```bash
smooth list-profiles
```

### 2. Start a Browser Session

```bash
smooth start-session --profile-id "my-profile" --url "https://example.com"
```

**Options:**
- `--profile-id` - Use a specific profile (optional, creates anonymous session if not provided)
- `--url` - Initial URL to navigate to (optional)
- `--files` - Comma-separated file IDs to make available in the session (optional)
- `--device mobile|desktop` - Device type (default: mobile)
- `--profile-read-only` - Load profile without saving changes
- `--allowed-urls` - Comma-separated URL patterns to restrict access to certain URLs only (e.g., "https://*example.com/*,https://*api.example.com/*")
- `--no-proxy` - Disable the default proxy (see note below)

**Important:** Save the session ID from the output - you'll need it for all subsequent commands.

**Proxy behavior:** By default, the CLI automatically configures a built-in proxy for the browser session. If a website blocks the proxy or you need direct connections, disable it with `--no-proxy`.

### 3. Run Tasks in the Session

Execute tasks using natural language:

```bash
smoot...