Skip to content

CLI commands

Set up your agent

Give your coding agent a Steel browser and the Steel skills, so that it browses and writes Steel code the right way. Learn more

Install the Steel CLI. It signs you in and installs the skills for your coding agents.

curl -fsS https://setup.steel.dev | sh

Or send this prompt to your coding agent, and it does the same:

Read https://setup.steel.dev/install.md and follow it to set up Steel for this coding client.
Then continue my requested task using the installed Steel skill.

Set up your agent →

Each command of the Steel CLI 0.5.0, such as steel scrape or steel sessions list, takes its own arguments and flags. The page starts with steel init, steel login and steel logout, which set up the CLI. The other commands follow the order of steel describe --all. CLI shows the common tasks. For the version that you have installed, run steel describe with a command path, such as steel describe browser click, or add --help to any command.

Global options

Every command accepts these options.

OptionTypeDescription
--jsonbooleanPrint all results as JSON, for automation.
--localbooleanUse the local Steel runtime instead of Steel Cloud.
--api-urlstringThe Steel API URL. It overrides --local and STEEL_API_URL.
-h, --helpPrint help for a command.
-V, --versionPrint the version of the Steel CLI. Only steel itself takes it, as steel --version.

Every steel browser command also accepts these options:

OptionTypeDescription
--sessionstringThe named session to use, or a session ID. default when you leave it out. --session-id is an alias.
--diffbooleanPrint what the command changed on the page, as a diff against the last snapshot.

Environment variables

VariableDescription
STEEL_API_KEYThe API key. It overrides the sign-in that steel login saved.
STEEL_API_URLThe Steel API URL, for Steel Cloud or a self-hosted instance.
STEEL_WS_URLThe WebSocket URL for steel sessions logs --follow and steel sessions traces --follow.
STEEL_CONFIG_DIRThe configuration directory. ~/.config/steel by default.
STEEL_TELEMETRY_HOSTOverrides the host that receives telemetry.
STEEL_TELEMETRY_DISABLEDSet it to 1 or true to turn telemetry off.
NO_COLORTurns colored output off.

Output

Commands print text by default, even when you pipe them. --json prints the result as {"success": true, "data": ...}. steel browser commands print the result on standard output, and notes about dialogs, new tabs, downloads and retried requests on standard error.

steel browser start prints the session id, mode, name, live_url, connect_url, expires_in and inactivity_timeout. With --json, data has the keys id, mode, name, liveUrl, connectUrl, remainingMs and inactivityTimeoutMs. The token and API key in the connection URL are replaced with [redacted], so the output is safe to log. To connect a CDP client, retrieve the session with an SDK or the API, and connect to its websocketUrl. See CDP.

Exit codes

A command that fails prints the error, such as stale_ref, and exits with one of these codes. With --json, it prints {"success": false, "error": ..., "error_code": ...}.

CodeMeaning
0The command succeeded.
1The command failed for a reason that the other codes do not cover. A steel browser command also exits with 1 for every Commands API error except 401 and 403.
3No sign-in or API key, or the API returned 401.
4The CLI could not reach the API.
5The API returned another 4xx status, such as 403, 404 or 429.
6The API returned a 5xx status.

steel init

Set up the CLI in one command: sign in, check the API connection, and install the agent skills.

Argument or flagTypeRequiredDescription
--agentbooleanNoRun in agent mode, for AI coding agents: auto-accept interactive prompts and print agent-friendly output.
--fromstringNoThe coding client to set up Steel for (opencode, claude-code, codex, pi). Works only with --agent.
--skillsstring[]NoSkills to install. With no value, lets you choose them interactively.
--no-skillsbooleanNoSkip Steel skill installation.
steel init
steel init --skills steel-browser,steel-developer
steel init --agent --from claude-code

steel login

Sign in to Steel.

Argument or flagTypeRequiredDescription
--resumebooleanNoContinue the saved authorization request; do not issue a new code.
--no-waitbooleanNoPrint the URL and code without waiting for approval. If a request is pending, check it once when a check is due.
--no-browserbooleanNoDo not open a browser on this host.
steel login
steel login --no-browser
steel login --resume

Aliases: auth.

steel logout

