CLI

Install the published HeadlessX CLI, log in, and use the same operator API from the terminal.

by @saifyxpro

HeadlessX CLI

The published HeadlessX CLI package is:

  • package: @headlessx-cli/core
  • command: headlessx

It talks to the same backend API used by the dashboard, so it can reuse the same operator surfaces and the same persistent browser state managed by the API runtime.

Install


With npm:

With pnpm:

Log in


Interactive login:

Direct login:

Environment variables also work:

Common commands


Website scrape:

Google AI Search:

Tavily and Exa:

YouTube:

Jobs and operators:

Output model


headlessx is markdown-first by default.

  • default output is compact markdown or text
  • --json opts into JSON
  • --pretty pretty-prints JSON
  • -o page.md or -o data.json writes to a file
Redis is only needed for crawl

Website scrape, map, Google AI Search, Tavily, Exa, and YouTube commands do not need Redis. Queue-backed crawl commands still require Redis plus the worker, because they call the same /api/operators/website/crawl backend workflow as the dashboard.

Related Docs

Next Steps