[{"data":1,"prerenderedAt":570},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fgetting-started":3,"docs-sib-\u002Fdocs\u002Fgetting-started":481,"docs-nav":544},{"id":4,"title":5,"body":6,"description":471,"extension":472,"meta":473,"navigation":474,"order":475,"path":476,"section":477,"seo":478,"stem":479,"__hash__":480},"docs\u002Fdocs\u002Fgetting-started.md","Getting started",{"type":7,"value":8,"toc":461},"minimark",[9,14,18,21,44,50,54,124,127,131,134,224,238,318,322,325,375,391,395,402,417,421],[10,11,13],"h2",{"id":12},"what-crawlstat-is","What CrawlStat is",[15,16,17],"p",{},"CrawlStat is a desktop SEO crawler. You give it a website and it works through the site the way a search engine would. It follows links, records what each URL returns, and reads each page's titles, descriptions, headings, canonicals, hreflang, structured data, images and links. When the crawl finishes, it runs 45 audits over everything it found and gives you a list of problems, each with an explanation and a fix.",[15,19,20],{},"It runs on macOS, Windows and Linux. Everything happens on your own computer:",[22,23,24,32,38],"ul",{},[25,26,27,31],"li",{},[28,29,30],"strong",{},"Your crawl data stays local."," Each crawl is saved as a single file on your disk. Nothing about the sites you crawl is uploaded anywhere.",[25,33,34,37],{},[28,35,36],{},"It is polite by default."," CrawlStat respects robots.txt, identifies itself honestly, and keeps the number of simultaneous requests modest.",[25,39,40,43],{},[28,41,42],{},"It handles big sites."," Crawl data goes to disk rather than memory, so a large crawl doesn't slow your machine down. An interrupted crawl can pick up where it stopped.",[45,46],"screenshot",{"alt":47,"caption":48,"src":49},"The Projects screen with one row per site: health, response breakdown, crawl history, pages crawled and issue counts","Every site you’ve crawled, one row each. Health, history and what’s left in the queue, all at a glance.","\u002Fscreenshots\u002Fprojects-list.png",[10,51,53],{"id":52},"quick-start","Quick start",[55,56,57],"steps",{},[58,59,60,77,105,115],"ol",{},[25,61,62,65,66,71,72,76],{},[28,63,64],{},"Install CrawlStat."," Download the build for your operating system from ",[67,68,70],"a",{"href":69},"\u002Fdownload","the downloads page"," and install it. See ",[67,73,75],{"href":74},"\u002Fdocs\u002Finstalling","Installing CrawlStat"," if you need help for your platform.",[25,78,79,82,83,86,87,90,91,95,96,100,101,104],{},[28,80,81],{},"Start a crawl."," Click ",[28,84,85],{},"New crawl",", the ",[28,88,89],{},"+"," at the top of the sidebar (or press ",[92,93,94],"kbd",{},"⌘N"," on macOS). Type the site's address, for example ",[97,98,99],"code",{},"example.com",", and click ",[28,102,103],{},"Start crawl",".",[25,106,107,110,111,114],{},[28,108,109],{},"Read the issues."," When the crawl finishes, CrawlStat runs its audits automatically. Open the crawl's ",[28,112,113],{},"Issues"," tab to see what it found, ranked within errors, warnings and notices, each with a \"How to fix\" note.",[25,116,117,82,120,123],{},[28,118,119],{},"Share it.",[28,121,122],{},"Export a client report"," in the crawl's header for a branded PDF you can send as it is.",[15,125,126],{},"That's all you need for a first look. The rest of this guide covers each step in more detail.",[10,128,130],{"id":129},"finding-your-way-around","Finding your way around",[15,132,133],{},"The sidebar on the left holds the things that aren't about one crawl:",[135,136,137,150],"table",{},[138,139,140],"thead",{},[141,142,143,147],"tr",{},[144,145,146],"th",{},"Item",[144,148,149],{},"What it's for",[151,152,153,164,175,188,201,214],"tbody",{},[141,154,155,161],{},[156,157,158],"td",{},[28,159,160],{},"Projects",[156,162,163],{},"Every crawl you've run, as cards or one row per site, with health, history and issue counts. Open, recrawl, compare, resume or delete crawls here.",[141,165,166,172],{},[156,167,168],{},[169,170,171],"em",{},"The live crawl",[156,173,174],{},"Only while a crawl runs: its site, progress and a Live or Paused badge. Click it to get back to the crawl.",[141,176,177,182],{},[156,178,179],{},[28,180,181],{},"Accessibility",[156,183,184,185,104],{},"Check pages against WCAG. See ",[67,186,181],{"href":187},"\u002Fdocs\u002Faccessibility",[141,189,190,195],{},[156,191,192],{},[28,193,194],{},"Competitor Intelligence",[156,196,197,198,104],{},"Compare your site with up to five competitors: what they cover that you don't, a content plan, and AI search readiness. See ",[67,199,194],{"href":200},"\u002Fdocs\u002Fcompetitor-intelligence",[141,202,203,208],{},[156,204,205],{},[28,206,207],{},"UX Testing",[156,209,210,211,104],{},"Test a page against what it's for. See ",[67,212,207],{"href":213},"\u002Fdocs\u002Fux-testing",[141,215,216,221],{},[156,217,218],{},[28,219,220],{},"Settings",[156,222,223],{},"Defaults for new crawls, the theme and colour, and where your files are kept.",[15,225,226,227,229,230,233,234,237],{},"Everything about one crawl lives on that crawl's own page, which you open from Projects. Its header says which crawl it is and has ",[28,228,122],{},", ",[28,231,232],{},"Compare"," and ",[28,235,236],{},"Recrawl",". Its tabs are:",[135,239,240,249],{},[138,241,242],{},[141,243,244,247],{},[144,245,246],{},"Tab",[144,248,149],{},[151,250,251,261,270,280,290,300,309],{},[141,252,253,258],{},[156,254,255],{},[28,256,257],{},"Overview",[156,259,260],{},"The live view while the crawl runs; afterwards, its health, headline figures and top issues.",[141,262,263,267],{},[156,264,265],{},[28,266,113],{},[156,268,269],{},"The audit findings, ranked, with why each one ranks where it does and the pages it affects.",[141,271,272,277],{},[156,273,274],{},[28,275,276],{},"Pages",[156,278,279],{},"Every URL in the crawl, in a sortable, filterable table with eleven tabs and quick lenses.",[141,281,282,287],{},[156,283,284],{},[28,285,286],{},"Plan",[156,288,289],{},"What to fix first, and a written report.",[141,291,292,297],{},[156,293,294],{},[28,295,296],{},"Visualise",[156,298,299],{},"How the site is structured and linked.",[141,301,302,306],{},[156,303,304],{},[28,305,207],{},[156,307,308],{},"Testing the crawl's pages for the people who use them.",[141,310,311,315],{},[156,312,313],{},[28,314,181],{},[156,316,317],{},"The crawl against WCAG 2.1 AA.",[10,319,321],{"id":320},"what-crawlstat-checks","What CrawlStat checks",[15,323,324],{},"The 45 audits cover the things that usually go wrong on a website:",[22,326,327,333,339,345,351,357,363,369],{},[25,328,329,332],{},[28,330,331],{},"Responses:"," server errors, broken pages, fetch failures, redirect chains and loops, and slow responses.",[25,334,335,338],{},[28,336,337],{},"Links:"," broken internal links, links that point at redirects, orphan pages, and pages buried deep in the site.",[25,340,341,344],{},[28,342,343],{},"On the page:"," missing, duplicate, too long or too short titles and meta descriptions; missing or multiple H1s.",[25,346,347,350],{},[28,348,349],{},"Indexing:"," noindex pages, pages blocked by robots.txt, canonical problems, and hreflang errors.",[25,352,353,356],{},[28,354,355],{},"Content:"," exact and near duplicate pages.",[25,358,359,362],{},[28,360,361],{},"Images:"," missing alt text and oversized files.",[25,364,365,368],{},[28,366,367],{},"Security:"," mixed content and HTTP links on HTTPS sites.",[25,370,371,374],{},[28,372,373],{},"Accessibility:"," links and buttons without accessible names, unlabelled form fields, broken ARIA references, missing page language, and more.",[15,376,377,378,381,382,386,387,104],{},"Each audit has its own page under ",[97,379,380],{},"\u002Fdocs\u002Faudits\u002F",", with the same explanation and fix that you see in the app. For example, see ",[67,383,385],{"href":384},"\u002Fdocs\u002Faudits\u002Fbroken-internal-links","Broken internal links"," or ",[67,388,390],{"href":389},"\u002Fdocs\u002Faudits\u002Fduplicate-page-titles","Duplicate page titles",[10,392,394],{"id":393},"free-and-open-source","Free and open source",[15,396,397,398,104],{},"CrawlStat is free and open source, under the MIT licence. Every feature is included: unlimited URLs, every audit, JavaScript rendering, client reports, CSV export, UX Testing, crawl comparison and Competitor Intelligence. There's no account and no key. See ",[67,399,401],{"href":400},"\u002Fdocs\u002Flicensing","Open source and licence",[403,404,406],"callout",{"type":405},"note",[15,407,408,409,412,413,104],{},"By default CrawlStat reads the HTML the server sends, which is also the first thing a search engine sees. For sites that build their pages in the browser, turn on ",[28,410,411],{},"Render JavaScript"," when you start the crawl. See ",[67,414,416],{"href":415},"\u002Fdocs\u002Fyour-first-crawl#render-javascript","Your first crawl",[10,418,420],{"id":419},"where-to-go-next","Where to go next",[22,422,423,429,436,443,449,456],{},[25,424,425,428],{},[67,426,416],{"href":427},"\u002Fdocs\u002Fyour-first-crawl",": every option in the New crawl dialog, explained.",[25,430,431,435],{},[67,432,434],{"href":433},"\u002Fdocs\u002Fwatching-a-crawl","Watching a crawl",": what the live counters mean.",[25,437,438,442],{},[67,439,441],{"href":440},"\u002Fdocs\u002Fresults-table","The Pages table",": finding your way through the data.",[25,444,445,448],{},[67,446,113],{"href":447},"\u002Fdocs\u002Fissues",": reading and acting on audit findings.",[25,450,451,455],{},[67,452,454],{"href":453},"\u002Fdocs\u002Fclient-reports","Client reports",": sending it all to a client.",[25,457,458,460],{},[67,459,194],{"href":200},": seeing what your competitors cover that you don't.",{"title":462,"searchDepth":463,"depth":463,"links":464},"",2,[465,466,467,468,469,470],{"id":12,"depth":463,"text":13},{"id":52,"depth":463,"text":53},{"id":129,"depth":463,"text":130},{"id":320,"depth":463,"text":321},{"id":393,"depth":463,"text":394},{"id":419,"depth":463,"text":420},"What CrawlStat is, what it does on your machine, and how to go from a fresh install to your first list of issues in a few minutes.","md",{},true,1,"\u002Fdocs\u002Fgetting-started","Start here",{"title":5,"description":471},"docs\u002Fgetting-started","diWu8lsnU7tyerox5xiWJIlXnJv5Y3aKMKfraSBvdHk",[482,484,486,487,488,490,492,494,496,500,504,506,508,512,515,518,522,524,528,532,536,540],{"title":454,"path":453,"order":483},null,{"title":485,"path":213,"order":483},"UX testing",{"title":5,"path":476,"order":475},{"title":75,"path":74,"order":463},{"title":416,"path":427,"order":489},3,{"title":434,"path":433,"order":491},4,{"title":441,"path":440,"order":493},5,{"title":113,"path":447,"order":495},6,{"title":497,"path":498,"order":499},"The plan","\u002Fdocs\u002Fthe-plan",7,{"title":501,"path":502,"order":503},"Journeys","\u002Fdocs\u002Fjourneys",8,{"title":194,"path":200,"order":505},8.7,{"title":181,"path":187,"order":507},9,{"title":509,"path":510,"order":511},"Comparing crawls","\u002Fdocs\u002Fcomparing-crawls",10,{"title":160,"path":513,"order":514},"\u002Fdocs\u002Fprojects",11,{"title":220,"path":516,"order":517},"\u002Fdocs\u002Fsettings",12,{"title":519,"path":520,"order":521},"Keyboard shortcuts","\u002Fdocs\u002Fkeyboard-shortcuts",13,{"title":401,"path":400,"order":523},14,{"title":525,"path":526,"order":527},"Privacy and your data","\u002Fdocs\u002Fprivacy-and-data",15,{"title":529,"path":530,"order":531},"The crawler and robots.txt","\u002Fdocs\u002Fcrawler-and-robots",16,{"title":533,"path":534,"order":535},"Local AI","\u002Fdocs\u002Flocal-ai",17,{"title":537,"path":538,"order":539},"Troubleshooting","\u002Fdocs\u002Ftroubleshooting",18,{"title":541,"path":542,"order":543},"FAQ","\u002Fdocs\u002Ffaq",19,[545,546,547,548,549,550,552,553,554,555,556,557,558,559,560,561,562,564,565,566,567,569],{"title":454,"path":453,"section":483,"order":483},{"title":485,"path":213,"section":483,"order":483},{"title":5,"path":476,"section":477,"order":475},{"title":75,"path":74,"section":477,"order":463},{"title":416,"path":427,"section":477,"order":489},{"title":434,"path":433,"section":551,"order":491},"Using CrawlStat",{"title":441,"path":440,"section":551,"order":493},{"title":113,"path":447,"section":551,"order":495},{"title":497,"path":498,"section":551,"order":499},{"title":501,"path":502,"section":551,"order":503},{"title":194,"path":200,"section":551,"order":505},{"title":181,"path":187,"section":551,"order":507},{"title":509,"path":510,"section":551,"order":511},{"title":160,"path":513,"section":551,"order":514},{"title":220,"path":516,"section":551,"order":517},{"title":519,"path":520,"section":551,"order":521},{"title":401,"path":400,"section":563,"order":523},"Account & data",{"title":525,"path":526,"section":563,"order":527},{"title":529,"path":530,"section":563,"order":531},{"title":533,"path":534,"section":563,"order":535},{"title":537,"path":538,"section":568,"order":539},"Help",{"title":541,"path":542,"section":568,"order":543},1793827598186]