End the sign-in and remove it from this computer.

Argument or flagTypeRequiredDescription
--local-onlybooleanNoRemove the sign-in from this computer without revoking it on the server, for when you are offline.
steel logout
steel logout --local-only

steel scrape

Scrape webpage content.

Argument or flagTypeRequiredDescription
urlstringYesTarget URL to scrape.
--formatstringNoComma-separated output formats: html, readability, cleaned_html, markdown. markdown by default.
-d, --delaystringNoDelay before scraping in milliseconds.
--pdfbooleanNoInclude a generated PDF in the response.
--screenshotbooleanNoInclude a generated screenshot in the response.
--use-proxybooleanNoUse a Steel-managed residential proxy.
steel scrape https://example.com
steel scrape https://example.com --format html,markdown --json
steel scrape https://example.com --delay 2000 --screenshot

steel screenshot

Capture a screenshot of a webpage.

Argument or flagTypeRequiredDescription
urlstringYesTarget URL to capture.
-d, --delaystringNoDelay before capturing in milliseconds.
-f, --full-pagebooleanNoCapture a full-page screenshot.
--use-proxybooleanNoUse a Steel-managed residential proxy.
steel screenshot https://example.com
steel screenshot https://example.com --full-page --delay 1000

steel pdf

Generate a PDF from a webpage.

Argument or flagTypeRequiredDescription
urlstringYesTarget URL to generate PDF from.
-d, --delaystringNoDelay before generating in milliseconds.
--use-proxybooleanNoUse a Steel-managed residential proxy.
steel pdf https://example.com
steel pdf https://example.com --delay 1000

steel browser

Start, drive and stop browser sessions. Names in the CLI and the MCP server maps each subcommand to the command that it sends.

SubcommandDescription
startCreate a browser session
stopStop a browser session
sessionsList the live sessions that this CLI started or attached to
livePrint the session viewer URL
captchaSolve CAPTCHAs and check their status
batchRun several browser commands in one request
navigateNavigate to a URL
backNavigate back in history
forwardNavigate forward in history
reloadReload the current page
clickClick an element
dblclickDouble-click an element
fillFill an input field (replaces the current value).
typeType text into an element key by key (appends to the current value).
pressPress a key or chord (Enter, Escape, Tab, Control+a).
keydownHold a key down until keyup
keyupRelease a key held with keydown
hoverHover over an element
focusFocus an element
checkCheck a checkbox, radio button, or switch
uncheckUncheck a checkbox or switch
selectSelect one or more options in a select element
clearClear an input field
selectallSelect all text in an input
scrollScroll the page or an element
dragDrag an element onto another
uploadUpload files to a file input
mouseSend mouse input to a point, for canvases and maps
snapshotTake an accessibility tree snapshot with element refs
screenshotTake a screenshot
pdfSave the page as a PDF
evalRun JavaScript in the page and print its value
findFind elements and print their refs
contentGet the page HTML
getGet information about elements or the page
isCheck element state
waitWait for an element, text, URL, load state, download, or a fixed time
tabList, open, switch, or close tabs
statusWait for a command that is still running
cancelStop a command that is still running

steel browser start

Create a browser session.

Argument or flagTypeRequiredDescription
--stealthbooleanNoTurns on humanizeInteractions and CAPTCHA solving (solveCaptcha). On Launch, CAPTCHA solving needs a verified account.
-p, --proxystringNoYour own proxy server, as http://username:password@hostname:port. Sent as proxyUrl.
--timeoutstringNoSession timeout in milliseconds. 900000 (15 minutes) by default, which every plan allows.
--inactivity-timeoutstringNoInactivity timeout in milliseconds. Steel releases the session when no command, CDP message or input from the live view arrives for this long. 600000 (10 minutes) by default. Pass 0 to turn it off. It has no effect when it is equal to or longer than --timeout.
--solve-captchabooleanNoTurns on CAPTCHA solving (solveCaptcha). Steel solves each CAPTCHA that it detects. On Launch, CAPTCHA solving needs a verified account.
--profilestringNoNamed profile to load (see steel profile list).
--update-profilebooleanNoSave session state back to the profile when the session ends; creates the profile if it does not exist. Needs --profile. Do not use it with --credentials, as Use credentials with a profile explains.
--namespacestringNoCredential namespace.
--credentialsbooleanNoFill stored credentials into sign-in forms.
--metadatastring[]NoAttach metadata as KEY=VALUE, repeatable (Steel Cloud only).
steel browser start --timeout 900000
steel browser start --session checkout --metadata env=staging
steel browser start --session app --profile my-app --update-profile

