Steel

https://docs.steel.dev
Admin
Steel is an open-source browser API purpose-built for AI agents, enabling them to interact with the...
Tokens:227,860
Snippets:2,126
Trust Score:7.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### Run the Gemini computer use example

Source: https://docs.steel.dev/cookbook/gemini-computer-use

Commands to set up and start the example: copy the environment file, install dependencies, and run npm start. Requires STEEL_API_KEY and GEMINI_API_KEY.

```bash
cd examples/gemini-computer-use-ts
cp .env.example .env          # set STEEL_API_KEY and GEMINI_API_KEY
npm install
npm start
```

--------------------------------

### Setup commands for trigger-dev-browser-job example

Source: https://docs.steel.dev/cookbook/trigger-dev-browser-job

Commands to set up and run the example: copy environment variables, install dependencies, and start the dev server. Requires STEEL_API_KEY, TRIGGER_SECRET_KEY, and TRIGGER_PROJECT_REF in .env.

```bash
cd examples/trigger-dev-browser-job
cp .env.example .env
npm install
npm run dev
```

--------------------------------

### Run the Go example with setup commands

Source: https://docs.steel.dev/cookbook/claude-computer-use

Navigate to the example directory, copy the .env.example file to .env, and set STEEL_API_KEY and ANTHROPIC_API_KEY. Then run the example with 'go run .'.

```bash
cd examples/claude-computer-use-go
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
go run .
```

--------------------------------

### Run the magnitude example

Source: https://docs.steel.dev/cookbook/magnitude

Commands to set up and run the example: copy environment variables, install dependencies, and start the app. Requires STEEL_API_KEY and ANTHROPIC_API_KEY.

```bash
cd examples/magnitude
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
npm install
npm start
```

--------------------------------

### Start the TypeScript service

Source: https://docs.steel.dev/cookbook/restate-agent

Change to the example directory, copy the environment file, set API keys, install dependencies, and start the service.

```bash
cd examples/restate-agent-ts
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
npm install
npm start
```

--------------------------------

### Run the extensions-go example

Source: https://docs.steel.dev/cookbook/extensions

Commands to set up and run the Go example. Requires a STEEL_API_KEY in .env. The session viewer URL prints at start.

```bash
cd examples/extensions-go
cp .env.example .env          # set STEEL_API_KEY
go mod tidy
go run .
```

--------------------------------

### Run the Agent Kit example

Source: https://docs.steel.dev/cookbook/agentkit

Sets up and starts the example from the examples/agentkit directory. Requires STEEL_API_KEY and OPENAI_API_KEY in .env. Each tool invocation creates a fresh session.

```bash
cd examples/agentkit
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
npm install
npm start
```

--------------------------------

### Setup and run commands for Steel + LangGraph example

Source: https://docs.steel.dev/cookbook/langgraph

Commands to set up the environment, install dependencies, and run the example. Requires STEEL_API_KEY and ANTHROPIC_API_KEY in .env. Each tool call prints latency; the open_session tool returns a Live View URL.

```bash
cd examples/langgraph
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
uv sync
uv run playwright install chromium
uv run main.py
```

--------------------------------

### Run the Go example project

Source: https://docs.steel.dev/cookbook/openai-computer-use

Commands to set up and run the example: copy .env.example to .env, set STEEL_API_KEY and OPENAI_API_KEY, install dependencies, and run. The program prints a session viewer URL at startup.

```bash
cd examples/openai-computer-use-go
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
go mod tidy
go run .
```

--------------------------------

### Run the Go credentials example

Source: https://docs.steel.dev/cookbook/credentials

Commands to set up and run the Go example. Requires setting STEEL_API_KEY in .env. The session viewer URL prints at start; open it to watch the auto-fill.

```bash
cd examples/credentials-go
cp .env.example .env          # set STEEL_API_KEY
go mod tidy
go run .
```

--------------------------------

