From 6b2b400b8026ab2dbc5209cbdab8e08ade355d8c Mon Sep 17 00:00:00 2001 From: junhsss Date: Thu, 10 Sep 2026 20:17:31 +0900 Subject: [PATCH 1/2] docs(generator): render global options and the intro --- scripts/generate-docs.mjs | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/scripts/generate-docs.mjs b/scripts/generate-docs.mjs index 8689dd5..dd5efa9 100644 --- a/scripts/generate-docs.mjs +++ b/scripts/generate-docs.mjs @@ -30,20 +30,32 @@ function flatten(node, path = []) { return [...own, ...children]; } +function parameterLine(parameter) { + const names = []; + if (parameter.short) names.push(`-${parameter.short}`); + if (!parameter.positional) names.push(`--${parameter.name}`); + if (parameter.positional) names.push(parameter.name); + const required = parameter.required ? "required" : "optional"; + const description = parameter.description ? `: ${parameter.description}` : ""; + return `- \`${names.join(", ")}\` (${parameter.type}, ${required})${description}`; +} + function renderParameters(parameters = []) { if (!parameters.length) return ""; - const lines = ["### Parameters", ""]; - for (const parameter of parameters) { - const names = []; - if (parameter.short) names.push(`-${parameter.short}`); - if (!parameter.positional) names.push(`--${parameter.name}`); - if (parameter.positional) names.push(parameter.name); - const required = parameter.required ? "required" : "optional"; - const description = parameter.description ? `: ${parameter.description}` : ""; - lines.push(`- \`${names.join(", ")}\` (${parameter.type}, ${required})${description}`); - } - lines.push(""); - return lines.join("\n"); + return ["### Parameters", "", ...parameters.map(parameterLine), ""].join("\n"); +} + +function renderGlobalOptions(parameters = []) { + return [ + "## Global Options", + "", + "These options are accepted by every command.", + "", + ...parameters.map(parameterLine), + "- `-h, --help`: Print help for a command", + "- `-V, --version`: Print the Steel CLI version", + "", + ].join("\n"); } function renderApiOperations(operations = []) { @@ -66,12 +78,13 @@ const commands = flatten(root); const lines = [ "# Steel CLI Reference", "", - "This file is generated from `steel describe --all` and API metadata.", + `${root.description}. This file is generated from \`steel describe --all\` and API metadata; regenerate it with \`npm run docs:generate\`.`, "", "## Table of Contents", "", ...commands.map((command) => `- [${command.command}](#${slug(command.command)})`), "", + renderGlobalOptions(root.global_args), ]; for (const command of commands) { From bd075fdb399fe00ad4dd866d55e12f6f30eea360 Mon Sep 17 00:00:00 2001 From: junhsss Date: Thu, 10 Sep 2026 20:17:31 +0900 Subject: [PATCH 2/2] docs: regenerate the cli reference --- docs/cli-reference.md | 2152 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 1888 insertions(+), 264 deletions(-) diff --git a/docs/cli-reference.md b/docs/cli-reference.md index be8b4c3..7130505 100644 --- a/docs/cli-reference.md +++ b/docs/cli-reference.md @@ -1,538 +1,2162 @@ # 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. +Steel CLI - browser automation for AI agents. This file is generated from `steel describe --all` and API metadata; regenerate it with `npm run docs:generate`. ## Table of Contents -- [steel cache](#steel-cache) -- [steel config](#steel-config) -- [steel docs](#steel-docs) -- [steel forge](#steel-forge) -- [steel login](#steel-login) -- [steel logout](#steel-logout) -- [steel pdf](#steel-pdf) - [steel scrape](#steel-scrape) - [steel screenshot](#steel-screenshot) -- [steel skills list](#steel-skills-list) -- [steel skills install](#steel-skills-install) -- [steel skills update](#steel-skills-update) -- [steel skills doctor](#steel-skills-doctor) -- [steel skills open](#steel-skills-open) -- [steel skills paths](#steel-skills-paths) -- [steel settings](#steel-settings) -- [steel star](#steel-star) -- [steel support](#steel-support) -- [steel update](#steel-update) -- [steel browser captcha solve](#steel-browser-captcha-solve) -- [steel browser captcha status](#steel-browser-captcha-status) -- [steel browser live](#steel-browser-live) -- [steel browser sessions](#steel-browser-sessions) +- [steel pdf](#steel-pdf) +- [steel browser](#steel-browser) - [steel browser start](#steel-browser-start) - [steel browser stop](#steel-browser-stop) -- [steel credentials create](#steel-credentials-create) -- [steel credentials delete](#steel-credentials-delete) +- [steel browser sessions](#steel-browser-sessions) +- [steel browser live](#steel-browser-live) +- [steel browser captcha](#steel-browser-captcha) +- [steel browser captcha solve](#steel-browser-captcha-solve) +- [steel browser captcha status](#steel-browser-captcha-status) +- [steel browser batch](#steel-browser-batch) +- [steel browser navigate](#steel-browser-navigate) +- [steel browser back](#steel-browser-back) +- [steel browser forward](#steel-browser-forward) +- [steel browser reload](#steel-browser-reload) +- [steel browser click](#steel-browser-click) +- [steel browser dblclick](#steel-browser-dblclick) +- [steel browser fill](#steel-browser-fill) +- [steel browser type](#steel-browser-type) +- [steel browser press](#steel-browser-press) +- [steel browser hover](#steel-browser-hover) +- [steel browser focus](#steel-browser-focus) +- [steel browser check](#steel-browser-check) +- [steel browser uncheck](#steel-browser-uncheck) +- [steel browser select](#steel-browser-select) +- [steel browser clear](#steel-browser-clear) +- [steel browser selectall](#steel-browser-selectall) +- [steel browser scroll](#steel-browser-scroll) +- [steel browser scrollintoview](#steel-browser-scrollintoview) +- [steel browser setvalue](#steel-browser-setvalue) +- [steel browser snapshot](#steel-browser-snapshot) +- [steel browser screenshot](#steel-browser-screenshot) +- [steel browser eval](#steel-browser-eval) +- [steel browser find](#steel-browser-find) +- [steel browser content](#steel-browser-content) +- [steel browser get](#steel-browser-get) +- [steel browser get text](#steel-browser-get-text) +- [steel browser get html](#steel-browser-get-html) +- [steel browser get value](#steel-browser-get-value) +- [steel browser get attr](#steel-browser-get-attr) +- [steel browser get url](#steel-browser-get-url) +- [steel browser get title](#steel-browser-get-title) +- [steel browser get count](#steel-browser-get-count) +- [steel browser get box](#steel-browser-get-box) +- [steel browser get styles](#steel-browser-get-styles) +- [steel browser is](#steel-browser-is) +- [steel browser is visible](#steel-browser-is-visible) +- [steel browser is enabled](#steel-browser-is-enabled) +- [steel browser is checked](#steel-browser-is-checked) +- [steel browser wait](#steel-browser-wait) +- [steel browser tab](#steel-browser-tab) +- [steel browser tab list](#steel-browser-tab-list) +- [steel browser tab new](#steel-browser-tab-new) +- [steel browser tab switch](#steel-browser-tab-switch) +- [steel browser tab close](#steel-browser-tab-close) +- [steel browser cookies](#steel-browser-cookies) +- [steel browser cookies set](#steel-browser-cookies-set) +- [steel browser cookies clear](#steel-browser-cookies-clear) +- [steel browser storage](#steel-browser-storage) +- [steel browser storage local](#steel-browser-storage-local) +- [steel browser storage local set](#steel-browser-storage-local-set) +- [steel browser storage local clear](#steel-browser-storage-local-clear) +- [steel browser storage session](#steel-browser-storage-session) +- [steel browser storage session set](#steel-browser-storage-session-set) +- [steel browser storage session clear](#steel-browser-storage-session-clear) +- [steel browser drag](#steel-browser-drag) +- [steel browser upload](#steel-browser-upload) +- [steel browser highlight](#steel-browser-highlight) +- [steel browser set](#steel-browser-set) +- [steel browser set viewport](#steel-browser-set-viewport) +- [steel browser set geo](#steel-browser-set-geo) +- [steel browser set offline](#steel-browser-set-offline) +- [steel browser set headers](#steel-browser-set-headers) +- [steel browser set useragent](#steel-browser-set-useragent) +- [steel browser bringtofront](#steel-browser-bringtofront) +- [steel browser diff](#steel-browser-diff) +- [steel browser diff snapshot](#steel-browser-diff-snapshot) +- [steel browser diff screenshot](#steel-browser-diff-screenshot) +- [steel browser close](#steel-browser-close) +- [steel sessions](#steel-sessions) +- [steel sessions list](#steel-sessions-list) +- [steel sessions get](#steel-sessions-get) +- [steel sessions release](#steel-sessions-release) +- [steel sessions logs](#steel-sessions-logs) +- [steel sessions agent-logs](#steel-sessions-agent-logs) +- [steel sessions traces](#steel-sessions-traces) +- [steel computer](#steel-computer) +- [steel computer create](#steel-computer-create) +- [steel computer list](#steel-computer-list) +- [steel computer get](#steel-computer-get) +- [steel computer delete](#steel-computer-delete) +- [steel computer pause](#steel-computer-pause) +- [steel computer resume](#steel-computer-resume) +- [steel computer use](#steel-computer-use) +- [steel computer exec](#steel-computer-exec) +- [steel computer ssh](#steel-computer-ssh) +- [steel init](#steel-init) +- [steel login](#steel-login) +- [steel logout](#steel-logout) +- [steel credentials](#steel-credentials) - [steel credentials list](#steel-credentials-list) +- [steel credentials create](#steel-credentials-create) - [steel credentials update](#steel-credentials-update) +- [steel credentials delete](#steel-credentials-delete) +- [steel dev](#steel-dev) - [steel dev install](#steel-dev-install) - [steel dev start](#steel-dev-start) - [steel dev stop](#steel-dev-stop) +- [steel forge](#steel-forge) +- [steel config](#steel-config) +- [steel update](#steel-update) +- [steel cache](#steel-cache) +- [steel profile](#steel-profile) +- [steel profile list](#steel-profile-list) +- [steel profile import](#steel-profile-import) +- [steel profile sync](#steel-profile-sync) +- [steel profile delete](#steel-profile-delete) +- [steel describe](#steel-describe) +- [steel doctor](#steel-doctor) +- [steel skills](#steel-skills) +- [steel skills list](#steel-skills-list) +- [steel skills install](#steel-skills-install) +- [steel skills update](#steel-skills-update) +- [steel skills doctor](#steel-skills-doctor) +- [steel skills open](#steel-skills-open) +- [steel skills paths](#steel-skills-paths) +- [steel completion](#steel-completion) ## Global Options -These options are available for most commands: +These options are accepted by every command. -- **-h, --help**: Display help for a command -- **-v, --version**: Display Steel CLI version +- `--json` (boolean, optional): Output all results as JSON (structured output for automation) +- `--local` (boolean, optional): Use local Steel runtime instead of cloud +- `--api-url` (string, optional): Explicit self-hosted API endpoint URL +- `-h, --help`: Print help for a command +- `-V, --version`: Print the Steel CLI version -## steel cache +## steel scrape -Manage Steel CLI cache which is used to store files for quickly running scripts +Scrape webpage content ### Usage -``` -steel cache [options] +```bash +steel scrape ``` -### Options +### Parameters -- -c, **--clean**: Remove all cached files and directories +- `url` (string, optional): Target URL to scrape +- `--format` (string, optional): Comma-separated output formats: html, readability, cleaned_html, markdown +- `-d, --delay` (string, optional): Delay before scraping in milliseconds +- `--pdf` (boolean, optional): Include a generated PDF in the response +- `--screenshot` (boolean, optional): Include a generated screenshot in the response +- `--use-proxy` (boolean, optional): Use a Steel-managed residential proxy +- `-r, --region` (string, optional): Region identifier for request execution -## steel config +## steel screenshot -Display information about the current session +Capture a screenshot of a webpage ### Usage +```bash +steel screenshot ``` -steel config -``` -## steel docs +### Parameters + +- `url` (string, optional): Target URL to capture +- `-d, --delay` (string, optional): Delay before capturing in milliseconds +- `-f, --full-page` (boolean, optional): Capture a full-page screenshot +- `--use-proxy` (boolean, optional): Use a Steel-managed residential proxy +- `-r, --region` (string, optional): Region identifier for request execution + +## steel pdf -Navigates to Steel Docs +Generate a PDF from a webpage ### Usage -``` -steel docs +```bash +steel pdf ``` -## steel forge +### Parameters + +- `url` (string, optional): Target URL to generate PDF from +- `-d, --delay` (string, optional): Delay before generating in milliseconds +- `--use-proxy` (boolean, optional): Use a Steel-managed residential proxy +- `-r, --region` (string, optional): Region identifier for request execution + +## steel browser -Start a new project using the Steel CLI +Browser session management and automation ### Usage -``` -steel forge [template] [options] -``` +```bash +steel browser +``` + +### Subcommands + +- `start`: Create or attach to a browser session +- `stop`: Stop a browser session +- `sessions`: List active browser sessions +- `live`: Open the live session viewer +- `captcha`: CAPTCHA management +- `batch`: Run multiple browser commands in a single invocation +- `navigate`: Navigate to a URL +- `back`: Navigate back in history +- `forward`: Navigate forward in history +- `reload`: Reload the current page +- `click`: Click an element +- `dblclick`: Double-click an element +- `fill`: Fill an input field (clears existing value first) +- `type`: Type text into an element (appends to existing value) +- `press`: Press a keyboard key +- `hover`: Hover over an element +- `focus`: Focus an element +- `check`: Check a checkbox or radio button +- `uncheck`: Uncheck a checkbox +- `select`: Select option(s) from a dropdown +- `clear`: Clear an input field +- `selectall`: Select all text in an input +- `scroll`: Scroll the page or an element +- `scrollintoview`: Scroll an element into view +- `setvalue`: Set the value of an input element (without triggering events) +- `snapshot`: Take an accessibility tree snapshot +- `screenshot`: Take a screenshot +- `eval`: Evaluate JavaScript in the page +- `find`: Find all elements matching a selector +- `content`: Get the page HTML content +- `get`: Get information about elements or page +- `is`: Check element state +- `wait`: Wait for a condition (text, selector, URL, function, or timeout) +- `tab`: Manage tabs +- `cookies`: Manage browser cookies +- `storage`: Manage browser storage (localStorage/sessionStorage) +- `drag`: Drag and drop from one element to another +- `upload`: Upload files to a file input element +- `highlight`: Visually highlight an element +- `set`: Configure browser settings (viewport, geolocation, etc.) +- `bringtofront`: Bring the browser window to the foreground +- `diff`: Compare snapshots or screenshots +- `close`: Close the browser session + +## steel browser start -Run `steel forge` with no arguments to see the current template list interactively. The catalog is sourced from the [Steel Cookbook](https://github.com/steel-dev/steel-cookbook) registry. +Create or attach to a browser session -### Arguments +### Usage -- **template** (optional): Example template to start +```bash +steel browser start +``` -### Options +### Parameters -- -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 +- `--stealth` (boolean, optional): Enable stealth mode (humanize interactions + auto CAPTCHA) +- `-p, --proxy` (string, optional): Use a residential proxy +- `--session-timeout` (string, optional): Session timeout in milliseconds (create-time only) +- `--inactivity-timeout` (string, optional): Inactivity timeout in milliseconds: release the session when no CDP command or remote input is received for this long. Defaults to 120000 (2 minutes); pass 0 to disable (create-time only) +- `--session-solve-captcha` (boolean, optional): Enable manual CAPTCHA solving on new sessions (create-time only) +- `--profile` (string, optional): Named profile to persist browser state across sessions +- `--update-profile` (boolean, optional): Save session state back to the profile when the session ends +- `--namespace` (string, optional): Credential namespace +- `--credentials` (boolean, optional): Inject credentials -## steel login +## steel browser stop -Login to Steel CLI +Stop a browser session ### Usage -``` -steel login +```bash +steel browser stop ``` -## steel logout +### Parameters -Logout from Steel CLI +- `-a, --all` (boolean, optional): Stop all sessions + +## steel browser sessions + +List active browser sessions ### Usage -``` -steel logout +```bash +steel browser sessions ``` -## steel pdf +## steel browser live -Generate a webpage PDF through the Steel API +Open the live session viewer ### Usage -``` -steel pdf [url] [options] +```bash +steel browser live ``` -### Arguments +## steel browser captcha -- **url** (optional): Target URL to convert +CAPTCHA management -### Options +### Usage -- -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 +```bash +steel browser captcha +``` -## steel scrape +### Subcommands -Scrape webpage content through the Steel API (markdown output by default) +- `solve`: Solve a CAPTCHA on the current page +- `status`: Check CAPTCHA status + +## steel browser captcha solve + +Solve a CAPTCHA on the current page ### Usage -``` -steel scrape [url] [options] +```bash +steel browser captcha solve ``` -### Arguments +### Parameters -- **url** (optional): Target URL to scrape +- `--session-id` (string, optional): Explicit session ID (overrides --session name lookup) +- `--page-id` (string, optional): Page ID +- `--url` (string, optional): Page URL for targeted CAPTCHA solving +- `--task-id` (string, optional): CAPTCHA task ID for targeted solving -### Options +## steel browser captcha status -- -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 +Check CAPTCHA status -## steel screenshot +### Usage + +```bash +steel browser captcha status +``` + +### Parameters + +- `--session-id` (string, optional): Explicit session ID (overrides --session name lookup) +- `--page-id` (string, optional): Page ID +- `-w, --wait` (boolean, optional): Wait for terminal status +- `--timeout` (string, optional): Timeout in milliseconds for --wait mode +- `--interval` (string, optional): Poll interval in milliseconds for --wait mode + +## steel browser batch -Capture a webpage screenshot through the Steel API +Run multiple browser commands in a single invocation ### Usage -``` -steel screenshot [url] [options] +```bash +steel browser batch ``` -### Arguments +### Parameters -- **url** (optional): Target URL to capture +- `commands` (string[], required): Commands to execute (each as a quoted string, e.g. "click @e3") +- `--bail` (boolean, optional): Stop on first error -### Options +## steel browser navigate -- -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 +Navigate to a URL -## steel skills list +### Usage + +```bash +steel browser navigate +``` + +Aliases: `open`, `goto` + +### Parameters + +- `url` (string, required): URL to navigate to +- `--wait-until` (string, optional): Wait condition: load, domcontentloaded, networkidle +- `--header` (string[], optional): Set request header (repeatable, format: "Key: Value") -List available Steel Skills from the public manifest, cache, or bundled fallback. +## steel browser back + +Navigate back in history ### Usage -``` -steel skills list [--offline] +```bash +steel browser back ``` -## steel skills install +## steel browser forward -Install all Steel Skills, or one or more selected Steel Skills, through `npx skills`. +Navigate forward in history ### Usage -``` -steel skills install --all [-a ] [-g] [-y] -steel skills install ... [-a ] [-g] [-y] +```bash +steel browser forward ``` -## steel skills update +## steel browser reload -Update installed Steel Skills through `npx skills`. +Reload the current page ### Usage -``` -steel skills update [name]... [-y] +```bash +steel browser reload ``` -## steel skills doctor +## steel browser click -Check Steel Skills health: manifest, `npx`, auth, and detected install paths. +Click an element ### Usage -``` -steel skills doctor [--offline] +```bash +steel browser click ``` -## steel skills open +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) +- `--button` (string, optional): Mouse button: left, right, middle +- `--count` (string, optional): Number of clicks (2 for double-click) +- `--new-tab` (boolean, optional): Open the link in a new tab instead of clicking -Open an installed skill path when present, otherwise open the skill docs page. +## steel browser dblclick + +Double-click an element ### Usage -``` -steel skills open +```bash +steel browser dblclick ``` -## steel skills paths +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) -Show detected agent install paths for Steel Skills. +## steel browser fill + +Fill an input field (clears existing value first) ### Usage +```bash +steel browser fill ``` -steel skills paths -``` -## steel settings +### Parameters + +- `selector` (string, required): Element selector or ref +- `value` (string[], optional): Value to fill -Display current settings +## steel browser type + +Type text into an element (appends to existing value) ### Usage +```bash +steel browser type ``` -steel settings + +### Parameters + +- `selector` (string, required): Element selector or ref +- `text` (string[], optional): Text to type +- `--clear` (boolean, optional): Clear the field before typing +- `--delay` (string, optional): Delay between keystrokes in milliseconds + +## steel browser press + +Press a keyboard key + +### Usage + +```bash +steel browser press ``` -## steel star +Aliases: `key` + +### Parameters + +- `key` (string, required): Key to press (e.g. Enter, Escape, Tab, Control+a) -Navigates to Steel Browser Repository +## steel browser hover + +Hover over an element ### Usage +```bash +steel browser hover ``` -steel star + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser focus + +Focus an element + +### Usage + +```bash +steel browser focus ``` -## steel support +### Parameters -Navigates to Steel Discord Server +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser check + +Check a checkbox or radio button ### Usage +```bash +steel browser check ``` -steel support + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser uncheck + +Uncheck a checkbox + +### Usage + +```bash +steel browser uncheck ``` -## steel update +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser select -Update Steel CLI to the latest version +Select option(s) from a dropdown ### Usage +```bash +steel browser select ``` -steel update [options] + +### Parameters + +- `selector` (string, required): Select element selector or ref +- `values` (string[], optional): Option value(s) to select + +## steel browser clear + +Clear an input field + +### Usage + +```bash +steel browser clear ``` -### Options +### Parameters -- -f, **--force**: Force update even if already on latest version -- -c, **--check**: Only check for updates without installing +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel browser captcha solve +## steel browser selectall -Manually trigger CAPTCHA solving for a Steel browser session +Select all text in an input ### Usage +```bash +steel browser selectall ``` -steel browser captcha solve [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser scroll + +Scroll the page or an element + +### Usage + +```bash +steel browser scroll ``` -### Options +### Parameters -- **--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 +- `direction` (string, optional): Direction: up, down, left, right +- `amount` (string, optional): Scroll amount in pixels (default: 300) +- `-s, --selector` (string, optional): Element selector to scroll -## steel browser captcha status +## steel browser scrollintoview -Get CAPTCHA solving status for a Steel browser session +Scroll an element into view ### Usage +```bash +steel browser scrollintoview ``` -steel browser captcha status [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser setvalue + +Set the value of an input element (without triggering events) + +### Usage + +```bash +steel browser setvalue ``` -### Options +### Parameters -- **--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) +- `selector` (string, required): Element selector or ref +- `value` (string[], optional): Value to set -## steel browser live +## steel browser snapshot -Print active or named session live-view URL +Take an accessibility tree snapshot ### Usage +```bash +steel browser snapshot ``` -steel browser live [options] + +### Parameters + +- `-i, --interactive` (boolean, optional): Show only interactive elements +- `-s, --selector` (string, optional): Restrict snapshot to a subtree +- `-c, --compact` (boolean, optional): Use compact output format +- `-d, --max-depth` (string, optional): Maximum nesting depth +- `-u, --urls` (boolean, optional): Include URLs in the snapshot + +## steel browser screenshot + +Take a screenshot + +### Usage + +```bash +steel browser screenshot ``` -### Options +### Parameters -- -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 +- `-f, --full-page` (boolean, optional): Capture the full scrollable page +- `-o, --output` (string, optional): Output file path +- `--selector` (string, optional): Restrict screenshot to an element +- `--format` (string, optional): Image format: png, jpeg, webp +- `--quality` (string, optional): JPEG/WebP quality (0-100) +- `--annotate` (boolean, optional): Annotate interactive elements on the screenshot -## steel browser sessions +## steel browser eval -List browser sessions as JSON +Evaluate JavaScript in the page ### Usage +```bash +steel browser eval ``` -steel browser sessions [options] + +### Parameters + +- `script` (string, required): JavaScript expression to evaluate + +## steel browser find + +Find all elements matching a selector + +### Usage + +```bash +steel browser find ``` -### Options +### Parameters -- -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 +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel browser start +## steel browser content -Create or attach a Steel browser session (cloud by default) +Get the page HTML content ### Usage +```bash +steel browser content ``` -steel browser start [options] + +## steel browser get + +Get information about elements or page + +### Usage + +```bash +steel browser get ``` -### Options +### Subcommands -- -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 +- `text`: Get element text content +- `html`: Get element inner HTML +- `value`: Get input/textarea value +- `attr`: Get element attribute value +- `url`: Get current page URL +- `title`: Get current page title +- `count`: Count matching elements +- `box`: Get element bounding box +- `styles`: Get element CSS styles -## steel browser stop +## steel browser get text -Stop the active or named Steel browser session +Get element text content ### Usage -``` -steel browser stop [options] +```bash +steel browser get text ``` -### Options +### Parameters -- -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 +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel credentials create +## steel browser get html -Store a new credential for a given origin +Get element inner HTML ### Usage +```bash +steel browser get html ``` -steel credentials create [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser get value + +Get input/textarea value + +### Usage + +```bash +steel browser get value ``` -### Options +### Parameters -- **--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) +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel credentials delete +## steel browser get attr -Delete a stored credential +Get element attribute value ### Usage +```bash +steel browser get attr ``` -steel credentials delete [options] + +### Parameters + +- `selector` (string, required): Element selector or ref +- `attribute` (string, required): Attribute name + +## steel browser get url + +Get current page URL + +### Usage + +```bash +steel browser get url ``` -### Options +## steel browser get title -- **--origin**: Origin URL of the credential to delete -- -n, **--namespace**: Credential namespace +Get current page title -## steel credentials list +### Usage -List stored credentials +```bash +steel browser get title +``` + +## steel browser get count + +Count matching elements ### Usage +```bash +steel browser get count ``` -steel credentials list [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser get box + +Get element bounding box + +### Usage + +```bash +steel browser get box ``` -### Options +### Parameters -- -n, **--namespace**: Filter credentials by namespace -- **--origin**: Filter credentials by origin URL +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel credentials update +## steel browser get styles -Update an existing credential +Get element CSS styles ### Usage +```bash +steel browser get styles ``` -steel credentials update [options] + +### Parameters + +- `selector` (string, required): Element selector or ref +- `--property` (string[], optional): CSS property names to query (returns all computed styles if omitted) + +## steel browser is + +Check element state + +### Usage + +```bash +steel browser is ``` -### Options +### Subcommands -- **--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 +- `visible`: Check if element is visible +- `enabled`: Check if element is enabled +- `checked`: Check if element is checked -## steel dev install +## steel browser is visible -Install local Steel Browser runtime assets without starting containers +Check if element is visible ### Usage +```bash +steel browser is visible ``` -steel dev install [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser is enabled + +Check if element is enabled + +### Usage + +```bash +steel browser is enabled ``` -### Options +### Parameters -- **--repo-url**: Git repository URL for local Steel Browser runtime -- -V, **--verbose**: Enable verbose git command output +- `selector` (string, required): Element selector or ref (e.g. @e1) -## steel dev start +## steel browser is checked -Start local Steel Browser runtime containers (requires `steel dev install`) +Check if element is checked ### Usage +```bash +steel browser is checked ``` -steel dev start [options] + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser wait + +Wait for a condition (text, selector, URL, function, or timeout) + +### Usage + +```bash +steel browser wait ``` -### Options +### Parameters -- -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 +- `--timeout` (string, optional): Timeout in milliseconds +- `-t, --text` (string, optional): Wait for text to appear on page +- `--selector` (string, optional): Wait for a CSS selector +- `--state` (string, optional): Selector state: visible, hidden, attached, detached +- `-u, --url` (string, optional): Wait for URL to contain this string +- `-f, --function` (string, optional): Wait for a JS function to return truthy +- `-l, --load-state` (string, optional): Wait for load state: load, domcontentloaded, networkidle -## steel dev stop +## steel browser tab -Stop local Steel Browser runtime containers +Manage tabs ### Usage +```bash +steel browser tab ``` -steel dev stop [options] + +### Subcommands + +- `list`: List open tabs +- `new`: Open a new tab +- `switch`: Switch to a tab by index +- `close`: Close a tab (active tab if no index given) + +## steel browser tab list + +List open tabs + +### Usage + +```bash +steel browser tab list ``` -### Options +## steel browser tab new + +Open a new tab + +### Usage -- -V, **--verbose**: Enable verbose Docker command output +```bash +steel browser tab new +``` + +### Parameters + +- `url` (string, optional): URL to open (defaults to about:blank) + +## steel browser tab switch + +Switch to a tab by index + +### Usage + +```bash +steel browser tab switch +``` + +### Parameters + +- `index` (string, required): Tab index to switch to + +## steel browser tab close + +Close a tab (active tab if no index given) + +### Usage + +```bash +steel browser tab close +``` + +### Parameters + +- `index` (string, optional): Tab index to close (closes active tab if omitted) + +## steel browser cookies + +Manage browser cookies + +### Usage + +```bash +steel browser cookies +``` + +### Subcommands + +- `set`: Set a cookie +- `clear`: Clear all cookies + +## steel browser cookies set + +Set a cookie + +### Usage + +```bash +steel browser cookies set +``` + +### Parameters + +- `name` (string, required): Cookie name +- `value` (string, required): Cookie value +- `--domain` (string, optional): Cookie domain +- `--path` (string, optional): Cookie path +- `--secure` (boolean, optional): Secure flag +- `--http-only` (boolean, optional): HttpOnly flag + +## steel browser cookies clear + +Clear all cookies + +### Usage + +```bash +steel browser cookies clear +``` + +## steel browser storage + +Manage browser storage (localStorage/sessionStorage) + +### Usage + +```bash +steel browser storage +``` + +### Subcommands + +- `local`: Manage localStorage +- `session`: Manage sessionStorage + +## steel browser storage local + +Manage localStorage + +### Usage + +```bash +steel browser storage local +``` + +### Subcommands + +- `set`: Set a storage value +- `clear`: Clear all values + +## steel browser storage local set + +Set a storage value + +### Usage + +```bash +steel browser storage local set +``` + +### Parameters + +- `key` (string, required): Key to set +- `value` (string, required): Value to set + +## steel browser storage local clear + +Clear all values + +### Usage + +```bash +steel browser storage local clear +``` + +## steel browser storage session + +Manage sessionStorage + +### Usage + +```bash +steel browser storage session +``` + +### Subcommands + +- `set`: Set a storage value +- `clear`: Clear all values + +## steel browser storage session set + +Set a storage value + +### Usage + +```bash +steel browser storage session set +``` + +### Parameters + +- `key` (string, required): Key to set +- `value` (string, required): Value to set + +## steel browser storage session clear + +Clear all values + +### Usage + +```bash +steel browser storage session clear +``` + +## steel browser drag + +Drag and drop from one element to another + +### Usage + +```bash +steel browser drag +``` + +### Parameters + +- `source` (string, required): Source element selector or ref +- `target` (string, required): Target element selector or ref + +## steel browser upload + +Upload files to a file input element + +### Usage + +```bash +steel browser upload +``` + +### Parameters + +- `selector` (string, required): File input element selector or ref +- `files` (string[], optional): File paths to upload + +## steel browser highlight + +Visually highlight an element + +### Usage + +```bash +steel browser highlight +``` + +### Parameters + +- `selector` (string, required): Element selector or ref (e.g. @e1) + +## steel browser set + +Configure browser settings (viewport, geolocation, etc.) + +### Usage + +```bash +steel browser set +``` + +### Subcommands + +- `viewport`: Set viewport size +- `geo`: Set geolocation +- `offline`: Toggle offline mode +- `headers`: Set extra HTTP headers (JSON string) +- `useragent`: Set browser user agent string + +## steel browser set viewport + +Set viewport size + +### Usage + +```bash +steel browser set viewport +``` + +### Parameters + +- `width` (string, required): Viewport width in pixels +- `height` (string, required): Viewport height in pixels +- `--scale` (string, optional): Device scale factor +- `--mobile` (boolean, optional): Emulate mobile device + +## steel browser set geo + +Set geolocation + +### Usage + +```bash +steel browser set geo +``` + +Aliases: `geolocation` + +### Parameters + +- `latitude` (string, required): Latitude +- `longitude` (string, required): Longitude +- `--accuracy` (string, optional): Accuracy in meters + +## steel browser set offline + +Toggle offline mode + +### Usage + +```bash +steel browser set offline +``` + +### Parameters + +- `state` (string, required): "on" to enable offline mode, "off" to disable + +## steel browser set headers + +Set extra HTTP headers (JSON string) + +### Usage + +```bash +steel browser set headers +``` + +### Parameters + +- `json` (string, required): JSON string of headers (e.g. '{"X-Key":"value"}') + +## steel browser set useragent + +Set browser user agent string + +### Usage + +```bash +steel browser set useragent +``` + +Aliases: `ua` + +### Parameters + +- `user_agent` (string[], optional): User agent string + +## steel browser bringtofront + +Bring the browser window to the foreground + +### Usage + +```bash +steel browser bringtofront +``` + +## steel browser diff + +Compare snapshots or screenshots + +### Usage + +```bash +steel browser diff +``` + +### Subcommands + +- `snapshot`: Compare current snapshot against a baseline +- `screenshot`: Compare current screenshot against a baseline image + +## steel browser diff snapshot + +Compare current snapshot against a baseline + +### Usage + +```bash +steel browser diff snapshot +``` + +### Parameters + +- `-b, --baseline` (string, optional): Baseline snapshot text or file path +- `-s, --selector` (string, optional): Restrict snapshot to a subtree +- `-c, --compact` (boolean, optional): Use compact output format +- `-d, --max-depth` (string, optional): Maximum nesting depth + +## steel browser diff screenshot + +Compare current screenshot against a baseline image + +### Usage + +```bash +steel browser diff screenshot +``` + +### Parameters + +- `-b, --baseline` (string, required): Baseline image file path (required) +- `-t, --threshold` (string, optional): Color difference threshold (0.0–1.0) +- `-o, --output` (string, optional): Save diff image to this path +- `-s, --selector` (string, optional): Restrict screenshot to an element +- `--full-page` (boolean, optional): Capture the full scrollable page + +## steel browser close + +Close the browser session + +### Usage + +```bash +steel browser close +``` + +Aliases: `quit`, `exit` + +## steel sessions + +Cloud session management and debugging + +### Usage + +```bash +steel sessions +``` + +### Subcommands + +- `list`: List cloud sessions +- `get`: Get one cloud session +- `release`: Release a cloud session +- `logs`: Read browser event logs for a session +- `agent-logs`: Read raw CDP-derived agent events for a session +- `traces`: Read semantic agent trace timeline for a session + +## steel sessions list + +List cloud sessions + +### Usage + +```bash +steel sessions list +``` + +### Parameters + +- `--limit` (string, optional): Number of sessions to return +- `--cursor-id` (string, optional): Cursor ID for pagination +- `--status` (string, optional): Filter by status: live, released, or failed + +### API Operations + +- `get_sessions` (implemented): `GET /v1/sessions` + Example: `steel sessions list --status live --limit 20` + +## steel sessions get + +Get one cloud session + +### Usage + +```bash +steel sessions get +``` + +### Parameters + +- `session_id` (string, optional): Cloud session ID +- `--session` (string, optional): Resolve session ID from a local daemon session name + +### API Operations + +- `get_session` (implemented): `GET /v1/sessions/{id}` + Example: `steel sessions get ` + +## steel sessions release + +Release a cloud session + +### Usage + +```bash +steel sessions release +``` + +### Parameters + +- `session_id` (string, optional): Cloud session ID +- `-a, --all` (boolean, optional): Release all active cloud sessions +- `--session` (string, optional): Resolve session ID from a local daemon session name + +### API Operations + +- `release_session` (implemented): `POST /v1/sessions/{id}/release` + Example: `steel sessions release ` +- `release_all_sessions` (implemented): `POST /v1/sessions/release` + Example: `steel sessions release --all` + +## steel sessions logs + +Read browser event logs for a session + +### Usage + +```bash +steel sessions logs +``` + +### Parameters + +- `session_id` (string, optional): Cloud session ID +- `--session` (string, optional): Resolve session ID from a local daemon session name +- `-f, --follow` (boolean, optional): Stream live frames over WebSocket after printing historical data +- `--namespace` (string, optional): Filter by namespace +- `--start-time` (string, optional): ISO timestamp lower bound +- `--since` (string, optional): Alias for --start-time +- `--end-time` (string, optional): ISO timestamp upper bound +- `--event-type` (string[], optional): Event type filter, repeatable or comma-separated +- `--limit` (string, optional): Number of events to return +- `--offset` (string, optional): Pagination offset + +### API Operations + +- `get_session_logs` (implemented): `GET /v1/sessions/{id}/logs` + Example: `steel sessions logs --follow` + Streaming: websocket `/v1/sessions/{id}/logs` + +## steel sessions agent-logs + +Read raw CDP-derived agent events for a session + +### Usage + +```bash +steel sessions agent-logs +``` + +### Parameters + +- `session_id` (string, optional): Cloud session ID +- `--session` (string, optional): Resolve session ID from a local daemon session name +- `-f, --follow` (boolean, optional): Stream live frames over WebSocket after printing historical data +- `--namespace` (string, optional): Filter by namespace +- `--start-time` (string, optional): ISO timestamp lower bound +- `--since` (string, optional): Alias for --start-time +- `--end-time` (string, optional): ISO timestamp upper bound +- `--event-type` (string[], optional): Event type filter, repeatable or comma-separated +- `--limit` (string, optional): Number of events to return +- `--offset` (string, optional): Pagination offset + +### API Operations + +- `get_session_agent_logs` (implemented): `GET /v1/sessions/{id}/agent-logs` + Example: `steel sessions agent-logs --limit 100` + +## steel sessions traces + +Read semantic agent trace timeline for a session + +### Usage + +```bash +steel sessions traces +``` + +### Parameters + +- `session_id` (string, optional): Cloud session ID +- `--session` (string, optional): Resolve session ID from a local daemon session name +- `-f, --follow` (boolean, optional): Stream live trace frames over WebSocket after printing historical data +- `--namespace` (string, optional): Filter by namespace +- `--start-time` (string, optional): ISO timestamp lower bound +- `--since` (string, optional): Alias for --start-time +- `--end-time` (string, optional): ISO timestamp upper bound +- `--event-type` (string[], optional): Event type filter, repeatable or comma-separated + +### API Operations + +- `get_session_agent_traces` (implemented): `GET /v1/sessions/{id}/agent-traces` + Example: `steel sessions traces --follow` + Streaming: websocket `/v1/sessions/{id}/agent-traces` + +## steel computer + +Cloud computers: create, run commands, ssh + +### Usage + +```bash +steel computer +``` + +### Subcommands + +- `create`: Create a computer +- `list`: List computers +- `get`: Get one computer +- `delete`: Delete a computer +- `pause`: Pause a running computer +- `resume`: Resume a paused computer +- `use`: Remember a computer as the default for other commands +- `exec`: Run one command in a computer +- `ssh`: Open an SSH session to a computer + +## steel computer create + +Create a computer + +### Usage + +```bash +steel computer create +``` + +### Parameters + +- `--template` (string, required): Template name +- `--region` (string, optional): Region, for example us-east +- `--vcpu` (string, optional): Number of vCPUs +- `--memory` (string, optional): Memory in MiB +- `--disk` (string, optional): Disk in MiB +- `--timeout` (string, optional): Stop the computer after this many seconds of running time +- `--auto-pause` (boolean, optional): Pause instead of stopping when the timeout is reached +- `--wait` (boolean, optional): Wait until the computer is running +- `--use` (boolean, optional): Make the new computer the default for other commands + +## steel computer list + +List computers + +### Usage + +```bash +steel computer list +``` + +## steel computer get + +Get one computer + +### Usage + +```bash +steel computer get +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) + +## steel computer delete + +Delete a computer + +### Usage + +```bash +steel computer delete +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) + +## steel computer pause + +Pause a running computer + +### Usage + +```bash +steel computer pause +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) + +## steel computer resume + +Resume a paused computer + +### Usage + +```bash +steel computer resume +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) +- `--wait` (boolean, optional): Wait until the computer is running + +## steel computer use + +Remember a computer as the default for other commands + +### Usage + +```bash +steel computer use +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID to remember +- `--clear` (boolean, optional): Forget the remembered computer + +## steel computer exec + +Run one command in a computer + +### Usage + +```bash +steel computer exec +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) +- `-c, --command` (string, optional): Shell command string, run by /bin/sh -c +- `--cwd` (string, optional): Working directory inside the computer +- `--env` (string[], optional): Environment variable for the command, repeatable +- `--timeout` (string, optional): Kill the command after this many seconds (at most 3600) +- `argv` (string[], optional): Program and arguments, given after `--` + +### API Operations + +- `exec_computer` (implemented): `POST /v1/computers/{id}/exec` + Example: `steel computer exec -- ` + +## steel computer ssh + +Open an SSH session to a computer + +### Usage + +```bash +steel computer ssh +``` + +### Parameters + +- `computer_id` (string, optional): Computer ID (defaults to STEEL_COMPUTER_ID or `steel computer use`) +- `command` (string[], optional): Run this command instead of opening a shell, given after `--` + +### API Operations + +- `attach_computer_ssh` (implemented): `GET /v1/computers/{id}/ssh` + Example: `steel computer ssh ` + Streaming: websocket `/v1/computers/{id}/ssh` + +## steel init + +One-command onboarding: login + verify + install agent skills + +### Usage + +```bash +steel init +``` + +### Parameters + +- `--agent` (boolean, optional): Run in agent mode: auto-accept interactive prompts and print agent-friendly output. Designed for AI coding agents +- `--skills` (string[], optional): Open the Steel skills installer flow. With no value, lets you choose skills interactively +- `--no-skills` (boolean, optional): Skip Steel skill installation + +## steel login + +Login to Steel CLI + +### Usage + +```bash +steel login +``` + +Aliases: `auth` + +## steel logout + +Logout from Steel CLI + +### Usage + +```bash +steel logout +``` + +## steel credentials + +Manage stored credentials + +### Usage + +```bash +steel credentials +``` + +### Subcommands + +- `list`: List stored credentials +- `create`: Create a new credential +- `update`: Update an existing credential +- `delete`: Delete a credential + +## steel credentials list + +List stored credentials + +### Usage + +```bash +steel credentials list +``` + +### Parameters + +- `-n, --namespace` (string, optional): Filter by namespace +- `--origin` (string, optional): Filter by origin URL + +## steel credentials create + +Create a new credential + +### Usage + +```bash +steel credentials create +``` + +### Parameters + +- `--origin` (string, optional): Origin URL to associate the credential with +- `-u, --username` (string, optional): Username +- `-p, --password` (string, optional): Password +- `--totp-secret` (string, optional): TOTP secret for two-factor authentication +- `-n, --namespace` (string, optional): Credential namespace +- `--label` (string, optional): Human-readable label + +## steel credentials update + +Update an existing credential + +### Usage + +```bash +steel credentials update +``` + +### Parameters + +- `--origin` (string, optional): Origin URL of the credential to update +- `-u, --username` (string, optional): New username +- `-p, --password` (string, optional): New password +- `--totp-secret` (string, optional): New TOTP secret +- `-n, --namespace` (string, optional): Credential namespace +- `--label` (string, optional): New human-readable label + +## steel credentials delete + +Delete a credential + +### Usage + +```bash +steel credentials delete +``` + +### Parameters + +- `--origin` (string, optional): Origin URL of the credential to delete +- `-n, --namespace` (string, optional): Credential namespace + +## steel dev + +Local development runtime + +### Usage + +```bash +steel dev +``` + +### Subcommands + +- `install`: Install the local Steel Browser runtime +- `start`: Start the local runtime containers +- `stop`: Stop the local runtime containers + +## steel dev install + +Install the local Steel Browser runtime + +### Usage + +```bash +steel dev install +``` + +### Parameters + +- `--repo-url` (string, optional): Git repository URL for local Steel Browser runtime +- `-V, --verbose` (boolean, optional): Enable verbose git command output + +## steel dev start + +Start the local runtime containers + +### Usage + +```bash +steel dev start +``` + +### Parameters + +- `-p, --port` (string, optional): API port for local Steel Browser runtime +- `-V, --verbose` (boolean, optional): Enable verbose Docker command output +- `-d, --docker-check` (boolean, optional): Only verify Docker availability and exit + +## steel dev stop + +Stop the local runtime containers + +### Usage + +```bash +steel dev stop +``` + +### Parameters + +- `-V, --verbose` (boolean, optional): Enable verbose Docker command output + +## steel forge + +Scaffold a new project from a template + +### Usage + +```bash +steel forge +``` + +### Parameters + +- `template` (string, optional): Template to start from +- `-n, --name` (string, optional): Project name +- `--list` (boolean, optional): List available templates and exit (respects --json) + +## steel config + +Show current configuration + +### Usage + +```bash +steel config +``` + +## steel update + +Update to the latest version + +### Usage + +```bash +steel update +``` + +### Parameters + +- `-f, --force` (boolean, optional): Force update even if already on latest version +- `-c, --check` (boolean, optional): Only check for updates without installing + +## steel cache + +Manage Steel CLI cache + +### Usage + +```bash +steel cache +``` + +### Parameters + +- `-c, --clean` (boolean, optional): Remove all cached files and directories + +## steel profile + +Manage named Steel browser profiles + +### Usage + +```bash +steel profile +``` + +### Subcommands + +- `list`: List all saved Steel browser profiles +- `import`: Import a local browser profile into Steel +- `sync`: Sync a local browser profile to an existing Steel profile +- `delete`: Delete a saved Steel browser profile + +## steel profile list + +List all saved Steel browser profiles + +### Usage + +```bash +steel profile list +``` + +## steel profile import + +Import a local browser profile into Steel + +### Usage + +```bash +steel profile import +``` + +### Parameters + +- `name` (string, optional): Steel profile name to save as +- `--from` (string, optional): Browser profile directory to import from (e.g. "Default", "Profile 1") +- `--browser` (string, optional): Browser to import from (chrome, edge, brave, arc, opera, vivaldi) +- `--full` (boolean, optional): Include all profile data (IndexedDB, History, Bookmarks, etc.) + +## steel profile sync + +Sync a local browser profile to an existing Steel profile + +### Usage + +```bash +steel profile sync +``` + +### Parameters + +- `name` (string, optional): Steel profile name to sync +- `--from` (string, optional): Browser profile directory to sync from (overrides stored source) +- `--browser` (string, optional): Browser to sync from (overrides stored browser) +- `--full` (boolean, optional): Include all profile data (IndexedDB, History, Bookmarks, etc.) + +## steel profile delete + +Delete a saved Steel browser profile + +### Usage + +```bash +steel profile delete +``` + +### Parameters + +- `name` (string, optional): Name of the profile to delete + +## steel describe + +Describe commands and parameters + +### Usage + +```bash +steel describe +``` + +### Parameters + +- `path` (string[], optional): Command path to describe (e.g. "browser click") +- `--all` (boolean, optional): Dump the entire command tree (recursive) + +## steel doctor + +Check environment, auth, and connectivity + +### Usage + +```bash +steel doctor +``` + +### Parameters + +- `--preflight` (boolean, optional): Only check auth and API connectivity + +## steel skills + +Manage Steel agent skills + +### Usage + +```bash +steel skills +``` + +### Subcommands + +- `list`: List available Steel skills +- `install`: Install all or selected Steel skills through npx skills +- `update`: Update one or more installed Steel skills through npx skills +- `doctor`: Check Steel skills installation health +- `open`: Open an installed skill or docs page +- `paths`: Show detected agent install paths for Steel skills + +## steel skills list + +List available Steel skills + +### Usage + +```bash +steel skills list +``` + +### Parameters + +- `--offline` (boolean, optional): Use cached or bundled manifest instead of fetching GitHub + +## steel skills install + +Install all or selected Steel skills through npx skills + +### Usage + +```bash +steel skills install +``` + +### Parameters + +- `names` (string[], optional): Skill name(s) to install +- `--all` (boolean, optional): Install all Steel skills from the catalog +- `-a, --agent` (string, optional): Target agent passed to npx skills (-a) +- `-g, --global` (boolean, optional): Install globally through npx skills (-g) +- `-y, --yes` (boolean, optional): Non-interactive yes passed to npx skills (-y) + +## steel skills update + +Update one or more installed Steel skills through npx skills + +### Usage + +```bash +steel skills update +``` + +### Parameters + +- `names` (string[], optional): Skill name(s) to update; all known Steel skills when omitted +- `-y, --yes` (boolean, optional): Non-interactive yes passed to npx skills (-y) + +## steel skills doctor + +Check Steel skills installation health + +### Usage + +```bash +steel skills doctor +``` + +### Parameters + +- `--offline` (boolean, optional): Use cached or bundled manifest instead of fetching GitHub + +## steel skills open + +Open an installed skill or docs page + +### Usage + +```bash +steel skills open +``` + +### Parameters + +- `name` (string, required): Skill name + +## steel skills paths + +Show detected agent install paths for Steel skills + +### Usage + +```bash +steel skills paths +``` + +## steel completion + +Generate a shell completion script + +### Usage + +```bash +steel completion +``` ---- +### Parameters -_This documentation was auto-generated from the Steel CLI source code._ +- `shell` (enum, required): Shell to generate completions for