Skip to content

Commit 322ee58

Browse files
VinciGit00claude
andcommitted
docs: update CLI docs to match just-scrape PR #13 actual code
- Add Monitor command section (create, list, get, update, delete, pause, resume) - Fix extract: --mode is HTML mode (normal/reader/prune), not fetch mode - Fix search: --location-geo-code → --country - Fix fetch modes: auto|fast|js + separate --stealth flag - Add schema to history services list Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1ba88db commit 322ee58

1 file changed

Lines changed: 39 additions & 9 deletions

File tree

services/cli.mdx

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ Extract structured data from any URL using AI (replaces `smart-scraper`). [Full
8282
just-scrape extract <url> -p <prompt>
8383
just-scrape extract <url> -p <prompt> --schema <json>
8484
just-scrape extract <url> -p <prompt> --scrolls <n>
85-
just-scrape extract <url> -p <prompt> --mode direct+stealth
85+
just-scrape extract <url> -p <prompt> --mode reader # HTML mode: normal, reader, prune
86+
just-scrape extract <url> -p <prompt> --stealth
8687
just-scrape extract <url> -p <prompt> --cookies <json> --headers <json>
8788
just-scrape extract <url> -p <prompt> --country <iso>
8889
```
@@ -97,7 +98,7 @@ just-scrape search <query> --num-results <n>
9798
just-scrape search <query> -p <prompt>
9899
just-scrape search <query> --schema <json>
99100
just-scrape search <query> --format markdown # or html
100-
just-scrape search <query> --location-geo-code <iso> # e.g. us, it, gb
101+
just-scrape search <query> --country <iso> # e.g. us, de, jp
101102
just-scrape search <query> --time-range past_week # past_hour|past_24_hours|past_week|past_month|past_year
102103
just-scrape search <query> --headers <json>
103104
```
@@ -115,7 +116,7 @@ just-scrape scrape <url> -f json -p "Extract the title" # json format require
115116
just-scrape scrape <url> -f json -p <prompt> --schema <json>
116117
just-scrape scrape <url> --html-mode reader # normal | reader | prune
117118
just-scrape scrape <url> --scrolls 3
118-
just-scrape scrape <url> -m direct+stealth
119+
just-scrape scrape <url> -m js --stealth
119120
just-scrape scrape <url> --country <iso>
120121
```
121122

@@ -138,7 +139,7 @@ Convert any webpage to clean markdown (convenience wrapper for `scrape --format
138139

139140
```bash
140141
just-scrape markdownify <url>
141-
just-scrape markdownify <url> -m direct+stealth
142+
just-scrape markdownify <url> -m js --stealth
142143
just-scrape markdownify <url> --headers <json>
143144
```
144145

@@ -153,20 +154,49 @@ just-scrape crawl <url> --max-depth <n>
153154
just-scrape crawl <url> --max-links-per-page <n>
154155
just-scrape crawl <url> --allow-external
155156
just-scrape crawl <url> -f markdown # or html, json, etc.
156-
just-scrape crawl <url> -m direct+stealth
157+
just-scrape crawl <url> -m js --stealth
157158
```
158159

159160
### Fetch Modes
160161

161-
Use `-m / --mode` on `extract`, `search`, `scrape`, `markdownify`, and `crawl` to choose how pages are fetched. The legacy `--stealth` boolean is replaced by the mode enum below.
162+
Use `-m / --mode` on `scrape`, `markdownify`, and `crawl` to choose how pages are fetched. Add `--stealth` to enable anti-bot bypass.
162163

163164
| Mode | Description |
164165
|---|---|
165166
| `auto` | Automatic selection (default) |
166167
| `fast` | Fastest, no JS rendering |
167168
| `js` | Full JS rendering |
168-
| `direct+stealth` | Direct fetch with anti-bot bypass |
169-
| `js+stealth` | JS rendering with anti-bot bypass |
169+
170+
<Note>
171+
On `extract`, `--mode` sets the **HTML processing mode** (`normal`, `reader`, `prune`) instead. Use `--stealth` separately for anti-bot bypass.
172+
</Note>
173+
174+
### Monitor
175+
176+
Create and manage page-change monitors that track changes on a URL at a set interval.
177+
178+
```bash
179+
# Create a monitor
180+
just-scrape monitor create --url <url> --interval <interval>
181+
just-scrape monitor create --url <url> --interval 1h --name "My Monitor"
182+
just-scrape monitor create --url <url> --interval 30m -f markdown,links --webhook-url <url>
183+
just-scrape monitor create --url <url> --interval 1d -m js --stealth
184+
185+
# List all monitors
186+
just-scrape monitor list
187+
188+
# Get a specific monitor
189+
just-scrape monitor get --id <monitor-id>
190+
191+
# Update a monitor
192+
just-scrape monitor update --id <monitor-id> --interval 2h
193+
just-scrape monitor update --id <monitor-id> --name "New Name" -f html,screenshot
194+
195+
# Pause / resume / delete
196+
just-scrape monitor pause --id <monitor-id>
197+
just-scrape monitor resume --id <monitor-id>
198+
just-scrape monitor delete --id <monitor-id>
199+
```
170200

171201
### History
172202

@@ -180,7 +210,7 @@ just-scrape history <service> --page-size <n>
180210
just-scrape history <service> --json
181211
```
182212

183-
Services: `scrape`, `extract`, `search`, `monitor`, `crawl`
213+
Services: `scrape`, `extract`, `schema`, `search`, `monitor`, `crawl`
184214

185215
### Credits
186216

0 commit comments

Comments
 (0)