### Run the OpenAI Computer Use example project

Source: https://docs.steel.dev/cookbook/openai-computer-use

Commands to set up and start the example project. Requires STEEL_API_KEY and OPENAI_API_KEY in .env. Expect 60-120 seconds and 15-40 turns for a simple task.

```bash
cd examples/openai-computer-use-ts
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
npm install
npm start
```

--------------------------------

### Run the credentials example

Source: https://docs.steel.dev/cookbook/credentials

Commands to set up and run the credentials example. Requires a STEEL_API_KEY from app.steel.dev/settings/api-keys. The script prints a session viewer URL as it starts.

```bash
cd examples/credentials-ts
cp .env.example .env          # set STEEL_API_KEY
npm install
npm start
```

--------------------------------

### Run the Claude Computer Use example (setup commands)

Source: https://docs.steel.dev/cookbook/claude-computer-use

Commands to set up and run the example in the examples/claude-computer-use-ts directory. Requires STEEL_API_KEY and ANTHROPIC_API_KEY from app.steel.dev and console.anthropic.com.

```bash
cd examples/claude-computer-use-ts
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
npm install
npm start
```

--------------------------------

### Setup commands for claude-computer-use-mobile example

Source: https://docs.steel.dev/cookbook/claude-computer-use-mobile

Commands to set up and run the example. Requires STEEL_API_KEY and ANTHROPIC_API_KEY from app.steel.dev and console.anthropic.com respectively.

```bash
cd examples/claude-computer-use-mobile
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
npm install
npm start
```

--------------------------------

### Run the Selenium example

Source: https://docs.steel.dev/cookbook/selenium

Sets up and runs the example from the examples/selenium directory. Copy .env.example to .env and set STEEL_API_KEY, then run main.py with uv. The script prints a session viewer URL as it starts.

```bash
cd examples/selenium
cp .env.example .env          # set STEEL_API_KEY
uv run main.py
```

--------------------------------

### Run the example: setup and execute

Source: https://docs.steel.dev/cookbook/claude-computer-use

Commands to run the Rust example: change to the example directory, copy the .env.example to .env, set STEEL_API_KEY and ANTHROPIC_API_KEY, and run with cargo. The default TASK is in .env and can be overridden per run.

```bash
cd examples/claude-computer-use-rs
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
cargo run
```

```bash
TASK="Find the current weather in New York City" cargo run
```

--------------------------------

### Run the browser-use CAPTCHA manual example

Source: https://docs.steel.dev/cookbook/browser-use-captcha-manual

Commands to set up and run the example. Requires STEEL_API_KEY and OPENAI_API_KEY in .env. The session viewer URL prints at start.

```bash
cd examples/browser-use-captcha-manual
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
uv run main.py
```

--------------------------------

### Run the Steel + Google ADK example

Source: https://docs.steel.dev/cookbook/google-adk

Commands to set up and start the example. Requires STEEL_API_KEY and GOOGLE_API_KEY in .env. The main() function prints a Live View URL and the agent navigates and scrapes.

```bash
cd examples/google-adk-ts
cp .env.example .env          # set STEEL_API_KEY and GOOGLE_API_KEY
npm install
npm start
```

--------------------------------

### Run the Steel + Notte example (shell)

Source: https://docs.steel.dev/cookbook/notte

Navigate to the example directory, copy the environment template, set STEEL_API_KEY and GEMINI_API_KEY, then run the script with uv. The session viewer URL prints as the script starts.

```bash
cd examples/notte
cp .env.example .env          # set STEEL_API_KEY and GEMINI_API_KEY
uv run main.py
```

--------------------------------

### Run browser-use example with uv

Source: https://docs.steel.dev/cookbook/browser-use

Commands to set up and run the browser-use example. Requires STEEL_API_KEY and OPENAI_API_KEY from app.steel.dev and platform.openai.com respectively. A session viewer URL prints as the script starts.

