w
Broken Link Checker
Verified@wanng-ide
npx machina-cli add skill @wanng-ide/broken-link-checker --openclawFiles (1)
SKILL.md
546 B
Broken Link Checker
Verify external URLs for availability. Useful for checking documentation links or external references.
Usage
node skills/broken-link-checker/index.js <url1> [url2...]
Output
JSON array of results:
[
{
"url": "https://example.com",
"valid": true,
"status": 200
},
{
"url": "https://example.com/broken",
"valid": false,
"status": 404
}
]
Overview
Broken Link Checker verifies external URLs for availability by checking HTTP status codes in the 200–399 range. It helps ensure documentation links and references stay accessible.
How This Skill Works
Run the CLI with one or more URLs (e.g., node skills/broken-link-checker/index.js <url1> [url2...]). For each URL, the tool performs an HTTP request and returns a JSON array where each item contains the url, a valid flag, and the status code.
When to Use It
- After publishing docs to ensure external links are reachable
- During CI/CD to catch broken references before release
- During website audits or content reviews
- When migrating sites and validating old references
- For QA checks on guides and tutorials that rely on external resources
Quick Start
- Step 1: Install or run the CLI (e.g., node skills/broken-link-checker/index.js <url1> [url2...])
- Step 2: Provide one or more URLs to check as command-line arguments
- Step 3: Inspect the JSON output (array of {url, valid, status}) and fix any broken links
Best Practices
- Run checks on all newly added external links
- Treat 4xx/5xx responses as broken and flag for review; 200–399 are considered valid
- Run checks in parallel to speed up results
- Log results to a central report and assign fixes to content owners
- Set timeouts to avoid hanging on slow or non-responsive hosts
Example Use Cases
- CI pipeline step that validates external references after a docs build
- Content audit to identify and fix broken links in product guides
- Website migration QA to ensure external resources still load
- Documentation refresh verifying references in API docs
- Marketing blog audit to confirm all outbound links work
Frequently Asked Questions
Add this skill to your agents