{"id":14008167,"url":"https://github.com/bmuschko/link-verifier","last_synced_at":"2025-07-14T12:35:20.116Z","repository":{"id":57544181,"uuid":"93285181","full_name":"bmuschko/link-verifier","owner":"bmuschko","description":"A tool for verifying links in text-based files","archived":false,"fork":false,"pushed_at":"2024-08-17T20:52:24.000Z","size":154,"stargazers_count":27,"open_issues_count":3,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T07:34:51.122Z","etag":null,"topics":["asciidoc","checker","go","golang","link","markdown","verification"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bmuschko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-04T02:24:19.000Z","updated_at":"2024-08-17T20:52:28.000Z","dependencies_parsed_at":"2024-11-05T20:45:12.631Z","dependency_job_id":null,"html_url":"https://github.com/bmuschko/link-verifier","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/bmuschko/link-verifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Flink-verifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Flink-verifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Flink-verifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Flink-verifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bmuschko","download_url":"https://codeload.github.com/bmuschko/link-verifier/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Flink-verifier/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265292783,"owners_count":23742148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","checker","go","golang","link","markdown","verification"],"created_at":"2024-08-10T11:01:20.766Z","updated_at":"2025-07-14T12:35:20.093Z","avatar_url":"https://github.com/bmuschko.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Link Verifier [![Build and Publish](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml/badge.svg)](https://github.com/bmuschko/link-verifier/actions/workflows/build-publish.yml)\n\nA tool for verifying links in text-based files. Written in Go, available as executable.\n\n![Logo](https://user-images.githubusercontent.com/440872/27007990-1184b292-4e34-11e7-8417-fc62542250b5.jpg)\n\n## Motivation\n\nAmbitious tech writers use plain-text mark-up formats like [AsciiDoc](http://asciidoc.org/) and\n[Markdown](https://daringfireball.net/projects/markdown/) for turning text into properly formatted blog posts, web\npages and documentation. Incorporating URLs to refer to external resources is part of the process. Before publishing\ncontent it's important to verify that linked URLs are valid and can be resolved. Nothing feels more unprofessional than broken\nlinks in a carefully crafted document.\n\nLink verifier to the rescue! Automatically discover all mark-up files in a given directory and verify all links\nfound in the documents before publishing them.\n\n## Installation\n\n### Prebuilt libraries\n\n[Prebuilt libraries for various platforms](https://github.com/bmuschko/link-verifier/releases) are available on GitHub.\nJust download, exact the archive and execute the binary.\n\n### Building from source\n\nBuilding from source requires that you have [Go](https://golang.org/doc/install) installed on your machine.\n\n```\n$ go get -u -v github.com/bmuschko/link-verifier\n```\n\nRun the program with `link-verifier` from anywhere in the file system.\n\n## Command line options\n\n| Option                | Description | Default Value |\n| --------------------- | ----------- | ------------- |\n| `dirs`                | The comma-separated root directories used to recursively search for files. | [.] |\n| `includes`            | The comma-separated include patterns used to search for files. | [\\*.md,*.adoc] |\n| `ignore-status-codes` | The comma-separated HTTP response status codes that will be ignored for validation. For example, some sites block crawlers and return with a specific response code. | [] |\n| `fail`                | Fails the program if at least one discovered link cannot be resolved. | true |\n| `timeout`             | The timeout in seconds used when calling the URL. | 5 |\n\n**Example**:\n\n```\n$ link-verifier --dirs data,content --include *.html,*.yml --fail=false\n```\n\n## Usage on CI\n\nIntegrating the tool with a build on CI is a breeze and can used as validation step before publishing mark-up files.\n\n## GitHub Actions\n\nThe following `.github/workflows/verify-links.yml` demonstrate the use of the prebuilt binary version on Linux 64 bit:\n\n``` yaml\n- name: Verify Links\n  run: |\n    wget https://github.com/bmuschko/link-verifier/releases/download/v0.1/link-verifier-0.1-linux64.tar.gz -O /tmp/link-verifier.tar.gz\n    tar -xvf /tmp/link-verifier.tar.gz\n    export PATH=$PATH:$PWD/link-verifier/\n    ./link-verifier\n```\n\n## Contribute!\n\nIt's easy to contribute to this project. Install link:https://golang.org/doc/install[Go] \u003e= 1.11. Then run the following commands to get the source code, resolve external dependencies\nand build the project.\n\n```\n$ git clone https://github.com/bmuschko/link-verifier.git\n$ cd link-verifier\n$ go build\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmuschko%2Flink-verifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbmuschko%2Flink-verifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmuschko%2Flink-verifier/lists"}