diff --git a/components/home/cli-install-card.tsx b/components/home/cli-install-card.tsx index a4d4773b..26903c5e 100644 --- a/components/home/cli-install-card.tsx +++ b/components/home/cli-install-card.tsx @@ -5,9 +5,11 @@ import * as React from 'react'; import { cn } from '@/lib/utils'; const CLI_INSTALL_COMMAND = 'curl -fsS https://setup.steel.dev | sh'; +const AGENT_SETUP_PROMPT = + '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.'; export function CLIInstallCard() { - const [copied, setCopied] = React.useState(false); + const [copied, setCopied] = React.useState(null); return (
@@ -18,32 +20,45 @@ export function CLIInstallCard() { Install Steel CLI and the steel-browser skill so your agent can control a browser.

- + {[ + { label: 'Run in your terminal', text: CLI_INSTALL_COMMAND }, + { label: 'Paste into your coding agent', text: AGENT_SETUP_PROMPT }, + ].map(({ label, text }) => ( +
+

{label}

+ +
+ ))} ); diff --git a/content/docs/integrations/claude-code.mdx b/content/docs/integrations/claude-code.mdx index a860e092..d2bc8377 100644 --- a/content/docs/integrations/claude-code.mdx +++ b/content/docs/integrations/claude-code.mdx @@ -11,34 +11,48 @@ Claude Code already works well with shell commands; Steel adds the browser surfa ### Requirements -* **Node.js**: Version 18 or higher +* **Node.js/npm**: Including `npx` for skill installation * **Claude Code**: Installed locally -* **Steel CLI**: Installed locally -* **Steel API Key**: Active Steel account +* **Steel CLI**: Stable v0.5.0 or later (installed during setup) +* **Steel account**: Device authorization; no API-key copy required ### Setup -#### Step 1: Install Steel CLI +#### Step 1: Ask Claude Code to set up Steel -```bash Terminal -curl -LsSf https://setup.steel.dev | sh +Paste this into Claude Code: + +```text Prompt +Read https://setup.steel.dev/install.md and follow it to set up Steel for claude-code. Then continue my requested task using the installed Steel skill. ``` -#### Step 2: Log in +The guide installs the stable binary and initializes the correct skill target: ```bash Terminal -steel login +curl -fsSL https://setup.steel.dev/install.sh | sh -s -- --non-interactive +"$HOME/.steel/bin/steel" --json init --agent --from claude-code ``` -#### Step 3: Install the browser skill (recommended) +#### Step 2: Approve and resume -The `steel-browser` skill gives Claude Code better command discovery and more reliable browser workflows. +Open the device authorization URL returned by Steel and approve it in your own +browser. Tell Claude Code when approval is complete so it reruns the same command: ```bash Terminal -npx skills add steel-dev/skills --skill steel-browser -a claude-code -g +"$HOME/.steel/bin/steel" --json init --agent --from claude-code +``` + +#### Step 3: Load the browser skill + +Targeted init installs `steel-browser`. Ask Claude Code to load it through its +native skill mechanism, then continue the task you requested: + +```text Prompt +Load the installed steel-browser skill, perform my browser task, verify the result, and stop the session you created when finished. ``` -Restart Claude Code after installing so it can discover the skill. +Skill installation, skill loading, and first-task completion are separate +checks. Reload the client if its skill discovery requires it. ### Authenticated workflows @@ -72,11 +86,15 @@ After a successful run, Claude Code can help turn the browser workflow into some :::faq ### Do I need to write integration code to use Steel with Claude Code? -No — the integration works through the Steel CLI. Install it with `curl -LsSf https://setup.steel.dev | sh`, run `steel login`, and Claude Code can start and control Steel sessions, scrape rendered pages, and run computer-use actions from the terminal. +No. Follow the [agent setup guide](https://setup.steel.dev/install.md) with +`claude-code` as the target. After device approval and skill loading, Claude Code +can operate Steel browser sessions through the CLI. ### How does Claude Code connect to a Steel browser session? -Through Steel CLI commands in its shell. For better command discovery and more reliable workflows, install the `steel-browser` skill with `npx skills add steel-dev/skills --skill steel-browser -a claude-code -g` and restart Claude Code so it discovers the skill. +Through Steel CLI commands in its shell. The CLI uses the HTTP Commands API for +browser actions. Targeted init installs `steel-browser`; load the skill before +running the task. ### Does Claude Code work with Steel's proxies, stealth mode, and CAPTCHA solving? diff --git a/content/docs/integrations/codex.mdx b/content/docs/integrations/codex.mdx index dd6a319f..fd40cf4f 100644 --- a/content/docs/integrations/codex.mdx +++ b/content/docs/integrations/codex.mdx @@ -11,34 +11,48 @@ Codex and Steel fit together well because both are command-line tools. The same ### Requirements -* **Node.js**: Version 18 or higher +* **Node.js/npm**: Including `npx` for skill installation * **Codex CLI**: Installed locally -* **Steel CLI**: Installed locally -* **Steel API Key**: Active Steel account +* **Steel CLI**: Stable v0.5.0 or later (installed during setup) +* **Steel account**: Device authorization; no API-key copy required ### Setup -#### Step 1: Install Steel CLI +#### Step 1: Ask Codex to set up Steel -```bash Terminal -curl -LsSf https://setup.steel.dev | sh +Paste this into Codex: + +```text Prompt +Read https://setup.steel.dev/install.md and follow it to set up Steel for codex. Then continue my requested task using the installed Steel skill. ``` -#### Step 2: Log in +The guide installs the stable binary and initializes the correct skill target: ```bash Terminal -steel login +curl -fsSL https://setup.steel.dev/install.sh | sh -s -- --non-interactive +"$HOME/.steel/bin/steel" --json init --agent --from codex ``` -#### Step 3: Install the browser skill (recommended) +#### Step 2: Approve and resume -The `steel-browser` skill gives Codex better command discovery and more consistent browser workflows. +Open the device authorization URL returned by Steel and approve it in your own +browser. Tell Codex when approval is complete so it reruns the same command: ```bash Terminal -npx skills add steel-dev/skills --skill steel-browser -a codex -g +"$HOME/.steel/bin/steel" --json init --agent --from codex +``` + +#### Step 3: Load the browser skill + +Targeted init installs `steel-browser`. Ask Codex to read the installed skill +through its native skill mechanism before continuing your task: + +```text Prompt +Load the installed steel-browser skill, perform my browser task, verify the result, and stop the session you created when finished. ``` -Restart Codex after installing so it can discover the skill. +Skill installation, skill loading, and first-task completion are separate +checks. Reload the client if its skill discovery requires it. ### Automation workflow @@ -64,11 +78,15 @@ That works well for jobs like recurring research, internal reporting, or lightwe :::faq ### Do I need to write integration code to use Steel with Codex? -No — the integration works through the Steel CLI. Install it with `curl -LsSf https://setup.steel.dev | sh`, run `steel login`, and Codex can start and control Steel sessions, scrape rendered pages, and run computer-use actions from the terminal. +No. Follow the [agent setup guide](https://setup.steel.dev/install.md) with +`codex` as the target. After device approval and skill loading, Codex can operate +Steel browser sessions through the CLI. ### How does Codex connect to a Steel browser session? -Once Steel CLI is on your `PATH`, Codex inspects command help, runs the commands it needs, and verifies results from the terminal. For better command discovery, install the `steel-browser` skill with `npx skills add steel-dev/skills --skill steel-browser -a codex -g` and restart Codex. +Through Steel CLI commands in its shell. The CLI uses the HTTP Commands API for +browser actions. Targeted init installs `steel-browser`; load the skill before +running the task. ### Does Codex work with Steel's proxies, stealth mode, and CAPTCHA solving? diff --git a/content/docs/integrations/openclaw.mdx b/content/docs/integrations/openclaw.mdx index 64718ffa..1a882ee8 100644 --- a/content/docs/integrations/openclaw.mdx +++ b/content/docs/integrations/openclaw.mdx @@ -14,10 +14,14 @@ Good fit for application forms, operational workflows, and browser-driven resear * **Node.js**: Version 18 or higher * **OpenClaw**: Installed locally * **Steel CLI**: Installed locally -* **Steel API Key**: Active Steel account +* **Steel account**: Device authorization or an API key ### Setup +OpenClaw is separate from OpenCode. It is not a supported +`steel init --agent --from` target in v0.5.0. Use the manual setup below rather +than selecting `opencode` for OpenClaw. + #### Step 1: Install Steel CLI ```bash Terminal @@ -35,10 +39,14 @@ steel login The `steel-browser` skill gives OpenClaw better command discovery and more reliable browser workflows. ```bash Terminal -npx skills add steel-dev/skills --skill steel-browser -a opencode -g +npx skills add steel-dev/skills --skill steel-browser ``` -Restart OpenClaw after installing so it can discover the skill. +Choose OpenClaw if your skill installer offers it. Otherwise, follow OpenClaw's +manual skill-installation instructions for the +[steel-browser skill](https://github.com/steel-dev/skills/tree/main/steel-browser). +Do not install into OpenCode's directories as a substitute. Load the installed +skill through OpenClaw's skill mechanism before running a task. ### Example workflow @@ -96,7 +104,9 @@ No — the integration works through the Steel CLI. Install it with `curl -LsSf ### How does OpenClaw connect to a Steel browser session? -Via Steel CLI commands in its shell. Install the `steel-browser` skill for better command discovery — `npx skills add steel-dev/skills --skill steel-browser -a opencode -g` — then restart OpenClaw so it discovers the skill. +Via Steel CLI commands in its shell. Install `steel-browser` using OpenClaw's +skill mechanism, then load it before running a task. OpenClaw and OpenCode are +different clients; the `opencode` installation target is not an OpenClaw alias. ### Does OpenClaw work with Steel's proxies, stealth mode, and CAPTCHA solving? diff --git a/content/docs/overview/skills/available-skills/steel-browser.mdx b/content/docs/overview/skills/available-skills/steel-browser.mdx index ffdc0de7..886c45dd 100644 --- a/content/docs/overview/skills/available-skills/steel-browser.mdx +++ b/content/docs/overview/skills/available-skills/steel-browser.mdx @@ -7,6 +7,10 @@ llm: true ## Install +For complete stable CLI setup, device authorization, and targeted installation, +follow [the agent onboarding guide](https://setup.steel.dev/install.md). +To install only this skill: + ```bash Terminal npx skills add steel-dev/skills --skill steel-browser ``` @@ -17,6 +21,9 @@ After adding the Steel Skills marketplace in Claude Code: /plugin install steel-browser@steel-skills ``` +Load the installed skill through your client's native skill mechanism before +using it. Installation alone is not evidence that the skill has been loaded. + ## Use When - The agent should visit a page now. diff --git a/content/docs/overview/skills/index.mdx b/content/docs/overview/skills/index.mdx index 4c3cdaae..402cf78c 100644 --- a/content/docs/overview/skills/index.mdx +++ b/content/docs/overview/skills/index.mdx @@ -10,6 +10,13 @@ Most users should start with `steel-browser` and `steel-developer`. Add the debu ## Quick install +For complete CLI authorization and browser-skill setup in OpenCode, Codex, Pi, +or Claude Code, start with the [agent onboarding guide](https://setup.steel.dev/install.md): + +```text Prompt +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. +``` + Use `npx skills` when you want a direct install command that works across supported coding agents. ```bash Terminal @@ -61,6 +68,10 @@ npx skills add steel-dev/skills --skill steel-browser -a opencode -g Supported agent targets are Claude Code, Cursor, Codex, OpenCode, and Pi. +These are standalone skill-installer targets. The stable CLI's targeted +`init --agent --from` flow currently accepts only `claude-code`, `codex`, +`opencode`, and `pi`; it does not accept `cursor`. + ## Which skill should I use? - Use `steel-browser` for live web work the agent should perform now. @@ -77,7 +88,9 @@ steel doctor --preflight steel scrape https://example.com ``` -Restart your agent client after installing new skills so it can discover them. +Load the installed skill using your client's skill mechanism; reload or restart +the client if its discovery requires it. A successful install or doctor check +does not establish skill loading or completion of your requested task. ## Skills or MCP? diff --git a/content/docs/overview/steel-cli.mdx b/content/docs/overview/steel-cli.mdx index 507eb43d..5a3f1718 100644 --- a/content/docs/overview/steel-cli.mdx +++ b/content/docs/overview/steel-cli.mdx @@ -1,7 +1,7 @@ --- title: Steel CLI sidebarTitle: Steel CLI -description: Run browser automation from the terminal with the Steel CLI. Manage sessions, scrape, screenshot, and install Steel Skills for coding agents like Claude Code, Cursor, Codex, and OpenCode. +description: Set up stable Steel CLI v0.5.0 for OpenCode, Codex, Pi, and Claude Code. Manage browser sessions, download files, scrape pages, and verify results. llm: true --- @@ -14,13 +14,13 @@ stop the session without wiring custom browser infrastructure. What it enables: - Run browser automation in cloud mode (default) or self-hosted/local mode -- Drive pages with terminal-first browser commands (`open`, `snapshot`, `fill`, `click`, etc.) +- Drive pages with terminal-first browser commands (`navigate`, `snapshot`, `fill`, `click`, etc.) - Use API tools for `scrape`, `screenshot`, and `pdf` -- Bootstrap projects quickly with `forge` and run templates instantly with `run` +- Bootstrap projects with `forge` -Under the hood, `steel browser` is directly integrated with the `agent-browser` runtime. -That means Steel adds session lifecycle, auth, and endpoint routing while preserving -familiar browser command behavior. +In v0.5.0, browser actions use the HTTP Commands API. The browser engine runs +inside the Steel session; the CLI does not require a local browser daemon or +an `agent-browser` installation. - GitHub: [steel-dev/cli](https://github.com/steel-dev/cli) @@ -28,9 +28,10 @@ familiar browser command behavior. If you are using an AI agent and want a complete docs index before exploring pages: -- `https://docs.steel.dev/llms-full.txt` +- `https://docs.steel.dev/llms.txt` -This returns a flattened, agent-friendly text map of the docs site. +Fetch the individual pages listed in the index as needed. For CLI setup, start +with [the agent onboarding guide](https://setup.steel.dev/install.md). ## Installation @@ -40,8 +41,37 @@ Install with the official script (recommended): curl -fsS https://setup.steel.dev | sh ``` -This installs the native `steel` binary to `~/.steel/bin` and runs `steel init` -to log you in, verify connectivity, and install coding-agent skills. +This installs the stable native `steel` binary to `~/.steel/bin` and, in an +interactive terminal, runs `steel init`. Restart your shell or run +`export PATH="$HOME/.steel/bin:$PATH"` before using `steel` by name. + +### Setup with your coding agent + +Paste this into OpenCode, Codex, Pi, or Claude Code: + +```text Prompt +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. +``` + +The guide installs the stable binary without interactive setup, then initializes +the selected client explicitly. For example, in Codex: + +```bash Terminal +curl -fsSL https://setup.steel.dev/install.sh | sh -s -- --non-interactive +"$HOME/.steel/bin/steel" --version +"$HOME/.steel/bin/steel" --json init --agent --from codex +``` + +Use the matching `--from` value: `opencode`, `codex`, `pi`, or `claude-code`. +When approval is pending, the agent shows you the device authorization URL. +Approve it in your browser, then have the agent rerun the same init command. +Successful initialization installs the skill; the agent must still load it +through its native skill mechanism and verify the requested task. + +- A Steel account is enough for device login; copying an API key is not required. +- Node.js/npm, including `npx`, is required when installing skills. +- Pass `--from` directly to `steel init --agent`. The installer's + `STEEL_ONBOARDING_FROM` value is telemetry metadata, not a setup target. ## Quick Start @@ -50,7 +80,7 @@ to log you in, verify connectivity, and install coding-agent skills. ```bash Terminal -wc steel login steel browser start --session my-job -steel browser open https://example.com --session my-job +steel browser navigate https://example.com --session my-job steel browser snapshot -i --session my-job steel browser stop --session my-job ``` @@ -59,7 +89,7 @@ steel browser stop --session my-job ```bash Terminal steel browser start --api-url https://steel.your-domain.dev/v1 --session my-job -steel browser open https://example.com --api-url https://steel.your-domain.dev/v1 --session my-job +steel browser navigate https://example.com --api-url https://steel.your-domain.dev/v1 --session my-job ``` ### Local Runtime (`localhost`) Flow @@ -68,11 +98,15 @@ steel browser open https://example.com --api-url https://steel.your-domain.dev/v steel dev install steel dev start steel browser start --local --session local-job -steel browser open https://example.com --session local-job +steel browser navigate https://example.com --local --session local-job steel browser stop --session local-job steel dev stop ``` +The self-hosted browser service must enable `ENABLE_COMMANDS_API=true` for these +actions. `steel dev start` does not enable that server setting automatically. +Cloud device credentials are not forwarded to a different API origin. + ## Skills for Coding Agents Steel ships a first-party skills catalog for agent workflows: @@ -84,7 +118,7 @@ This is designed for coding agents, including: - Codex - OpenCode -- OpenClaw +- Pi - Claude Code Install from the public skills catalog: @@ -101,13 +135,15 @@ steel skills list steel skills doctor ``` -After installation, restart your agent client so it can discover newly installed skills. +For complete CLI setup, prefer the [agent onboarding guide](https://setup.steel.dev/install.md). +For a standalone skill installation, follow the client's discovery mechanism; +reload or restart it if necessary, then load the installed skill before use. What this skill gives agents: - Mode-aware command planning (cloud vs self-hosted) - Named-session lifecycle discipline (`start -> work -> stop`) -- Reliable command patterns for `steel browser` passthrough actions +- Supported command patterns for `steel browser` actions - Migration guidance from `agent-browser` - Troubleshooting playbooks for auth/session/CAPTCHA failures @@ -124,29 +160,20 @@ Most agent loops follow this pattern: ```bash Terminal SESSION="signup-demo-$(date +%s)" steel browser start --session "$SESSION" -steel browser open https://example.com/signup --session "$SESSION" +steel browser navigate https://example.com/signup --session "$SESSION" steel browser snapshot -i --session "$SESSION" steel browser fill @e1 "Jane Doe" --session "$SESSION" steel browser fill @e2 "jane@example.com" --session "$SESSION" steel browser select @e3 "California" --session "$SESSION" steel browser check @e4 --session "$SESSION" steel browser click @e5 --session "$SESSION" -steel browser wait --load networkidle --session "$SESSION" +steel browser wait --load-state networkidle --session "$SESSION" steel browser stop --session "$SESSION" ``` -If you already know upstream `agent-browser`, the behavior is typically command-prefix only: - -```bash Terminal -agent-browser open https://example.com/signup -agent-browser snapshot -i -agent-browser fill @e1 "Jane Doe" -agent-browser fill @e2 "jane@example.com" -agent-browser select @e3 "California" -agent-browser check @e4 -agent-browser click @e5 -agent-browser wait --load networkidle -``` +References such as `@e1` come from the latest snapshot; replace the illustrative +refs above with the ones returned for your page. Use the Steel command help +rather than assuming every `agent-browser` option is supported. ## Command Model @@ -158,26 +185,19 @@ agent-browser wait --load networkidle - `steel browser live` - `steel browser captcha solve` -### Inherited Browser Commands (Passthrough) - -All non-lifecycle `steel browser ` calls are routed through the vendored -`agent-browser` runtime. +### Browser Actions (Commands API) -Migration is usually command-prefix only: +The CLI sends actions to the Commands API for the selected session. It does not +pass arbitrary commands through to a separate local browser runtime. -- Before: `agent-browser ...` -- After: `steel browser ...` +Common actions include: -### Essential Inherited Commands - -These are the most common inherited commands agents use: - -- Page navigation: `open`, `back`, `forward`, `reload` +- Page navigation: `navigate`, `back`, `forward`, `reload` - Page understanding: `snapshot`, `snapshot -i` - Interaction: `click`, `fill`, `type`, `select`, `check`, `press`, `hover` - Data retrieval: `get text`, `get html`, `get title`, `get url` -- Synchronization: `wait`, `wait --load networkidle`, `wait --text` -- Debugging: `screenshot`, `errors`, `console` +- Synchronization: `wait`, `wait --load-state networkidle`, `wait --text` +- Debugging: `screenshot`, `status`, `cancel` Use command help directly when needed: @@ -198,7 +218,7 @@ For full command references: | ------------------- | -------------------------------------------------------------------------------------------- | | Onboarding | `init`, `forge` | | Browser lifecycle | `browser start`, `browser stop`, `browser sessions`, `browser live`, `browser captcha solve` | -| Browser passthrough | `steel browser ` | +| Browser actions | `browser navigate`, `snapshot`, `click`, `fill`, `wait`, `batch` | | API tools | `scrape`, `screenshot`, `pdf` | | Local runtime | `dev install`, `dev start`, `dev stop` | | Profiles | `profile import`, `profile sync`, `profile list`, `profile delete` | @@ -212,7 +232,7 @@ For full command references: ```bash Terminal SESSION="job-$(date +%s)" steel browser start --session "$SESSION" -steel browser open https://example.com --session "$SESSION" +steel browser navigate https://example.com --session "$SESSION" steel browser snapshot -i --session "$SESSION" steel browser get title --session "$SESSION" steel browser stop --session "$SESSION" @@ -222,27 +242,30 @@ steel browser stop --session "$SESSION" ```bash Terminal # Manual solve mode -steel browser start --session my-job --session-solve-captcha +steel browser start --session my-job --solve-captcha steel browser captcha solve --session my-job # Auto solve mode (stealth preset) steel browser start --session my-job --stealth ``` -### 3. `agent-browser` Migration +### 3. Download a File + +After navigating to a report page, use its snapshot reference to click the +download link. Then retrieve the file before stopping the session: ```bash Terminal -# Before -agent-browser open https://example.com -agent-browser snapshot -i -agent-browser click @e3 - -# After -steel browser open https://example.com -steel browser snapshot -i -steel browser click @e3 +# Replace @e3 with the download link ref from your session's snapshot. +steel browser click @e3 --session "$SESSION" +steel browser wait --download --output ./report.csv --session "$SESSION" +cat ./report.csv +steel browser stop --session "$SESSION" ``` +Check the saved file and the requested result before reporting success. Use the +same named session throughout; cleanup should release only the session created +for your task. + ### 4. API Tool Commands ```bash Terminal @@ -273,26 +296,17 @@ steel forge --help ## Endpoint Resolution -For browser lifecycle, passthrough bootstrap, and API tools (`scrape`, `screenshot`, `pdf`), -endpoint selection is deterministic. - -Self-hosted precedence: +API endpoint selection follows one precedence chain: 1. `--api-url ` -2. `STEEL_BROWSER_API_URL` -3. `STEEL_LOCAL_API_URL` -4. `browser.apiUrl` in `~/.config/steel/config.json` -5. `http://localhost:3000/v1` - -Cloud precedence: - -1. `STEEL_API_URL` -2. `https://api.steel.dev/v1` - -Attach-flag override: +2. `--local`: `browser.apiUrl` in `~/.config/steel/config.json`, or `http://localhost:3000/v1` +3. `STEEL_API_URL` +4. `https://api.steel.dev/v1` -- If `--cdp` or `--auto-connect` is provided, Steel skips bootstrap injection and forwards - passthrough arguments unchanged. +For a session created elsewhere, use `--session `. Stopping an +ID-attached session forgets its local attachment without releasing the cloud +session. Use an explicit `steel sessions release ` when release is +intended. There is no generic `--cdp` or `--auto-connect` passthrough. ## Auth, Config, and Updates @@ -321,10 +335,9 @@ NODE_ENV=test steel scrape https://example.com ## Runtime and Output Notes -- `steel scrape` defaults to markdown-first output; use `--raw` for full JSON payload. -- `steel browser start` and `steel browser sessions` return display-safe `connect_url` values - with sensitive query parameters redacted. -- Browser command paths bypass auto-update checks to reduce interactive latency. +- Output is text by default, even when piped. Use `--json` for machine-readable + output, including the full scrape API response. +- Displayed connection URLs redact sensitive query parameters. ## Troubleshooting @@ -333,7 +346,7 @@ NODE_ENV=test steel scrape https://example.com `--api-url`, env vars). - Session reuse issues: use a consistent `--session ` across every step. - Local runtime issues: run `steel dev install` once, then `steel dev start`. -- Stale state: run `steel browser stop --all` and start a fresh named session. +- Stale state: stop the specific named session you created, then start a fresh one. ## References @@ -347,9 +360,13 @@ NODE_ENV=test steel scrape https://example.com :::faq ### How do I install the Steel CLI? -Run `curl -fsS https://setup.steel.dev | sh`. This installs the native `steel` binary to `~/.steel/bin` and runs `steel init` to log you in, verify connectivity, and install coding-agent skills. +For agent-led setup, follow [setup.steel.dev/install.md](https://setup.steel.dev/install.md). +For a human terminal, run `curl -fsS https://setup.steel.dev | sh`, then restart +your shell or add `~/.steel/bin` to your current `PATH`. ### Can I scrape or screenshot a page from the terminal without writing code? -Yes. The CLI ships one-shot API tools: `steel scrape ` (markdown-first output by default, `--raw` for full JSON), `steel screenshot --full-page`, and `steel pdf `. +Yes. The CLI ships one-shot API tools: `steel scrape ` (markdown-first output +by default, `--json` for the full response), `steel screenshot --full-page`, +and `steel pdf `. ::: diff --git a/lib/agent-instructions.ts b/lib/agent-instructions.ts index a10b970c..07a5fc5b 100644 --- a/lib/agent-instructions.ts +++ b/lib/agent-instructions.ts @@ -10,7 +10,8 @@ export const AGENT_INSTRUCTIONS = `# Steel Documentation ## Quick Reference - Install: \`npm install steel-sdk\` (Node.js) or \`pip install steel-sdk\` (Python) -- CLI: \`curl -sSf https://setup.steel.dev | sh\` +- Agent CLI setup (stable v0.5.0+): https://setup.steel.dev/install.md +- Human-terminal CLI install: \`curl -fsS https://setup.steel.dev | sh\` - Auth header: \`steel-api-key: \` - Auth env var: \`STEEL_API_KEY\` - API base URL: \`https://api.steel.dev\` @@ -21,6 +22,13 @@ export const AGENT_INSTRUCTIONS = `# Steel Documentation ## Agent Instructions +- For CLI setup, read https://setup.steel.dev/install.md. Install the stable binary, then run + \`steel init --agent --from \` with \`opencode\`, \`codex\`, \`pi\`, or \`claude-code\`. + Ask the user to approve the returned device URL, then resume the same init command. + Load the installed \`steel-browser\` skill before performing the user's task. +- CLI device login does not require copying an API key. The SDK/REST API examples below + use \`STEEL_API_KEY\` separately; do not extract a CLI device grant into application code. +- CLI output is text by default, including when piped. Pass \`--json\` for machine-readable output. - For the simplest one-liner scrape, use the CLI: \`\`\`bash steel scrape https://example.com