@@ -22,20 +22,20 @@ The Steel CLI is a powerful command-line interface for interacting with the Stee
2222
2323The Steel CLI requires Node.js 18 or higher.
2424
25- ``` bash
26- npm i @steel-dev/cli -g
25+ ``` package-install -wc
26+ @steel-dev/cli -g
2727```
2828
2929Verify the installation:
3030
31- ``` bash
31+ ``` bash Terminal -wc
3232steel --version
3333```
3434
3535For TypeScript examples, ensure you have ` ts-node ` installed globally:
3636
37- ``` bash
38- npm install -g ts-node
37+ ``` package-install
38+ ts-node -g
3939```
4040
4141## Quick Start
@@ -44,7 +44,7 @@ npm install -g ts-node
4444
4545First, authenticate with your Steel account:
4646
47- ``` bash
47+ ``` bash Terminal -wc
4848steel login
4949```
5050
@@ -54,7 +54,7 @@ This will open your browser to authenticate. Once complete, you're ready to go!
5454
5555The fastest way to get started is using the ` run ` command, which executes automations instantly without creating any files:
5656
57- ``` bash
57+ ``` bash Terminal -w
5858# Run a Playwright automation
5959steel run playwright
6060
@@ -69,7 +69,7 @@ steel run browser-use
6969
7070For more substantial projects, use ` forge ` to scaffold a complete project:
7171
72- ``` bash
72+ ``` bash Terminal -w
7373# Interactive mode - choose from available templates
7474steel forge
7575
@@ -87,7 +87,7 @@ steel forge playwright-py --name my-project --skip_auth
8787The ` forge ` command scaffolds complete projects with all necessary dependencies and boilerplate code.
8888
8989** Usage:**
90- ``` bash
90+ ``` bash Terminal
9191steel forge [template] [options]
9292```
9393
@@ -117,7 +117,7 @@ steel forge [template] [options]
117117
118118** Examples:**
119119
120- ``` bash
120+ ``` bash Terminal
121121# Interactive template selection
122122steel forge
123123
@@ -136,7 +136,7 @@ steel forge puppeteer --name custom-bot --api_url https://api.steel.dev
136136Run automations immediately without creating project files. Perfect for quick tests and one-off scripts.
137137
138138** Usage:**
139- ``` bash
139+ ``` bash Terminal
140140steel run [template] [options]
141141```
142142
@@ -168,7 +168,7 @@ steel run [template] [options]
168168
169169** Examples:**
170170
171- ``` bash
171+ ``` bash Terminal
172172# Run Playwright automation interactively
173173steel run playwright
174174
@@ -191,7 +191,7 @@ steel run playwright --no-update-check
191191Switch between local and cloud execution modes for your Steel automations.
192192
193193** Usage:**
194- ``` bash
194+ ``` bash Terminal -wc
195195steel settings
196196```
197197
@@ -210,7 +210,7 @@ This opens an interactive menu where you can choose:
210210
211211** Example Workflow:**
212212
213- ``` bash
213+ ``` bash Terminal
214214# Check current settings
215215steel settings
216216
@@ -230,7 +230,7 @@ steel settings
230230
231231### Authentication
232232
233- ``` bash
233+ ``` bash Terminal
234234# Login to Steel
235235steel login
236236
@@ -245,7 +245,7 @@ steel config
245245
246246The CLI caches templates and files for faster execution:
247247
248- ``` bash
248+ ``` bash Terminal
249249# View cache information
250250steel cache
251251
@@ -255,7 +255,7 @@ steel cache --clean
255255
256256### Development Tools
257257
258- ``` bash
258+ ``` bash Terminal
259259# Start Steel Browser in development mode
260260steel browser start
261261
@@ -268,7 +268,7 @@ steel browser stop
268268
269269### Help & Resources
270270
271- ``` bash
271+ ``` bash Terminal
272272# View CLI help
273273steel --help
274274
@@ -287,7 +287,7 @@ steel star
287287
288288### Updates
289289
290- ``` bash
290+ ``` bash Terminal
291291# Update to latest version
292292steel update
293293
@@ -300,7 +300,7 @@ steel update --force
300300
301301The CLI automatically checks for updates every 24 hours. Disable with:
302302
303- ``` bash
303+ ``` bash Terminal
304304# Using flag
305305steel run --no-update-check
306306
@@ -312,7 +312,7 @@ STEEL_CLI_SKIP_UPDATE_CHECK=true steel run
312312
313313### Example 1: Quick Web Scraping
314314
315- ``` bash
315+ ``` bash Terminal
316316# Run a Playwright automation with live viewer
317317steel run playwright --view
318318
@@ -322,7 +322,7 @@ steel run playwright --view
322322
323323### Example 2: Create a Browser-use Project
324324
325- ``` bash
325+ ``` bash Terminal
326326# Create a new Browser Use project
327327steel forge browser-use --name price-monitor
328328
@@ -338,7 +338,7 @@ uv run main.py
338338
339339### Example 3: Using Authentication Context
340340
341- ``` bash
341+ ``` bash Terminal
342342# Create a project with reusable auth
343343steel forge auth --name linkedin-scraper
344344
@@ -350,7 +350,7 @@ steel forge auth --name linkedin-scraper
350350
351351### Example 4: Multi-Step Workflow
352352
353- ``` bash
353+ ``` bash Terminal
354354# 1. Create project with credentials API
355355steel forge creds --name secure-automation
356356
@@ -364,7 +364,7 @@ steel settings
364364
365365### Example 5: Local Development, Cloud Production
366366
367- ``` bash
367+ ``` bash Terminal
368368# Develop locally
369369steel settings # Choose "Local"
370370steel forge playwright --name my-bot
@@ -395,7 +395,7 @@ Run `steel cache --clean` periodically to free up disk space, especially after t
395395### 5. Environment Variables
396396For CI/CD pipelines, use environment variables:
397397
398- ``` bash
398+ ``` bash Terminal -wc
399399export STEEL_API_KEY=your_key
400400export STEEL_CLI_SKIP_UPDATE_CHECK=true
401401steel run playwright --skip_auth
@@ -412,7 +412,7 @@ When using `forge`, make sure to:
412412### Command Not Found
413413If ` steel ` command isn't found after installation:
414414
415- ``` bash
415+ ``` bash Terminal
416416# Reinstall globally
417417npm install -g @steel-dev/cli
418418
@@ -422,15 +422,15 @@ npx @steel-dev/cli run playwright
422422
423423### Authentication Issues
424424
425- ``` bash
425+ ``` bash Terminal -w
426426# Clear session and re-authenticate
427427steel logout
428428steel login
429429```
430430
431431### Template Errors
432432
433- ``` bash
433+ ``` bash Terminal -w
434434# Clear cache and try again
435435steel cache --clean
436436steel forge playwright
@@ -440,7 +440,7 @@ steel forge playwright
440440
441441Ensure you're using Node.js 18 or higher:
442442
443- ``` bash
443+ ``` bash Terminal -w
444444node --version
445445# Should be v18.0.0 or higher
446446```
0 commit comments