Skip to content

cli-reference.md

Latest commit

 

History

History
538 lines (355 loc) · 11.8 KB

cli-reference.md

File metadata and controls

538 lines (355 loc) · 11.8 KB
Raw

Steel CLI Reference

This is an auto-generated reference for the Steel CLI. The Steel CLI helps you create, run, and manage browser automation projects in the cloud.

Table of Contents

Global Options

These options are available for most commands:

  • -h, --help: Display help for a command
  • -v, --version: Display Steel CLI version

steel cache

Manage Steel CLI cache which is used to store files for quickly running scripts

Usage

steel cache [options]

Options

  • -c, --clean: Remove all cached files and directories

steel config

Display information about the current session

Usage

steel config

steel docs

Navigates to Steel Docs

Usage

steel docs

steel forge

Start a new project using the Steel CLI

Usage

steel forge [template] [options]

Run steel forge with no arguments to see the current template list interactively. The catalog is sourced from the Steel Cookbook registry.

Arguments

  • template (optional): Example template to start

Options

  • -n, --name: Name of the project
  • -a, --api_url: API URL for Steel API
  • --api_key: API Key for Steel API
  • --openai_key: API Key for OpenAI
  • --anthropic_key: API Key for Anthropic
  • --skip_auth: Skip authentication

steel login

Login to Steel CLI

Usage

steel login

steel logout

Logout from Steel CLI

Usage

steel logout

steel pdf

Generate a webpage PDF through the Steel API

Usage

steel pdf [url] [options]

Arguments

  • url (optional): Target URL to convert

Options

  • -u, --url: Target URL to convert
  • -d, --delay: Delay before PDF generation in milliseconds
  • --use-proxy: Use a Steel-managed residential proxy
  • -r, --region: Region identifier for request execution
  • -l, --local: Send request to local Steel runtime mode
  • --api-url: Explicit self-hosted API endpoint URL

steel scrape

Scrape webpage content through the Steel API (markdown output by default)

Usage

steel scrape [url] [options]

Arguments

  • url (optional): Target URL to scrape

Options

  • -u, --url: Target URL to scrape
  • --format: Comma-separated output formats: html, readability, cleaned_html, markdown
  • --raw: Print full JSON response payload
  • -d, --delay: Delay before scraping in milliseconds
  • --pdf: Include a generated PDF in the scrape response
  • --screenshot: Include a generated screenshot in the scrape response
  • --use-proxy: Use a Steel-managed residential proxy
  • -r, --region: Region identifier for request execution
  • -l, --local: Send request to local Steel runtime mode
  • --api-url: Explicit self-hosted API endpoint URL

steel screenshot

Capture a webpage screenshot through the Steel API

Usage

steel screenshot [url] [options]

Arguments

  • url (optional): Target URL to capture

Options

  • -u, --url: Target URL to capture
  • -d, --delay: Delay before capture in milliseconds
  • -f, --full-page: Capture the full page (not only the viewport)
  • --use-proxy: Use a Steel-managed residential proxy
  • -r, --region: Region identifier for request execution
  • -l, --local: Send request to local Steel runtime mode
  • --api-url: Explicit self-hosted API endpoint URL

steel skills list

List available Steel Skills from the public manifest, cache, or bundled fallback.

Usage

steel skills list [--offline]

steel skills install

Install all Steel Skills, or one or more selected Steel Skills, through npx skills.

Usage

steel skills install --all [-a <agent>] [-g] [-y]
steel skills install <name>... [-a <agent>] [-g] [-y]

steel skills update

Update installed Steel Skills through npx skills.

Usage

steel skills update [name]... [-y]

steel skills doctor

Check Steel Skills health: manifest, npx, auth, and detected install paths.

Usage

steel skills doctor [--offline]

steel skills open

Open an installed skill path when present, otherwise open the skill docs page.

Usage

steel skills open <name>

steel skills paths

Show detected agent install paths for Steel Skills.

Usage

steel skills paths

steel settings

Display current settings

Usage

steel settings

steel star

Navigates to Steel Browser Repository

Usage

steel star

steel support

Navigates to Steel Discord Server

Usage

steel support

steel update

Update Steel CLI to the latest version

Usage

steel update [options]

Options

  • -f, --force: Force update even if already on latest version
  • -c, --check: Only check for updates without installing

steel browser captcha solve

Manually trigger CAPTCHA solving for a Steel browser session

Usage

steel browser captcha solve [options]

