Skip to content

Commit 09a59a8

Browse files
junhsssjunhsss
committed
chore: update README
1 parent df925cf commit 09a59a8

2 files changed

Lines changed: 74 additions & 64 deletions

File tree

‎README.md‎

Lines changed: 68 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,59 @@
1-
# @steel-dev/cli
1+
# Steel CLI
22

3-
Steel CLI for browser automation, API tools, and agent workflows.
3+
> Browser infrastructure for AI agents, from your terminal.
44
5-
This package now integrates `agent-browser` directly into `steel browser`, so you can keep familiar browser commands while using Steel-native session lifecycle, auth, and endpoint handling.
5+
<!-- [![crates.io](https://img.shields.io/crates/v/steel-cli?color=orange&logo=rust)](https://crates.io/crates/steel-cli) -->
66

7-
## Jump To
7+
[![npm](https://img.shields.io/npm/v/@steel-dev/cli?color=cb3837&logo=npm&label=npm)](https://www.npmjs.com/package/@steel-dev/cli)
8+
[![License](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
9+
[![Discord](https://img.shields.io/badge/discord-join-5865F2?logo=discord&logoColor=white)](https://discord.gg/steel-dev)
810

9-
- [Install](#install)
10-
- [Quick Start](#quick-start)
11-
- [Shell Completions](#shell-completions)
12-
- [Agent-Browser Integration](#agent-browser-integration)
13-
- [Command Overview](#command-overview)
14-
- [Endpoint Resolution](#endpoint-resolution)
15-
- [Documentation Map](#documentation-map)
16-
17-
## Install
11+
The Steel CLI gives any AI agent (Claude, Cursor, Browser Use, or your own) a production-grade cloud browser: markdown-first scraping, long-running sessions, stealth, residential proxies, automatic CAPTCHA handling, and credential injection. One binary, cloud or self-hosted.
1812

1913
```bash
14+
# Install, then interactively log in and install agent skills
2015
curl -fsS https://setup.steel.dev | sh
16+
17+
# Scrape a page (agent-ready markdown)
18+
steel scrape https://example.com
2119
```
2220

23-
Or download directly from [GitHub Releases](https://github.com/steel-dev/cli/releases).
21+
<!-- TODO: replace with an asciicast of the quickstart -->
2422

25-
### Upgrading from npm
23+
## Why Steel CLI
2624

27-
If you previously installed via `npm i -g @steel-dev/cli`:
25+
- **Agent-native.** Markdown-first output, `steel describe` for machine-readable command introspection, shell completions, and ready-to-install skills for Claude Code, Cursor, OpenCode, and Codex.
26+
- **Long-running sessions.** 24-hour browser sessions, reusable named profiles, persistent auth context. Built for agents that actually live: deep research, async workflows, overnight jobs.
27+
- **Framework-agnostic.** First-class support for Claude Computer Use, OpenAI Computer Use, Gemini Computer Use, Browser Use, Playwright, Puppeteer, Selenium, Stagehand, CrewAI, Magnitude, Notte, Agno, and AgentKit.
28+
- **Cloud or self-hosted.** Fully open source. Use managed infrastructure at [steel.dev](https://steel.dev), or run the [Steel Browser](https://github.com/steel-dev/steel-browser) stack yourself with `steel dev` or Docker.
29+
- **Pro browser features.** Managed residential proxies, stealth mode, automatic CAPTCHA solving, stored credential injection. Everything a real-world agent needs.
2830

29-
```bash
30-
npm update -g @steel-dev/cli # auto-installs native binary
31-
# Then optionally:
32-
npm uninstall -g @steel-dev/cli
33-
export PATH="$HOME/.steel/bin:$PATH"
34-
```
31+
## Links
3532

36-
## Quick Start
33+
- 📖 [Docs](https://docs.steel.dev): guides, recipes, API reference
34+
- 🧪 [Cookbook](https://github.com/steel-dev/steel-cookbook): runnable examples across Python, Node, and every supported framework
35+
- 💬 [Discord](https://discord.gg/steel-dev): community, feedback, roadmap
36+
- 🐙 [GitHub](https://github.com/steel-dev/cli): source, issues, releases
3737

38-
### Cloud mode (default)
38+
## Install
3939

4040
```bash
41-
steel login
42-
steel browser start --session my-job
43-
steel browser open https://example.com --session my-job
44-
steel browser snapshot -i --session my-job
45-
steel browser stop
41+
curl -fsS https://setup.steel.dev | sh
4642
```
4743

44+
The installer drops a single binary into `~/.steel/bin`, updates your shell's `PATH`, and auto-generates shell completions for bash, zsh, and fish.
45+
46+
Alternatives:
47+
48+
- Download from [GitHub Releases](https://github.com/steel-dev/cli/releases)
49+
- `cargo install steel-cli`
50+
- `npm i -g @steel-dev/cli` (thin wrapper around the native binary)
51+
52+
After install, either restart your shell or run `export PATH="$HOME/.steel/bin:$PATH"`.
53+
4854
## Shell Completions
4955

50-
Generate a completion script for your shell:
56+
Shell completions are installed automatically by `install.sh`. To regenerate or install manually:
5157

5258
```bash
5359
# Bash (user-local)
@@ -65,31 +71,6 @@ steel completion powershell | Out-String | Invoke-Expression
6571

6672
Supported shells: `bash`, `zsh`, `fish`, `powershell`, `elvish`.
6773

68-
## Agent-Browser Integration
69-
70-
`steel browser` is directly backed by the vendored `agent-browser` runtime.
71-
72-
Steel-owned lifecycle commands:
73-
74-
- `steel browser start`
75-
- `steel browser stop`
76-
- `steel browser sessions`
77-
- `steel browser live`
78-
79-
All other `steel browser <command>` calls are inherited from upstream runtime behavior and routed through Steel.
80-
81-
Migration from upstream `agent-browser` is typically command-prefix only:
82-
83-
- before: `agent-browser <command> ...`
84-
- after: `steel browser <command> ...`
85-
86-
Read more:
87-
88-
- [Migration guide](skills/steel-browser/references/migration-agent-browser.md)
89-
- [Compatibility matrix](docs/browser-compat.md)
90-
- [Steel browser reference](docs/references/steel-browser.md)
91-
- [Synced command catalog](docs/references/steel-browser-commands.md)
92-
9374
## Command Overview
9475

9576
| Group | Commands |
@@ -103,9 +84,23 @@ Read more:
10384
| Credentials | `credentials list`, `credentials create`, `credentials update`, `credentials delete` |
10485
| Account and utility | `login`, `logout`, `config`, `doctor`, `cache`, `update`, `completion` |
10586

106-
For full flags and argument schemas, use the generated reference:
87+
Full flags and schemas: [CLI reference](docs/cli-reference.md).
88+
89+
## Agent-Browser Integration
90+
91+
`steel browser` is directly backed by the vendored [`agent-browser`](https://github.com/steel-dev/agent-browser) runtime. Steel-owned lifecycle commands:
92+
93+
- `steel browser start`
94+
- `steel browser stop`
95+
- `steel browser sessions`
96+
- `steel browser live`
97+
98+
All other `steel browser <command>` calls inherit upstream runtime behavior and route through Steel. Migration from upstream `agent-browser` is typically command-prefix only:
99+
100+
- before: `agent-browser <command> ...`
101+
- after: `steel browser <command> ...`
107102

108-
- [CLI reference](docs/cli-reference.md)
103+
See the [migration guide](skills/steel-browser/references/migration-agent-browser.md), [compatibility matrix](docs/browser-compat.md), and [synced command catalog](docs/references/steel-browser-commands.md) for details.
109104

110105
## Endpoint Resolution
111106

@@ -130,9 +125,10 @@ Attach-flag override rule:
130125

131126
## Output and Runtime Notes
132127

133-
- `steel scrape` defaults to markdown-first output for token efficiency; use `--raw` for full JSON payload.
128+
- `steel scrape` defaults to markdown-first output for token efficiency; use `--raw` for the full JSON payload.
134129
- `steel browser start` and `steel browser sessions` emit display-safe connect URLs with sensitive query values redacted.
135130
- Browser command paths bypass auto-update checks for lower interactive latency.
131+
- Piped output auto-switches to JSON for machine-readable workflows. Use `--json` to force it, or `STEEL_FORCE_TTY=1` to disable.
136132

137133
## Documentation Map
138134

@@ -156,3 +152,17 @@ Reference docs:
156152
Agent skill:
157153

158154
- [Steel Browser skill package](skills/steel-browser/README.md)
155+
156+
## Migrating from the Node CLI
157+
158+
The Steel CLI is now a single native Rust binary. If you previously installed it via `npm i -g @steel-dev/cli`, the `install.sh` script auto-detects and removes the old Node-based install. You can also do it manually:
159+
160+
```bash
161+
npm update -g @steel-dev/cli # auto-installs native binary
162+
npm uninstall -g @steel-dev/cli # optional cleanup
163+
export PATH="$HOME/.steel/bin:$PATH"
164+
```
165+
166+
---
167+
168+
Licensed under [MIT](./LICENSE).

‎install.sh‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh
22
: <<'DOCSTRING'
3-
Steel CLI — browser automation for AI agents
3+
Steel CLI: browser automation for AI agents
44
https://github.com/steel-dev/cli
55
66
Installs the Steel CLI binary and, in an interactive terminal, runs
@@ -9,15 +9,15 @@ Installs the Steel CLI binary and, in an interactive terminal, runs
99
Flags:
1010
--non-interactive Skip the interactive `steel init` step (install only)
1111
--agent Run `steel init --agent` (print the onboarding guide
12-
to stdout — intended for AI coding agents)
12+
to stdout; intended for AI coding agents)
1313
--from <name> Tag the originating coding agent (claude-code, cursor,
14-
opencode, codex, …). Informational only — used for
14+
opencode, codex, ...). Informational only; used for
1515
onboarding telemetry. Supports `--from=<name>` too.
1616
1717
REQUIRES: curl
1818
INSTALLS TO: ~/.steel/bin
1919
SHELL COMPLETIONS: auto-installed for bash/zsh/fish when $SHELL is set
20-
(silently skipped on failure — never blocks install)
20+
(silently skipped on failure; never blocks install)
2121
2222
After install, PATH is NOT updated in the current shell. Restart your shell
2323
or run: export PATH="$HOME/.steel/bin:$PATH"
@@ -70,7 +70,7 @@ if [ "$STEEL_NON_INTERACTIVE" != "yes" ]; then
7070
fi
7171
fi
7272

73-
echo "Steel CLI — browser automation for AI agents"
73+
echo "Steel CLI: browser automation for AI agents"
7474
echo "https://github.com/steel-dev/cli"
7575
echo ""
7676

@@ -185,7 +185,7 @@ if [ -x "$STEEL_BIN" ] && [ -n "${SHELL:-}" ]; then
185185
if [ -f "$HOME/.zshrc" ] && ! grep -qF '.zsh/completions' "$HOME/.zshrc" 2>/dev/null; then
186186
{
187187
printf '\n'
188-
printf '# Added by Steel CLI installer — shell completions\n'
188+
printf '# Added by Steel CLI installer: shell completions\n'
189189
printf 'fpath=("$HOME/.zsh/completions" $fpath)\n'
190190
printf 'autoload -Uz compinit && compinit\n'
191191
} >> "$HOME/.zshrc"

0 commit comments

Comments
 (0)