spicrawlspicrawlDocs

Install the CLI

Install the spicrawl binary with npm, npx or the install script, then verify, upgrade or remove it.

The CLI is one static binary named spicrawl for Linux, macOS and Windows on x64 and arm64. The fastest way to get it on any of them is npm:

npm install -g @spicrawl/cli

On Linux and macOS without Node.js, use the install script:

curl -fsSL https://spicrawl.com/install.sh | sh

Homebrew: not available yet; use npm or the install script.

Install

Run without installing:

npx @spicrawl/cli scrape https://example.com --format markdown

Or install globally:

npm install -g @spicrawl/cli

The @spicrawl/cli package installs the spicrawl command and needs Node.js 16 or later. It is one package that carries the prebuilt binaries for all six platforms (Linux, macOS and Windows on x64 and arm64); a small launcher picks the one for your OS and CPU and runs it with the same arguments, stdio and exit code. Ctrl-C reaches the binary, so an interrupted run exits 130 as it does without the launcher. There is no postinstall script and nothing is downloaded at install time. Set SPICRAWL_BINARY=/path/to/spicrawl (SPICRAWL_BINARY is also accepted) to point the launcher at a different binary.

Verify

spicrawl version
spicrawl auth status --offline

spicrawl version prints the release version. spicrawl auth status --offline confirms the binary runs and shows which key and base URL it would use, without calling the API. Drop --offline to also check the key; see authentication.

Upgrade

Installed withUpgrade
Install scriptRun the same curl ... | sh again. It replaces the binary atomically, so a running spicrawl is never half-written.
npmnpm install -g @spicrawl/cli@latest (npx @spicrawl/cli@latest for one-off runs)

Uninstall

rm "$(spicrawl config path | jq -r .path)"  # optional, first: the saved key
rm ~/.local/bin/spicrawl        # install script (or your SPICRAWL_INSTALL_DIR)
npm uninstall -g @spicrawl/cli   # npm

Removing the binary does not remove the config file that holds your saved key. Delete it first with rm "$(spicrawl config path | jq -r .path)" (inside $(...) stdout is not a terminal, so the command prints JSON), or remove it by hand: ~/.config/spicrawl/config.json on Linux, ~/Library/Application Support/spicrawl/config.json on macOS, %AppData%\spicrawl\config.json on Windows.

Next

Save a key with spicrawl login: see authentication.

Overview

The spicrawl command-line client scrapes, renders and extracts web pages, and prints JSON when piped so scripts and AI agents can use it directly.

Authentication

Save an API key with spicrawl login, inspect it with spicrawl auth status, edit the config file, and pass the key through the environment in CI.

On this page

InstallVerifyUpgradeUninstallNext