```bash
cd examples/browser-use
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
uv run main.py
```

--------------------------------

### Setup commands for Python MCP example (mcp-py)

Source: https://docs.steel.dev/cookbook/mcp

Run these commands to set up the Python MCP example. Copy .env.example to .env and set STEEL_API_KEY for local runs, then sync dependencies with uv.

```bash
cd examples/mcp-py
cp .env.example .env          # set STEEL_API_KEY for local runs
uv sync
```

--------------------------------

### Run the auth-context-go example

Source: https://docs.steel.dev/cookbook/auth-context

Commands to set up and run the Go example. Requires copying .env.example to .env and setting STEEL_API_KEY. The run prints two viewer URLs and takes about 20 seconds.

```bash
cd examples/auth-context-go
cp .env.example .env          # set STEEL_API_KEY
go mod tidy
go run .
```

--------------------------------

### Run commands for the example

Source: https://docs.steel.dev/cookbook/vercel-ai-sdk-nextjs

Commands to set up and run the example. Requires setting STEEL_API_KEY and ANTHROPIC_API_KEY in .env. Install dependencies, Playwright Chromium, then start the dev server.

```bash
cd examples/vercel-ai-sdk-nextjs
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
npm install
npx playwright install chromium
npm run dev
```

--------------------------------

### Setup commands for convex-price-watch

Source: https://docs.steel.dev/cookbook/convex-price-watch

Run these commands in the project directory to install dependencies, copy the environment template, and start a Convex dev deployment.

```bash
cd examples/convex-price-watch
npm install
cp .env.example .env       # fill in STEEL_API_KEY
npx convex dev             # creates a dev deployment on first run
```

--------------------------------

### Run worker and workflow client

Source: https://docs.steel.dev/cookbook/temporal-browser-workflow

Installs dependencies and starts the worker and workflow client for the Temporal browser workflow example. Requires setting STEEL_API_KEY in .env.

```bash
cd examples/temporal-browser-workflow-ts
cp .env.example .env
npm install
npm start
```

--------------------------------

### Setup and run commands

Source: https://docs.steel.dev/cookbook/convex-chat-with-page

Commands to install dependencies, copy environment variables, and start the Convex dev server. Convex actions don't inherit shell env, so keys must be set on the deployment.

```bash
cd examples/convex-chat-with-page
npm install
cp .env.example .env       # fill in STEEL_API_KEY and OPENAI_API_KEY
npx convex dev             # creates a dev deployment on first run
```

```bash
npx convex env set STEEL_API_KEY "$STEEL_API_KEY"
npx convex env set OPENAI_API_KEY "$OPENAI_API_KEY"
npm run dev                # vite frontend
```

--------------------------------

### Run the Gemini Computer Use Go example

Source: https://docs.steel.dev/cookbook/gemini-computer-use

Commands to set up and run the example. Requires setting STEEL_API_KEY and GEMINI_API_KEY in the .env file. Keys are obtained from app.steel.dev/settings/api-keys and aistudio.google.com/apikey.

```bash
cd examples/gemini-computer-use-go
cp .env.example .env          # set STEEL_API_KEY and GEMINI_API_KEY
go mod tidy
go run .
```

--------------------------------

### Start Restate server

Source: https://docs.steel.dev/cookbook/restate-agent

Start the Restate server in a terminal. This is the first step to run the example.

```bash
restate-server
```

--------------------------------

### Start Restate server

Source: https://docs.steel.dev/cookbook/restate-agent

Installs the Restate server and SDK globally, then starts the server. Requires Node.js and npm.

```bash
npm install --global @restatedev/restate-server@latest @restatedev/restate@latest
restate-server
```

--------------------------------

### Run the headless-chrome example

Source: https://docs.steel.dev/cookbook/headless-chrome

Commands to set up and run the example. Copy the environment file, set STEEL_API_KEY, and run cargo. The first build takes a minute or two.

