Getting started

Consuela walks a site from one start URL, records what it finds in SQLite, and audits the result. It ships as a desktop app, a standalone CLI, a hosted cloud tier, and a REST API.

Install

curl -fsSL https://consuela.io/install.sh | sh

This downloads the CLI binary for your platform, places it in ~/.local/bin, and adds it to your PATH. Consuela also ships as a desktop app for macOS, Windows and Linux with a GUI, auto-updates, and analysis panels beyond what the CLI reports.

Your first pass

The fastest way to see what Consuela does is to point it at a site. In the desktop app, paste a URL into the address bar and press Enter. From the CLI:

consuela https://example.com

By default a crawl stops at 500 URLs (CLI) or 10,000 (desktop) and keeps nothing on disk. Pass --db on the CLI or enable Store HTML in the desktop config panel to persist results.

# keep the results, and go wider than the default
consuela https://example.com --db example.db --max-urls 20000

# stay off a client's server
consuela https://example.com --concurrency 2 --rate 1

Robots rules are respected unless you pass --no-robots, and the per-host rate limit you set is never exceeded. You are responsible for not knocking over a client's server.

What it checks

Every crawled page is evaluated against 17 issue rules covering response codes, page titles, meta descriptions, H1 tags, canonicals, content depth, response time, and page size. Each rule carries a severity — critical, warning, or notice — and the results table, CLI output, and API all use the same set. See the issue rules reference for the full list.

The desktop app goes further with analysis panels for duplicate detection, redirect chains, broken links, structured data validation, Core Web Vitals, accessibility, TLS certificates, internal link graph, and more.

Where to go next

Pick the surface that fits how you work: