linkinator
Broken link checker that crawls websites and validates links. Find broken links, dead links, and invalid URLs in websites, documentation, and local files. Perfect for SEO audits and CI/CD.
File Explorer
Download Latest Version (.zip)- ci.yaml
- codeql.yml
- release.yaml
- pre-commit
- api.js
- linkinator.webp
- update-schema-org-types.ts
- cli.ts
- config.ts
- index.ts
- links.ts
- logger.ts
- options.ts
- queue.ts
- request.ts
- schema-org-url-fields.json
- server.ts
- stream-utils.ts
- index.html
- absolute.html
- empty-base.html
- relative-dot-folder.html
- relative-folder.html
- relative-page.html
- relative-to-root.html
- index.html
- index.html
- index.html
- index.html
- linkinator.config.cjs
- linkinator.config.invalid.json
- linkinator.config.js
- linkinator.config.json
- linkinator.config.mjs
- skip-array-config.json
- url-rewrite-expressions.json
- url-rewrite-expressions.mjs
- external-test.html
- index.html
- styles.css
- index.html
- linkinator.config.json
- dir1.md
- dir2.md
- README.md
- index.html
- index.html
- index.html
- target.html
- index.html
- target.html
- index.html
- index.html
- target.html
- index.html
- index.html
- target.md
- index.html
- target.md
- index.html
- index.html
- index.html
- index.html
- boo.jpg
- index.html
- index.html
- index.html
- page2.html
- README.md
- index.html
- deep.md
- boo.jpg
- LICENSE.md
- README.md
- unlinked.md
- guide.mdx
- LICENSE.md
- README.mdx
- index.html
- index.html
- index.html
- image.jpeg
- image.webp
- index.html
- index.html
- index.html
- first.html
- index.html
- second.html
- index.html
- nested.html
- index.html
- ohai.html
- pageA.html
- pageB.html
- index.html
- other.html
- index.html
- subpage.html
- index.html
- LICENSE.md
- README.md
- index.html
- script.js
- index.html
- bag.html
- index.html
- about.html
- contact.html
- index.html
- index.html
- script.js
- test.html
- index.html
- index.html
- bar.html
- foo.html
- index.html
- 200.html
- 403.html
- 404.html
- 5xx.html
- default.html
- pattern.html
- index.html
- index.html
- funky+path.html
- index.html
- self-signed-server.ts
- test.cert-validation.ts
- test.cli.ts
- test.concurrency.ts
- test.config.ts
- test.fragments.ts
- test.https.ts
- test.index.ts
- test.insecure.ts
- test.json-ld.ts
- test.proxy.ts
- test.queue.ts
- test.redirect-rewrites.ts
- test.redirects.ts
- test.retry.ts
- test.server.ts
- test.status-codes.ts
- test.stream-utils.ts
- .dockerignore
- .gitattributes
- .gitignore
- .release-please-manifest.json
- AGENTS.md
- biome.json
- CHANGELOG.md
- Dockerfile
- LICENSE.md
- package-lock.json
- package.json
- README.md
- release-please-config.json
- renovate.json
- SECURITY.md
- tsconfig.json
- vitest.config.ts
# Installation Guide
1. Get the code
git clone https://github.com/JustinBeckwith/linkinator
Downloads the entire project code from GitHub to your computer.
cd linkinator
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run ghcr.io/justinbeckwith/linkinator LOCATION [ --arguments ]
Runs the built image as an actual container.
docker run ghcr.io/justinbeckwith/linkinator:3.4.0 LOCATION [ --arguments ]
Runs the built image as an actual container.
docker run ghcr.io/justinbeckwith/linkinator https://jbeckwith.com
Runs the built image as an actual container.
docker run -v "$(pwd)":/usr/src/app -w /usr/src/app ghcr.io/justinbeckwith/linkinator . --recurse
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Node.js
EasyPrerequisites
npm install linkinator
Downloads and installs the libraries listed in package.json.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)