```bash
cd examples/headless-chrome
cp .env.example .env          # set STEEL_API_KEY
cargo run
```

--------------------------------

### Run the Go profiles example

Source: https://docs.steel.dev/cookbook/profiles

Commands to set up and run the Go example. Requires a STEEL_API_KEY in .env, obtainable from app.steel.dev/settings/api-keys.

```bash
cd examples/profiles-go
cp .env.example .env          # set STEEL_API_KEY
go mod tidy
go run .
```

--------------------------------

### Install Restate server and CLI

Source: https://docs.steel.dev/cookbook/restate-agent

Install the Restate server and CLI globally using npm. Required before starting the service.

```bash
npm install --global @restatedev/restate-server@latest @restatedev/restate@latest
```

--------------------------------

### Run the credentials example

Source: https://docs.steel.dev/cookbook/credentials

Commands to run the example from the examples/credentials-py directory. Copy .env.example to .env and set STEEL_API_KEY, then run with uv. uv sync runs automatically on first run. Alternatively, use pip install -e . and python main.py.

```bash
cd examples/credentials-py
cp .env.example .env          # set STEEL_API_KEY
uv run main.py
```

--------------------------------

### Setup and run commands for You.com search agent

Source: https://docs.steel.dev/cookbook/you-com-search

Commands to set up and run the example. Requires setting STEEL_API_KEY, ANTHROPIC_API_KEY, and YOUCOM_API_KEY in .env. Uses uv for dependency management and Playwright for Chromium.

```bash
cd examples/you-com-search
cp .env.example .env          # set STEEL_API_KEY, ANTHROPIC_API_KEY, YOUCOM_API_KEY
uv sync
uv run playwright install chromium
uv run main.py
```

--------------------------------

### Setup commands for deep-research-py example

Source: https://docs.steel.dev/cookbook/deep-research

Commands to set up and run the deep research example. Requires STEEL_API_KEY and ANTHROPIC_API_KEY from the respective consoles.

```bash
cd examples/deep-research-py
cp .env.example .env          # set STEEL_API_KEY and ANTHROPIC_API_KEY
uv run playwright install chromium
uv run main.py
```

--------------------------------

### Run the Stagehand example

Source: https://docs.steel.dev/cookbook/stagehand

Commands to set up and run the example. Requires STEEL_API_KEY and OPENAI_API_KEY in .env. The script prints a session viewer URL as it starts.

```bash
cd examples/stagehand-py
cp .env.example .env          # set STEEL_API_KEY and OPENAI_API_KEY
uv run main.py
```

--------------------------------

### Run the extensions example with npm start

Source: https://docs.steel.dev/cookbook/extensions

Commands to set up and run the extensions example. Requires a Steel API key set in the .env file. The script prints a session viewer URL for live monitoring.

```bash
cd examples/extensions-ts
cp .env.example .env          # set STEEL_API_KEY
npm install
npm start
```

--------------------------------

### Run the Gemini computer use example

Source: https://docs.steel.dev/cookbook/gemini-computer-use

Commands to set up and run the example. Requires STEEL_API_KEY and GEMINI_API_KEY in .env. Uses uv to run main.py.

```bash
cd examples/gemini-computer-use-py
cp .env.example .env          # set STEEL_API_KEY and GEMINI_API_KEY
uv run main.py
```

--------------------------------

### Run the Google ADK Go starter

Source: https://docs.steel.dev/cookbook/google-adk

Sets up and runs the starter: copy .env.example to .env, set STEEL_API_KEY and GOOGLE_API_KEY, install dependencies, and run. GOOGLE_GENAI_USE_VERTEXAI=FALSE keeps the genai client on AI Studio so only the API key is needed. The program prints a session viewer URL and each tool call's latency.

```bash
cd examples/google-adk-go
cp .env.example .env          # set STEEL_API_KEY and GOOGLE_API_KEY
go mod tidy
go run .
```
Tokens:
Raw