steel browser stop

Stop a browser session.

Aliases: close, quit, exit.

Argument or flagTypeRequiredDescription
-a, --allbooleanNoStop every session this CLI started. Sessions you only attached to by ID are forgotten, not stopped.
steel browser stop
steel browser stop --session checkout
steel browser stop --all

steel browser sessions

List the live sessions that this CLI started or attached to.

steel browser live

Print the session viewer URL, where you watch the session live. The command does not open a browser.

steel browser captcha

Solve CAPTCHAs and check their status.

SubcommandDescription
solveSolve the CAPTCHAs that Steel detected in the session
statusCheck CAPTCHA status, and list the IDs of each page and task

steel browser captcha solve

Solve the CAPTCHAs that Steel detected in the session.

Argument or flagTypeRequiredDescription
--page-idstringNoSolve only the CAPTCHAs on the page with this ID.
--urlstringNoSolve only the CAPTCHAs on the page with this URL.
--task-idstringNoSolve only the CAPTCHA with this task ID.
steel browser captcha solve
steel browser captcha solve --url https://example.com/login

steel browser captcha status

Check CAPTCHA status. The CLI prints the overall status, then one line for each page and each task, with its ID. Pass these IDs to captcha solve with --page-id or --task-id. With --json, the IDs are under data.pages.

Argument or flagTypeRequiredDescription
--page-idstringNoCheck only the page with this ID.
-w, --waitbooleanNoWait until the status is solved, failed or none.
--timeoutstringNoTimeout in milliseconds for --wait mode. 60000 by default.
--intervalstringNoPoll interval in milliseconds for --wait mode. 1000 by default.
steel browser captcha status
steel browser captcha status --wait --timeout 120000

steel browser batch

Run several browser commands in one request.

Argument or flagTypeRequiredDescription
commandsstring[]YesCommands to run in order, each as one string (for example "click e3" or "fill e3 'New York'"). They stop at the first failure.
steel browser batch "fill e3 'Ada Lovelace'" "check e5" "click e7"
steel browser batch "open https://example.com" "snapshot -i"

steel browser navigate

Navigate to a URL.

Aliases: open, goto.

Argument or flagTypeRequiredDescription
urlstringYesURL to navigate to.
--wait-untilenumNoWait condition: load, domcontentloaded, networkidle.
steel browser navigate https://example.com
steel browser open https://example.com --wait-until networkidle

steel browser back

Navigate back in history.

steel browser forward

Navigate forward in history.

steel browser reload

Reload the current page.

steel browser click

Click an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
--countstringNoNumber of clicks (2 for double-click).
steel browser click e5
steel browser click "button[type=submit]"
steel browser click e5 --count 2

steel browser dblclick

Double-click an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser dblclick e5

steel browser fill

Fill an input field (replaces the current value).

Argument or flagTypeRequiredDescription
selectorstringYesElement ref or CSS selector.
valuestring[]NoValue to fill.
steel browser fill e3 "ada@example.com"
steel browser fill "input[name=email]" "ada@example.com"

steel browser type

Type text into an element key by key (appends to the current value).

Argument or flagTypeRequiredDescription
selectorstringYesElement ref or CSS selector.
textstring[]NoText to type.
--clearbooleanNoClear the field before typing.
--delaystringNoDelay between keystrokes in milliseconds (at most 1000).
steel browser type e3 "steel browser"
steel browser type e3 "new text" --clear --delay 50

steel browser press

Press a key or chord (Enter, Escape, Tab, Control+a).

Aliases: key.

Argument or flagTypeRequiredDescription
keystringYesKey to press (for example Enter, Escape, Tab, Control+a).
steel browser press Enter
steel browser press Control+a

