Installation

The recommended way to use Crawlith is by installing it globally. This makes the crawlith command available directly in your terminal.

Global Installation

Install Crawlith globally using your preferred package manager:

npm install -g crawlith

pnpm add -g crawlith

bun add -g crawlith

Verify Installation

Once installed, you can run the binary directly:

crawlith --version

Update Notifications

Crawlith includes a built-in update notifier. When a new version is published to npm, the CLI will automatically notify you in the terminal with instructions on how to upgrade, ensuring you always have the latest features and bug fixes.

Running without Installation (On-demand)

If you prefer not to install the binary globally, you can use these on-demand runners:

npx crawlith crawl https://example.com

pnpm dlx crawlith crawl https://example.com

bunx crawlith crawl https://example.com