Getting Started
Installation
Install the OpenSteer package, CLI, Playwright browser, and optional first-party skills.
Installation
Install OpenSteer, install a browser, then verify the runtime you plan to use.
Prerequisites
- Node.js 22 or newer
- Chromium installed through Playwright if you plan to use the default local engine
Install the package
Install the published package in application code:
npm install opensteer
If you want the CLI on your path:
npm install -g opensteer
You can also run the CLI without a global install:
npx --yes opensteer@latest --help
Install the Playwright browser
OpenSteer uses the Playwright-backed engine by default.
npx playwright install chromium
Optional: use a specific local Chrome build
If you want OpenSteer to launch a specific local browser binary, point it at that executable:
export OPENSTEER_EXECUTABLE_PATH=/path/to/chrome
Install first-party skills
Install the default opensteer skill pack:
opensteer skills install
Install every packaged skill:
opensteer skills install --all
Install for a specific agent:
opensteer skills install --agent claude-code
Optional: install the ABP engine
If you want the Agent Browser Protocol engine locally:
npm install @opensteer/engine-abp
ABP is local-only. Cloud mode currently requires Playwright.
Optional: cloud environment
Cloud mode needs the provider switch plus an API key and base URL:
export OPENSTEER_PROVIDER=cloud
export OPENSTEER_API_KEY=your_api_key
export OPENSTEER_BASE_URL=https://your-control-api
OPENSTEER_CLOUD_APP_BASE_URL is only required for opensteer record --provider cloud.
Verify
Check provider resolution and workspace status:
opensteer status
Check the package version:
opensteer --version
If local Playwright is installed correctly, the next step is Quick Start.