When a JavaScript dialog is open on the current tab, steel browser press Enter accepts it, and steel browser press Escape dismisses it. The CLI sends the key to the current tab, so when the dialog is on another tab, run steel browser tab switch with that tab's ID first. A person can also answer the dialog in the live view. See Dialogs.

steel browser keydown

Hold a key down until keyup.

Argument or flagTypeRequiredDescription
keystringYesKey name (for example Shift, Control, ArrowDown).
steel browser keydown Shift
steel browser press ArrowDown
steel browser keyup Shift

steel browser keyup

Release a key held with keydown.

Argument or flagTypeRequiredDescription
keystringYesKey name (for example Shift, Control, ArrowDown).
steel browser keyup Shift

steel browser hover

Hover over an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser hover e4

steel browser focus

Focus an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser focus e3

steel browser check

Check a checkbox, radio button, or switch.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser check e5
steel browser check "#terms"

steel browser uncheck

Uncheck a checkbox or switch.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser uncheck e5

steel browser select

Select one or more options in a select element.

Argument or flagTypeRequiredDescription
selectorstringYesRef or CSS selector of the select element.
valuesstring[]NoThe values or labels of the options to select.
steel browser select e4 "South Korea"
steel browser select e6 cheese olives

steel browser clear

Clear an input field.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser clear e3

steel browser selectall

Select all text in an input.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser selectall e3

steel browser scroll

Scroll the page or an element.

Argument or flagTypeRequiredDescription
directionenumNoDirection: up, down, left, right (default: down).
amountstringNoScroll amount in pixels (default: 300).
-s, --selectorstringNoElement to scroll instead of the page.
steel browser scroll down 600
steel browser scroll up
steel browser scroll down 300 --selector "#results"

steel browser drag

Drag an element onto another.

Argument or flagTypeRequiredDescription
sourcestringYesElement to drag (ref or CSS selector).
targetstringYesElement to drop on (ref or CSS selector).
steel browser drag e8 e9

steel browser upload

Upload files to a file input.

Argument or flagTypeRequiredDescription
selectorstringYesFile input ref or CSS selector.
filesstring[]NoLocal files to upload, or names of files already in the session.
steel browser upload e6 ./resume.pdf

steel browser mouse

Send mouse input to a point, for canvases and maps.

Argument or flagTypeRequiredDescription
actionenumYesmove, down, up, click, or wheel.
xstringNoX in CSS pixels of the visible page (needed for move, click, and wheel).
ystringNoY in CSS pixels of the visible page (needed for move, click, and wheel).
--buttonenumNoMouse button: left, right, middle.
--clicksstringNoClick count for click (1 to 3).
--dxstringNoHorizontal wheel delta.
--dystringNoVertical wheel delta.
steel browser mouse click 250 380
steel browser mouse click 250 380 --button right
steel browser mouse wheel 250 380 --dy 500

steel browser snapshot

Take an accessibility tree snapshot with element refs.

Argument or flagTypeRequiredDescription
-i, --interactivebooleanNoShow only the elements that have a ref.
-c, --compactbooleanNoKeep only lines with refs or values, and their ancestors.
-d, --max-depthstringNoMaximum nesting depth.
steel browser snapshot -i
steel browser snapshot -c -d 5

steel browser screenshot

Take a screenshot.

Argument or flagTypeRequiredDescription
-f, --full-pagebooleanNoCapture the full scrollable page.
-o, --outputstringNoOutput file path. screenshot.png by default.
--selectorstringNoCapture one element (ref or CSS selector).
--formatenumNoImage format: png, jpeg, webp (default: from the output extension).
--qualitystringNoJPEG/WebP quality (0-100).
steel browser screenshot
steel browser screenshot -o page.png --full-page
steel browser screenshot --selector e2 -o heading.png

steel browser pdf

Save the page as a PDF. It works in headful and headless sessions.

Argument or flagTypeRequiredDescription
-o, --outputstringNoOutput file path. page.pdf by default.
--landscapebooleanNoUse landscape orientation.
--print-backgroundbooleanNoPrint background graphics.
steel browser pdf
steel browser pdf -o invoice.pdf --landscape --print-background

steel browser eval

Run JavaScript in the page and print its value.

