Skip to content

docs: fix stale browser notes in the readme #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
junhsss merged 1 commit into from
Nov 3, 2026
Merged

docs: fix stale browser notes in the readme #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ steel browser batch "fill e3 Seoul" "click e7" "snapshot -i"
- The `default` session starts on first use. Use `--session <name>` for more, or `--session <session-id>` to drive a session created elsewhere.
- Sessions are released after 10 minutes without commands (`steel browser start --inactivity-timeout <ms>`).
- A retried command never runs twice. Run the same command again after a lost response to get the stored result.
- Self-hosted Steel Browser serves these commands only with `ENABLE_COMMANDS_API=true`. `steel dev start` does not set it yet.

See the [Steel browser reference](docs/references/steel-browser.md) and the [command catalog](docs/references/steel-browser-commands.md) for details.

Expand All @@ -123,8 +124,7 @@ Cloud precedence:
## Output and Runtime Notes

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

## Documentation Map
Expand Down
5 changes: 2 additions & 3 deletions docs/references/steel-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,8 @@ For generated flags and argument schemas, use [../cli-reference.md](../cli-refer
## Global Conventions

- `--help` and `--version` are available globally.
- Browser command paths skip auto-update checks for lower command latency.
- `steel browser start` and `steel browser sessions` emit display-safe connect
URLs with sensitive query keys redacted.
- `steel browser start` prints a display-safe connect URL with sensitive query
keys redacted.
- `steel scrape`, `steel screenshot`, and `steel pdf` share local/cloud endpoint
resolution conventions with browser lifecycle commands.
- `steel scrape` defaults to markdown-first output for token efficiency; use
Expand Down
Loading