Open source

Help make CrawlStat better.

CrawlStat is free and MIT licensed. You can help by testing it, reporting bugs, writing code or making the docs clearer. Every bit counts, and you don’t need to be an expert.

01 · Test it

Use it like you mean it.

The best tests come from real sites and real work. Try CrawlStat on a project you care about and tell us where it surprised you, good or bad. We especially need people on macOS and Windows, where the installers are not out yet.

Please only crawl sites you own, or have permission to test.

Worth trying
  1. 1Install it, or build it on macOS or Windows, and tell us if anything feels off.
  2. 2Crawl a site you own. Then try a bigger one, and see how it copes.
  3. 3Run Competitor Intelligence against your real competitors. Do the gaps make sense?
  4. 4Point UX testing at a landing page you know well. Do you agree with what it found?
  5. 5Turn on JavaScript rendering for a site built with React or Vue.
  6. 6Export a client report and read it like your client would.
  7. 7Fix something, crawl again, and compare the two crawls.
02 · Report a bug

Tell us what broke.

Open an issue on GitHub. A short, clear report is better than a long one. If you are not sure it is a bug, open it anyway: a confusing screen is a bug too.

Please don’t attach crawls of sites you don’t own.

A good report has
  • The CrawlStat version (Settings, then About) and your platform.
  • What you did, what you expected, and what happened instead.
  • The smallest site or crawl file that shows the problem.
  • A screenshot, if it is something you can see.
03 · Write code

Rust inside, Flutter outside.

The engine does the work and the app shows the result, so the app, the command line and the MCP server always agree. Pick an open issue, or fix the thing that bugs you most.

How the code is laid out
engine/
The Rust crawler, the audits and the command line. All the logic lives here.
app/
The Flutter desktop app. It shows what the engine returns, nothing more.
app/rust/
The small bridge that lets the app talk to the engine.
# get the code
$ git clone https://github.com/clotairedamy/CrawlStat
$ cd CrawlStat

# before a pull request
$ cargo test
$ cargo clippy
$ cd app
$ flutter analyze
$ flutter test
Be honest about what is measuredEvery estimate says it is one, and every finding links to its evidence.
Local firstNo crawl data leaves the machine unless the user sets it up and asks.
Polite crawlingFollow robots.txt and pace every request.
Simple over cleverPlain code that the next person can read.
04 · Improve the docs

This website is open too.

The help pages and blog are plain Markdown files. If a page confused you, it will confuse someone else. Fix a sentence, add an example, or write the guide you wish you had found.

Not ready to dive in?

Star the project on GitHub, or tell a friend who works on websites. More people using CrawlStat means more people making it better.