Argument or flagTypeRequiredDescription
scriptstringYesJavaScript to run on the page. The CLI prints the value of its last expression. A return outside a function fails.
--timeoutstringNoTime limit in milliseconds. 10000 by default, and at most 50000.
steel browser eval "document.title"
steel browser eval "[...document.querySelectorAll('a')].map(a => a.href)"

steel browser find

Find elements and print their refs.

Argument or flagTypeRequiredDescription
valuestringYesWhat to look for (a CSS selector unless --by says otherwise).
--byenumNoLocator kind: css, role, text, label, placeholder, alt, title, testid. css by default.
--namestringNoAccessible name, with --by role.
--exactbooleanNoMatch the text exactly instead of as a case-insensitive substring.
steel browser find "a[href]"
steel browser find button --by role --name "Create account"
steel browser find Email --by label

steel browser content

Get the page HTML.

steel browser content > page.html

steel browser get

Get information about elements or the page.

SubcommandDescription
textGet the visible text of an element
htmlGet the inner HTML of an element
markdownGet the main content of an element or the page as Markdown
valueGet an input or textarea value
attrGet an element attribute
urlGet the page URL
titleGet the page title
countCount matching elements
boxGet an element's bounding box

steel browser get text

Get the visible text of an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser get text e2

steel browser get html

Get the inner HTML of an element.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser get html "#status"

steel browser get markdown

Get the main content of an element or the page as Markdown.

Argument or flagTypeRequiredDescription
selectorstringNoElement ref (for example e5) or CSS selector; the whole page if omitted.
steel browser get markdown
steel browser get markdown article

steel browser get value

Get an input or textarea value.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser get value e3

steel browser get attr

Get an element attribute.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref or CSS selector.
attributestringYesAttribute name.
steel browser get attr e1 href

steel browser get url

Get the page URL.

steel browser get title

Get the page title.

steel browser get count

Count matching elements.

Argument or flagTypeRequiredDescription
selectorstringYesCSS selector, not a ref.
steel browser get count "input[type=checkbox]"

steel browser get box

Get an element's bounding box.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser get box e5

steel browser is

Check element state.

SubcommandDescription
visibleCheck if an element is visible
enabledCheck if an element is enabled
checkedCheck if an element is checked

steel browser is visible

Check if an element is visible.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser is visible e5

steel browser is enabled

Check if an element is enabled.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser is enabled e7

steel browser is checked

Check if an element is checked.

Argument or flagTypeRequiredDescription
selectorstringYesElement ref (for example e5) or CSS selector.
steel browser is checked e5

steel browser wait

Wait for an element, text, URL, load state, download, or a fixed time.

Argument or flagTypeRequiredDescription
msstringNoFixed time to wait in milliseconds (at most 30000).
--timeoutstringNoTimeout in milliseconds (at most 50000). 30000 by default.
-t, --textstringNoWait for text to appear on the page.
--selectorstringNoWait for an element (ref or CSS selector).
--stateenumNoElement state: visible, hidden, attached, detached.
-u, --urlstringNoWait until the URL contains this text, or matches a pattern with *. See wait in the Commands reference.
-l, --load-stateenumNoWait for a load state: load, domcontentloaded, networkidle.
--downloadbooleanNoWait for a download to finish and save it.
-o, --outputstringNoWhere to save the download (default: its file name in the current directory).
steel browser wait --text "Saved"
steel browser wait --selector e5 --state hidden
steel browser wait --download -o report.pdf

steel browser tab

List, open, switch, or close tabs.

SubcommandDescription
listList open tabs
newOpen a new tab and switch to it
switchSwitch to a tab
closeClose a tab (the current tab if omitted).

steel browser tab list

List open tabs.

steel browser tab new

Open a new tab and switch to it.

Argument or flagTypeRequiredDescription
urlstringNoURL to open (defaults to about:blank).
steel browser tab new https://example.com

steel browser tab switch

Switch to a tab.

Argument or flagTypeRequiredDescription
tabstringYesTab ID from tab list, such as t2.
steel browser tab switch t2

steel browser tab close

Close a tab (the current tab if omitted).

Argument or flagTypeRequiredDescription
tabstringNoTab ID from tab list, such as t2.
steel browser tab close t2

steel browser status

Wait for a command that is still running.

Argument or flagTypeRequiredDescription
executionstringYesExecution ID such as x-7.
steel browser status x-7

steel browser cancel

Stop a command that is still running. Ctrl-C while a command runs also cancels it. Press Ctrl-C again to stop waiting for the cancel.

Argument or flagTypeRequiredDescription
executionstringYesExecution ID such as x-7.
steel browser cancel x-7

steel sessions

List, inspect and release cloud sessions, and read their logs and traces.

SubcommandDescription
listList cloud sessions
getGet one cloud session
metadataShow or change a session's metadata
releaseRelease a cloud session
logsRead browser event logs for a session
agent-logsRead raw CDP-derived agent events for a session
tracesRead the agent trace timeline for a session

steel sessions list

List cloud sessions.

Argument or flagTypeRequiredDescription
--limitstringNoNumber of sessions to return.
--cursor-idstringNoCursor ID for pagination.
--statusstringNoFilter by status: live, released, or failed.
--metadatastring[]NoFilter by metadata KEY=VALUE, repeatable; all must match.
--signalstring[]NoFilter by signal, repeatable or comma-separated; all must match. Signals arrive after the session ends: captcha_encountered, proxy_connection_failed, session_timeout_exceeded, bot_detection_triggered, context_restored.
--release-reasonstringNoFilter by release reason: user_requested, timeout, inactivity_timeout, creation_timeout, startup_failed, browser_closed, or browser_crashed.
--created-afterstringNoOnly sessions created at or after this ISO 8601 timestamp.
--created-beforestringNoOnly sessions created before this ISO 8601 timestamp.
steel sessions list --status live --limit 20
steel sessions list --metadata env=staging
steel sessions list --signal captcha_encountered --created-after 2026-11-01T00:00:00Z

API: GET /v1/sessions.

steel sessions get

Get one cloud session.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
steel sessions get SESSION_ID
steel sessions get --session checkout

API: GET /v1/sessions/{id}.

steel sessions metadata

Show or change a session's metadata.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
--setstring[]NoSet a key as KEY=VALUE, repeatable; other keys are kept.
--unsetstring[]NoRemove a key, repeatable.
--replacebooleanNoReplace all metadata with exactly the --set keys.
--clearbooleanNoRemove all metadata.
steel sessions metadata SESSION_ID
steel sessions metadata SESSION_ID --set outcome=failed --unset retry
steel sessions metadata SESSION_ID --replace --set env=prod

Without a flag that changes something, the command prints the metadata, one KEY=VALUE on each line.

API: GET /v1/sessions/{id}, PATCH /v1/sessions/{id}/metadata, PUT /v1/sessions/{id}/metadata.

steel sessions release

Release a cloud session.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
-a, --allbooleanNoRelease all live cloud sessions.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
steel sessions release SESSION_ID
steel sessions release --all

API: POST /v1/sessions/{id}/release, POST /v1/sessions/release.

steel sessions logs

Read browser event logs for a session.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
-f, --followbooleanNoAfter printing past events, stream live ones over a WebSocket.
--namespacestringNoFilter by namespace.
--start-timestringNoISO timestamp lower bound.
--sincestringNoAlias for --start-time.
--end-timestringNoISO timestamp upper bound.
--event-typestring[]NoEvent type filter, repeatable or comma-separated.
--limitstringNoNumber of events to return.
--offsetstringNoPagination offset.
steel sessions logs SESSION_ID --follow
steel sessions logs SESSION_ID --event-type PageError,RequestFailed --limit 50

API: GET /v1/sessions/{id}/logs.

steel sessions agent-logs

Read raw CDP-derived agent events for a session.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
--namespacestringNoFilter by namespace.
--start-timestringNoISO timestamp lower bound.
--sincestringNoAlias for --start-time.
--end-timestringNoISO timestamp upper bound.
--event-typestring[]NoEvent type filter, repeatable or comma-separated.
--limitstringNoNumber of events to return.
--offsetstringNoPagination offset.
steel sessions agent-logs SESSION_ID --limit 100

