Skip to main content

Confirm

Are you sure?

Changelog · September 28, 2026

The urlpipe command-line tool

The API in your terminal and your CI, with nothing to write.

By · Last updated: September 2026

TL;DR

urlpipe is a command-line tool for every URLpipe operation. Install it with Homebrew, Scoop or go install, save your key with urlpipe login, and run urlpipe markdown, screenshot, meta, lighthouse and the rest. urlpipe console --fail-on-errors and urlpipe lighthouse --min-score exit 3 when they find a problem, so a deploy preview can fail a build.

Free plan, no credit card. 1,000 credits a month.

Results go to stdout and everything else to stderr, so urlpipe markdown example.com > page.md writes just the page. A screenshot is saved as a file named after the host, or written to stdout with -o -. -v shows the cache status, the cost and the credits left.

Two commands are made for CI: urlpipe console "$URL" --fail-on-errors fails on any console error or uncaught exception, and urlpipe lighthouse "$URL" --min-score 90 fails below a performance score. Both exit 3, apart from 1 for an API error and 2 for a usage error.

Get it

Install

One of these
# macOS and Linux (Homebrew)
brew install urlpipe/tap/urlpipe

# Windows (Scoop)
scoop bucket add urlpipe https://github.com/URLpipe/scoop-bucket
scoop install urlpipe

# Go
go install github.com/URLpipe/urlpipe-go/cmd/urlpipe@latest

FAQ

Frequently asked questions

Where does urlpipe keep my API key?
urlpipe login saves it to urlpipe/config.json in your user config directory, readable only by you. URLPIPE_API_KEY or --api-key take priority over it.
Can urlpipe fail a CI build?
Yes: console --fail-on-errors and lighthouse --min-score exit with code 3 when they find a problem.

Try it on the free plan.

Free plan, no card. Confirm your email and your API key is live — you'll be making real requests in minutes.