open-index/open-npm huggingface dataset:
npm package: @kaizenautomation/desktop-client
Description: Browser automation with ngrok tunnel
Latest version: 1.0.1

# Kaizen Desktop Client

A headless Chrome browser client that enables remote browser automation through an ngrok tunnel. This client is designed to work with the Kaizen API for remote browser control and automation.

## What it Does

1. Launches a headless Chrome browser with remote debugging enabled
2. Creates a secure ngrok tunnel to expose the browser's debugging port
3. Registers the remote desktop with the Kaizen API
4. Maintains the connection until shutdown

## Prerequisites

1. Install Playwright globally:
```bash
npm install -g playwright
npx playwright install
npx playwright install-deps
```

2. Install the Kaizen Desktop Client:
```bash
npm install -g @kaizenautomation/desktop-client
```

## Environment Variables

The following environment variables are required:

```bash
NGROK_AUTH_TOKEN=your_ngrok_token
TRUCKSMARTER_REMOTE_DESKTOP_CLIENT_BEARER_AUTH_TOKEN=your_auth_token
KAIZEN_API_URL=https://api.kaizenautomation.com
```

## Usage

Run with environment variables:

```bash
export NGROK_AUTH_TOKEN=your_ngrok_token
export TRUCKSMARTER_REMOTE_DESKTOP_CLIENT_BEARER_AUTH_TOKEN=your_auth_token
export KAIZEN_API_URL=your_api_url
kaizen-desktop-client
```

Or specify environment variables inline:

```bash
NGROK_AUTH_TOKEN=xxx \
TRUCKSMARTER_REMOTE_DESKTOP_CLIENT_BEARER_AUTH_TOKEN=yyy \
KAIZEN_API_URL=zzz \
kaizen-desktop-client
```

## Cleanup

The client handles cleanup automatically on shutdown:

- Closes the Chrome browser
- Terminates the ngrok tunnel
- Deregisters from the Kaizen API