@kaizenautomation/desktop-client
v1.0.1
Published
Browser automation with ngrok tunnel
Keywords
Readme
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
- Launches a headless Chrome browser with remote debugging enabled
- Creates a secure ngrok tunnel to expose the browser's debugging port
- Registers the remote desktop with the Kaizen API
- Maintains the connection until shutdown
Prerequisites
- Install Playwright globally:
npm install -g playwright
npx playwright install
npx playwright install-deps- Install the Kaizen Desktop Client:
npm install -g @kaizenautomation/desktop-clientEnvironment Variables
The following environment variables are required:
NGROK_AUTH_TOKEN=your_ngrok_token
TRUCKSMARTER_REMOTE_DESKTOP_CLIENT_BEARER_AUTH_TOKEN=your_auth_token
KAIZEN_API_URL=https://api.kaizenautomation.comUsage
Run with environment variables:
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-clientOr specify environment variables inline:
NGROK_AUTH_TOKEN=xxx \
TRUCKSMARTER_REMOTE_DESKTOP_CLIENT_BEARER_AUTH_TOKEN=yyy \
KAIZEN_API_URL=zzz \
kaizen-desktop-clientCleanup
The client handles cleanup automatically on shutdown:
- Closes the Chrome browser
- Terminates the ngrok tunnel
- Deregisters from the Kaizen API
