Kameleo SOP

Appearance

Install ​

Kameleo has two parts: the Engine (the desktop app / Docker container that runs browser profiles) and the SDK (the language client that talks to the Engine over its local REST/WebSocket API at http://localhost:5050).

Step 1 -- Install the Kameleo Engine ​

The Engine must be running before any SDK call will work.

Windows (winget):

bash
winget install Kameleo.App

macOS (Homebrew):

bash
brew install --cask kameleo

Docker (Linux / Windows containers):

bash
docker pull kameleo/kameleo-app:latest
docker run -d -p 5050:5050 kameleo/kameleo-app:latest

A GUI installer is also available at https://kameleo.io for direct download on Windows and macOS.

Step 2 -- Install the SDK for Your Language ​

Pick one. The SDK version should match the Engine's major.minor version.

Python:

bash
pip install kameleo.local-api-client

Node.js / TypeScript:

bash
npm install @kameleo/local-api-client

If using Playwright alongside the Node.js SDK:

bash
npm install @kameleo/local-api-client playwright

.NET / C#:

bash
dotnet add package Kameleo.LocalApiClient

Notes ​

  • A Kameleo account is required. Sign up at https://kameleo.io (free tier available, no credit card).
  • On first Engine launch, log in with your Kameleo credentials inside the app. The Engine validates your plan against the cloud license server before exposing the local API.
  • Default API endpoint: http://localhost:5050
  • No environment variables or API keys are needed in the SDK -- it connects to the local Engine by URL only.