Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/steerlabs/opensteer/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

Get started with OpenSteer by installing the CLI and SDK packages.

​
Requirements

Before installing OpenSteer, ensure you have:
  • Node.js >=20
  • Playwright-supported browser runtime (Chromium, Firefox, or WebKit)
  • Model provider API key for LLM-powered resolution/extraction/CUA (optional for basic features)
1

Install the CLI globally

Install OpenSteer CLI and make it available system-wide:
npm i -g opensteer
2

Install skill packs

Install first-party skill packs for AI agent integration:
opensteer skills install
This installs the OpenSteer skill pack that provides agent workflows and best practices.
3

Verify installation

Check that OpenSteer is installed correctly:
opensteer --version

​
SDK Package Installation

When importing Opensteer in your application code, install the SDK package: 
npm install opensteer

​
Browser Binary Installation

If you don’t have Playwright browser binaries installed, install Chromium: 
npx playwright install chromium
OpenSteer uses Playwright under the hood, so any Playwright-supported browser (Chromium, Firefox, WebKit) will work.

​
Environment Setup

​
API Keys for LLM Features

To use descriptor-based selectors, structured extraction, or CUA agents, configure your model provider API key: 
export OPENAI_API_KEY="your-api-key-here"
You can also use a .env file in your project root. OpenSteer automatically loads environment variables using dotenv.

​
Cloud Mode Configuration

To use OpenSteer in cloud mode, set the following environment variables: 
export OPENSTEER_MODE=cloud
export OPENSTEER_API_KEY="your-opensteer-api-key"
Cloud mode is optional. OpenSteer defaults to local mode. See the Cloud Integration guide for more details.
Optional cloud configuration: 
# Override the default cloud host
export OPENSTEER_BASE_URL="https://your-cloud-host.com"

# Set authentication scheme (api-key or bearer)
export OPENSTEER_AUTH_SCHEME="api-key"

​
Session Management

For non-interactive CLI runs, you can set session identifiers via environment variables: 
export OPENSTEER_SESSION="my-session-id"
# or
export OPENSTEER_CLIENT_ID="my-client-id"

​
Verification

Verify your installation by running a quick test: 
opensteer open https://example.com --session test
opensteer close --session test
If the browser opens and closes successfully, you’re ready to start automating!

​
Next Steps

Quick Start Guide

Learn how to write your first automation script

Build docs developers (and LLMs) love

Get started for freeTalk to us