Skip to content
FairCrawl Docs

CLI

faircrawl-cli is the operator path for local terminals and coding-agent workflows. It installs cleanly on Node 20+ and uses the same API key as the SDKs.

Install and authenticate

Terminal window
npx -y faircrawl-cli@latest init --all --browser


# or save an existing key
faircrawl auth --key fc_live_xxx

Core commands

Terminal window
faircrawl status
faircrawl scrape https://stripe.com/pricing --format markdown
faircrawl map https://docs.stripe.com --limit 50 --search checkout
faircrawl research "best docs search experiences" --depth deep --synthesize
faircrawl agent "Compare Stripe and Adyen pricing for a SaaS company"

Browser, enrichment, and freshness

Terminal window
faircrawl interact https://example.com/login \
  --actions '[{"type":"fill","selector":"#email","value":"user@example.com"},{"type":"click","selector":"button[type=\"submit\"]"},{"type":"extract","format":"markdown"}]'


faircrawl enrich company stripe.com
faircrawl freshness register --entity company_stripe --source pricing_page --url https://stripe.com/pricing --cadence "7 days"
faircrawl freshness dashboard
faircrawl freshness due --limit 25 --state stale

Platform shortcuts

Terminal window
faircrawl twitter profile openai
faircrawl tiktok profile nike
faircrawl reddit profile https://reddit.com/r/webscraping/
faircrawl linkedin profile satyanadella
faircrawl bluesky profile paulgraham.bsky.social

Output modes

  • --json returns structured output for scripts
  • -o, --output <path> writes the response to disk
  • root-level --api-base-url and --app-base-url let you point the CLI at a different environment