Cloud mode runs browser sessions on Opensteer Cloud's managed infrastructure instead of your local machine. Useful for production, CI, and environments without a display.

Enable Cloud Mode

export OPENSTEER_PROVIDER=cloud
export OPENSTEER_API_KEY=your-api-key

Or via SDK constructor:

const os = new Opensteer({
  workspace: "demo",
  provider: {
    mode: "cloud",
    apiKey: "your-api-key",
  },
});

Cloud Session Lifecycle

1. open() creates a cloud browser session
2. All actions (snapshot, click, input, etc.) are proxied to the cloud browser
3. close() terminates the cloud session

const os = new Opensteer({
  workspace: "demo",
  provider: { mode: "cloud", apiKey: process.env.OPENSTEER_API_KEY },
});
await os.open("https://example.com");
const snap = await os.snapshot("action");
await os.click({ element: 3 });
await os.close();

Browser Profiles

Cloud sessions can use managed browser profiles for cookie/state persistence:

const os = new Opensteer({
  workspace: "demo",
  provider: { mode: "cloud" },
  launch: { profileId: "my-profile" },
});

Configuration Precedence

1. Built-in defaults
2. Environment variables (OPENSTEER_PROVIDER, OPENSTEER_API_KEY, etc.)
3. SDK constructor provider options

Launch Context

Cloud sessions accept launch context metadata:

const os = new Opensteer({
  workspace: "demo",
  provider: { mode: "cloud" },
  launch: {
    launchContext: {
      sourceType: "local-cloud",
      name: "my-scraper",
      model: "gpt-4",
    },
  },
});

Supported Methods in Cloud Mode

Most SDK methods work identically in cloud mode. These are not supported:

• uploadFile()

These throw CLOUD_UNSUPPORTED_METHOD.

Cloud Errors

Code	Description
CLOUD_AUTH_FAILED	Invalid or missing API key
CLOUD_SESSION_NOT_FOUND	Session expired or not found
CLOUD_CAPACITY_EXHAUSTED	No capacity available
CLOUD_RATE_LIMITED	Too many requests
CLOUD_UNSUPPORTED_METHOD	Method not available in cloud mode
CLOUD_CONTRACT_MISMATCH	SDK/cloud version mismatch
CLOUD_INTERNAL	Internal server error