API: GET /v1/sessions/{id}/agent-logs.

steel sessions traces

Read the agent trace timeline for a session.

Argument or flagTypeRequiredDescription
session_idstringNoCloud session ID.
--sessionstringNoThe name of a steel browser session, instead of the session ID.
-f, --followbooleanNoAfter printing past traces, stream live ones over a WebSocket.
--namespacestringNoFilter by namespace.
--start-timestringNoISO timestamp lower bound.
--sincestringNoAlias for --start-time.
--end-timestringNoISO timestamp upper bound.
--event-typestring[]NoEvent type filter, repeatable or comma-separated.
steel sessions traces SESSION_ID
steel sessions traces SESSION_ID --follow

API: GET /v1/sessions/{id}/agent-traces.

steel credentials

Manage stored credentials.

SubcommandDescription
listList stored credentials
createCreate a new credential
updateUpdate an existing credential
deleteDelete a credential

steel credentials list

List stored credentials.

Argument or flagTypeRequiredDescription
-n, --namespacestringNoThe namespace to list, default when you leave this out. The command lists one namespace at a time.
--originstringNoFilter by origin URL.
steel credentials list
steel credentials list --namespace team-a --origin https://example.com

steel credentials create

Create a new credential.

Argument or flagTypeRequiredDescription
--originstringYesOrigin URL to associate the credential with.
-u, --usernamestringYesUsername.
-p, --passwordstringYesPassword.
--totp-secretstringNoTOTP secret for two-factor authentication.
-n, --namespacestringNoCredential namespace.
--labelstringNoHuman-readable label.
steel credentials create \
  --origin https://example.com \
  --username ada@example.com \
  --password "$PASSWORD" \
  --totp-secret "$TOTP_SECRET" \
  --namespace team-a

steel credentials update

Update an existing credential.

Argument or flagTypeRequiredDescription
--originstringYesOrigin URL of the credential to update.
-u, --usernamestringNoNew username.
-p, --passwordstringNoNew password.
--totp-secretstringNoNew TOTP secret.
-n, --namespacestringNoCredential namespace.
--labelstringNoNew human-readable label.
steel credentials update --origin https://example.com --password "$PASSWORD"
steel credentials update --origin https://example.com --namespace team-a --label "Example admin"

steel credentials delete

Delete a credential.

Argument or flagTypeRequiredDescription
--originstringYesOrigin URL of the credential to delete.
-n, --namespacestringNoCredential namespace.
steel credentials delete --origin https://example.com --namespace team-a

steel dev

Install, start and stop the local Steel Browser runtime.

SubcommandDescription
installInstall the local Steel Browser runtime
startStart the local runtime containers
stopStop the local runtime containers

steel dev install

Install the local Steel Browser runtime.

Argument or flagTypeRequiredDescription
--repo-urlstringNoGit repository URL for local Steel Browser runtime.
-V, --verbosebooleanNoEnable verbose git command output.
steel dev install
steel dev install --repo-url https://github.com/OWNER/steel-browser.git

steel dev start

Start the local runtime containers.

Argument or flagTypeRequiredDescription
-p, --portstringNoAPI port for local Steel Browser runtime.
-V, --verbosebooleanNoEnable verbose Docker command output.
-d, --docker-checkbooleanNoOnly verify Docker availability and exit.
steel dev start
steel dev start --docker-check

steel dev stop

Stop the local runtime containers.

Argument or flagTypeRequiredDescription
-V, --verbosebooleanNoEnable verbose Docker command output.

steel forge

Scaffold a new project from a template.

Argument or flagTypeRequiredDescription
templatestringNoTemplate to start from.
-n, --namestringNoProject name.
--listbooleanNoList available templates and exit (respects --json).
steel forge --list
steel forge playwright-ts --name my-agent

steel config

Show current configuration.

steel update

Update to the latest version.

Argument or flagTypeRequiredDescription
-f, --forcebooleanNoForce update even if already on latest version.
-c, --checkbooleanNoOnly check for updates without installing.
steel update --check
steel update

steel cache

Manage Steel CLI cache.

Argument or flagTypeRequiredDescription
-c, --cleanbooleanNoRemove all cached files and directories.
steel cache
steel cache --clean

