Skip to main content
The stophy command calls the API from your terminal. It reads the endpoint list from the API at run time, so a new endpoint is a new command. stophy <command> --help lists the options.

Install

The binary goes to ~/.local/bin. On Windows, run irm https://stophy.dev/install.ps1 | iex. With Node.js 20 or later, npm install -g @stophy/cli also works. Check with stophy version. Without logging in, commands that stophy endpoints marks free work within the free limits:

Log in

stophy login --browser prints a code and opens stophy.dev. Check the page shows the same code, then click Approve. With no browser, open the printed link on another device. With a key from the dashboard, run stophy login --api-key and paste it when prompted. Never pass a key as an argument. In CI, set STOPHY_API_KEY from your secret store. Each computer gets its own key, and logging in again replaces it. stophy logout revokes it. See Get credentials.

Set up your agent

stophy init --all logs you in, installs the skills with npx -y skills add stophydotdev/stophy and adds the MCP server. With Claude Code on your PATH it runs claude mcp add. For other agents it prints the command and leaves your config files alone.

Make a request

  • --json prints the data as JSON, --raw the full response, -o <path> writes a file. With --json the cost and request id go to stderr.
  • Give lists as --urls a,b. Switch a yes-or-no option with --flag and --no-flag. Pass JSON options as one quoted argument, like --formats '["markdown","links"]'.
  • A value the command does not take stops the CLI before the call and prints the ones that work.
  • A failed call prints Request id: <id>, which support asks for.
crawl and batch scrape answer with an id. Run status <id> until it is completed, and cancel <id> to stop. When status returns a next link, rerun it with --cursor. extract status <id> rereads a result for 24 hours. See Read a crawl. stophy parsers [word] lists the parsers scrape --parser takes. If the output ends with a cursor, pass --parserOptions '{"cursor":"<cursor>"}' for the next page. See Pre-built parsers. The CLI has parse, agent, browser task, batch scrape and webhook secret, and no command for browser sessions or monitors. Call those over HTTP.

Commands

Set STOPHY_NO_UPDATE_CHECK=1 to turn off the new-version notice.