Options

  • --session-id: Explicit Steel session id to target
  • -s, --session: Named session key to resolve from local state
  • -l, --local: Resolve session and execute solve call in local mode
  • --api-url: Explicit self-hosted API endpoint URL
  • --page-id: Optional page ID for targeted CAPTCHA solving
  • --url: Optional page URL for targeted CAPTCHA solving
  • --task-id: Optional CAPTCHA task ID for targeted solving
  • --raw: Print the full raw API payload

steel browser captcha status

Get CAPTCHA solving status for a Steel browser session

Usage

steel browser captcha status [options]

Options

  • --session-id: Explicit Steel session id to target
  • -s, --session: Named session key to resolve from local state
  • -l, --local: Resolve session and execute status call in local mode
  • --api-url: Explicit self-hosted API endpoint URL
  • --page-id: Optional page ID for targeted CAPTCHA status
  • -w, --wait: Poll until CAPTCHA is resolved (solved/failed/none)
  • --timeout: Timeout in milliseconds for --wait mode (default: 60000)
  • --interval: Poll interval in milliseconds for --wait mode (default: 1000)
  • --raw: Print the full raw API payload (JSON)

steel browser live

Print active or named session live-view URL

Usage

steel browser live [options]

Options

  • -s, --session: Named session key to resolve live URL for
  • -l, --local: Resolve live URL from local active session
  • --api-url: Explicit self-hosted API endpoint URL

steel browser sessions

List browser sessions as JSON

Usage

steel browser sessions [options]

Options

  • -l, --local: List sessions from local Steel runtime
  • --api-url: Explicit self-hosted API endpoint URL
  • --raw: Include full raw API payload for each session

steel browser start

Create or attach a Steel browser session (cloud by default)

Usage

steel browser start [options]

Options

  • -l, --local: Start or attach a local Steel browser session
  • --api-url: Explicit self-hosted API endpoint URL
  • -s, --session: Named session key for create-or-attach behavior
  • --stealth: Apply stealth preset on new sessions (humanized interactions + auto CAPTCHA solving / solveCaptcha=true)
  • -p, --proxy: Proxy URL for new sessions (for example, http://user:pass@host:port)
  • --session-timeout: Session timeout in milliseconds (create-time only)
  • --inactivity-timeout: Inactivity timeout in milliseconds — release the session when no CDP command or remote input is received for this long (create-time only; defaults to 120000 / 2 minutes, pass 0 to disable)
  • --session-headless: Create new sessions in headless mode (create-time only)
  • --session-region: Preferred session region (create-time only)
  • --session-solve-captcha: Enable manual CAPTCHA solving on new sessions (create-time only; use steel browser captcha solve)
  • --namespace: Credential namespace to use with this session
  • --credentials: Enable credential injection for this session

steel browser stop

Stop the active or named Steel browser session

Usage

steel browser stop [options]

Options

  • -a, --all: Stop all live sessions in the active mode
  • -s, --session: Named session key to stop
  • -l, --local: Stop sessions from local Steel runtime mode
  • --api-url: Explicit self-hosted API endpoint URL

steel credentials create

Store a new credential for a given origin

Usage

steel credentials create [options]

Options

  • --origin: Origin URL to associate the credential with (e.g. https://example.com)
  • -u, --username: Username for the credential
  • -p, --password: Password for the credential
  • --totp-secret: TOTP secret for two-factor authentication (optional)
  • -n, --namespace: Credential namespace (optional)
  • --label: Human-readable label for the credential (optional)

steel credentials delete

Delete a stored credential

Usage

steel credentials delete [options]

Options

  • --origin: Origin URL of the credential to delete
  • -n, --namespace: Credential namespace

steel credentials list

List stored credentials

Usage

steel credentials list [options]

Options

  • -n, --namespace: Filter credentials by namespace
  • --origin: Filter credentials by origin URL

steel credentials update

Update an existing credential

Usage

steel credentials update [options]

Options

  • --origin: Origin URL of the credential to update
  • -u, --username: New username
  • -p, --password: New password
  • --totp-secret: New TOTP secret for two-factor authentication
  • -n, --namespace: Credential namespace
  • --label: New human-readable label

steel dev install

Install local Steel Browser runtime assets without starting containers

Usage

steel dev install [options]

Options

  • --repo-url: Git repository URL for local Steel Browser runtime
  • -V, --verbose: Enable verbose git command output

steel dev start

Start local Steel Browser runtime containers (requires steel dev install)

Usage

steel dev start [options]

Options

  • -p, --port: API port for local Steel Browser runtime
  • -V, --verbose: Enable verbose Docker command output
  • -d, --docker_check: Only verify Docker availability and exit

steel dev stop

Stop local Steel Browser runtime containers

Usage

steel dev stop [options]

Options

  • -V, --verbose: Enable verbose Docker command output

This documentation was auto-generated from the Steel CLI source code.