Skip to content

Command line

Terminal window
frankensurf <command> [urls…] [options]

Everything prints as JSON. The raw page is left out unless you add --raw.

Command Takes Does
read one URL Fetch a page
extract one URL Fetch a page and run a site parser (--adapter)
batch one or more URLs Fetch several pages
search search words Search with --source
images one or more photo URLs Download and check photos
trace a trace ID Show how a result was fetched
import one URL Save something you captured yourself (--evidence-file, --observed-at)
executor-enroll a name Register your Chrome (--cdp-url, --user-data-dir)
identity-enroll a name Register a login (--executor-id, --domain)
identity-status a name, optional Check your logins
identity-revoke a name Remove a login

--identity works with read, extract, batch, search and images.

Option Default What it does
--state state Where to save things
--provider automatic Force a tool: http, local, local_cdp, steel, camoufox, scrapling, scrapling_http
--identity Fetch as one of your logins
--freshness now now, hour, day or cached
--adapter Which site parser to use
--render off Use a browser
--images off Download photos
--max-images 12 Most photos to download
--navigation-page 1 Carsales page 1 to 3
--timeout 25 Seconds to wait
--wait-selector Wait for this element
--source searxng searxng, duckduckgo_html or bing_rss
--search-url Your SearXNG address
--limit 10 How many search results
--raw off Include the raw page
--steel-url, --cdp-url, --identity-registry from environment Addresses and paths
Option Used with What it does
--executor-id identity-enroll Which registered Chrome to use
--domain identity-enroll A site this login is for (repeat for more)
--image-domain identity-enroll A photo server this login may use (repeat for more)
--authority-mode identity-enroll Where the login lives; default LOCAL_ONLY
--auth-url, --authenticated-selector, --login-selector identity-enroll How to tell you’re logged in
--user-data-dir, --profile-directory executor-enroll Your Chrome profile. Never shared.
--profile-ref, --profile-version executor-enroll A label and version for the profile
--network-context, --geography executor-enroll Where this Chrome runs
Terminal window
frankensurf read https://example.com --render --images
frankensurf extract https://www.ebay.com.au/itm/123456789 --adapter ebay_listing
frankensurf batch https://a.example https://b.example --freshness day
frankensurf search 'Nikon 70-200' --source bing_rss --limit 20
frankensurf trace 6f1c2d…