Appearance
Install
Prerequisites
- Docker installed and running
- Docker Compose (included with Docker Desktop; or install standalone)
Verify before proceeding:
bash
docker --version
docker compose versionOption 1: Automated setup (recommended)
Run the CLI bootstrapper. It clones the repo and starts Docker Compose for you:
bash
npx browserableThen open the UI at http://localhost:2001 and configure your API keys under Settings.
Option 2: Manual setup
bash
git clone https://github.com/browserable/browserable.git
cd browserable/deployment
docker-compose -f docker-compose.dev.yml upServices start on the same ports as the automated setup.
JS SDK (for programmatic access)
Install the SDK into your own Node.js project after the server is running:
bash
npm install browserable-js
# or
yarn add browserable-js
# or
pnpm add browserable-jsThe SDK talks to your local Browserable server. Retrieve your API key from http://localhost:2001/dash/@admin/settings.
Required configuration (after server start)
Navigate to http://localhost:2001/dash/@admin/settings and add:
- At least one LLM provider key: Gemini, OpenAI, or Claude (Anthropic)
- At least one remote browser provider key: Hyperbrowser or Steel
Without both, task creation will fail.