steel profile

Manage named Steel browser profiles.

SubcommandDescription
listList the profile names saved on this computer
importImport a local browser profile into Steel
syncSync a local browser profile to an existing Steel profile
deleteForget a profile name on this computer

steel profile list

List the profile names that the CLI saved on this computer, with their profile IDs.

steel profile import

Import a local browser profile into Steel.

Argument or flagTypeRequiredDescription
namestringYesSteel profile name to save as.
--fromstringNoBrowser profile directory to import from (for example "Default", "Profile 1").
--browserstringNoBrowser to import from (chrome, edge, brave, arc, opera, vivaldi).
--fullbooleanNoInclude all profile data such as IndexedDB, History and Bookmarks.
steel profile import my-app
steel profile import my-app --browser chrome --from "Profile 1"

steel profile sync

Sync a local browser profile to an existing Steel profile.

Argument or flagTypeRequiredDescription
namestringYesSteel profile name to sync.
--fromstringNoBrowser profile directory to sync from (overrides stored source).
--browserstringNoBrowser to sync from (overrides stored browser).
--fullbooleanNoInclude all profile data such as IndexedDB, History and Bookmarks.
steel profile sync my-app
steel profile sync my-app --full

steel profile delete

Forget a profile name on this computer. The profile and its browser state stay in Steel.

Argument or flagTypeRequiredDescription
namestringYesProfile name to forget.
steel profile delete my-app

steel describe

Describe commands and parameters.

Argument or flagTypeRequiredDescription
pathstring[]NoCommand path to describe (for example "browser click").
--allbooleanNoPrint the whole command tree.
steel describe browser click
steel describe --all

steel doctor

Check environment, auth, and connectivity.

Argument or flagTypeRequiredDescription
--preflightbooleanNoOnly check auth and API connectivity.
steel doctor
steel doctor --preflight

steel skills

Manage Steel agent skills.

SubcommandDescription
listList available Steel skills
installInstall all or selected Steel skills through npx skills
updateUpdate one or more installed Steel skills through npx skills
doctorCheck Steel skills installation health
openOpen an installed skill, or its docs page when it is not installed
pathsShow detected agent install paths for Steel skills

steel skills list

List available Steel skills.

Argument or flagTypeRequiredDescription
--offlinebooleanNoUse the cached or bundled manifest instead of fetching it from GitHub.
steel skills list
steel skills list --offline

steel skills install

Install all or selected Steel skills through npx skills.

Argument or flagTypeRequiredDescription
namesstring[]Yes, unless --allThe names of the skills to install.
--allbooleanNoInstall all Steel skills from the catalog.
-a, --agentstringNoTarget agent passed to npx skills (-a).
-g, --globalbooleanNoInstall globally through npx skills (-g).
-y, --yesbooleanNoAnswer yes to every prompt of npx skills (-y).
steel skills install steel-browser
steel skills install steel-browser steel-developer -a claude-code -g
steel skills install --all --yes

steel skills update

Update one or more installed Steel skills through npx skills.

Argument or flagTypeRequiredDescription
namesstring[]NoThe names of the skills to update. Without names, every Steel skill updates.
-y, --yesbooleanNoAnswer yes to every prompt of npx skills (-y).
steel skills update
steel skills update steel-browser --yes

steel skills doctor

Check Steel skills installation health.

Argument or flagTypeRequiredDescription
--offlinebooleanNoUse the cached or bundled manifest instead of fetching it from GitHub.
steel skills doctor
steel skills doctor --offline

steel skills open

Open an installed skill, or its docs page when it is not installed.

Argument or flagTypeRequiredDescription
namestringYesSkill name.
steel skills open steel-browser

steel skills paths

Show detected agent install paths for Steel skills.

steel completion

Generate a shell completion script.

Argument or flagTypeRequiredDescription
shellenumYesShell to generate completions for: bash, zsh, fish, powershell, elvish.
steel completion zsh > ~/.zsh/completions/_steel
steel completion bash > ~/.local/share/bash-completion/completions/steel
steel completion fish > ~/.config/fish/completions/steel.fish

The install script writes the completion for your shell to the same path.