{"id":13500416,"url":"https://github.com/ellisonleao/vl","last_synced_at":"2025-05-01T08:36:51.479Z","repository":{"id":50121416,"uuid":"343764956","full_name":"ellisonleao/vl","owner":"ellisonleao","description":"CLI tool that helps verify current status of URIs in text files","archived":false,"fork":false,"pushed_at":"2024-06-24T22:07:20.000Z","size":39,"stargazers_count":27,"open_issues_count":5,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-26T07:45:40.692Z","etag":null,"topics":["cli","go","golang","url","validation"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ellisonleao.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}},"created_at":"2021-03-02T12:21:37.000Z","updated_at":"2024-10-09T22:04:50.000Z","dependencies_parsed_at":"2023-02-16T23:31:23.946Z","dependency_job_id":null,"html_url":"https://github.com/ellisonleao/vl","commit_stats":null,"previous_names":["npxbr/verify-links"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellisonleao%2Fvl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellisonleao%2Fvl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellisonleao%2Fvl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellisonleao%2Fvl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ellisonleao","download_url":"https://codeload.github.com/ellisonleao/vl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251848601,"owners_count":21653719,"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":["cli","go","golang","url","validation"],"created_at":"2024-07-31T22:00:59.882Z","updated_at":"2025-05-01T08:36:51.431Z","avatar_url":"https://github.com/ellisonleao.png","language":"Go","funding_links":[],"categories":["Go","Applications"],"sub_categories":["Directory Navigation"],"readme":"# verify-links\n\nCLI tool that helps verify current status of URIs in text files\n\n# Table of Contents\n\n- [Prerequisites](#prerequisites)\n- [Installing](#installing)\n- [Usage](#usage)\n  - [Common usage](#common-usage)\n  - [Flags](#flags)\n  - [Running with docker](#running-with-docker)\n- [Screenshots](#screenshots)\n  - [Terminal output](#terminal-output)\n  - [Github Action](#github-action)\n- [Running in a Github Action](#running-in-a-github-action)\n\n# Prerequisites\n\n- Golang 1.16\n\n# Installing\n\n```\ngo install github.com/ellisonleao/vl/cmd/vl@latest\n```\n\n# Usage\n\n## Common usage\n\n```\n$ vl FILE\n```\n\n## Flags\n\n```\n-a (Skip status codes list)\n```\n\nExample:\n\n```sh\n$ vl README.md -a 500,404\n```\n\nAll `500` and `404` errors will be ignored and not considered as errors\n\n```\n-t (timeout for each request)\n```\n\nExample:\n\n```sh\n$ vl README.md -t 30s\n```\n\nEach request that takes more than 30s will be considered as an error. The values\naccepted must be under the durations values. Some examples\n[here](https://golang.org/pkg/time/#ParseDuration)\n\n```\n-w Whitelist URIs\n```\n\nExample:\n\n```sh\n$ vl README.md -w server1.com,server2.com\n```\n\nAdds a list of whitelisted links that shouldn't be verified. Links must be exactly\npassed as they are in the text file\n\n## Running with docker\n\n```\n$ docker run -it --rm -v $PWD:/vl ellisonleao/vl /vl/yourfile.md\n```\n\n# Screenshots\n\n## Terminal output\n\n_terminal colors are only working in linux_\n\n![](https://i.postimg.cc/xqD8YDfz/Screenshot-from-2021-03-18-17-42-31.png)\n\n## Github Action\n\n![](https://i.postimg.cc/VNpd4bxg/Screenshot-from-2021-03-18-18-29-21.png)\n\n# Running in a Github Action\n\nAn example of a workflow file:\n\n```yaml\n---\nname: CI\non: [push, pull_request]\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/setup-go@v3\n        id: go\n        with:\n          go-version: '\u003e=1.17.0'\n\n      - uses: actions/checkout@v3\n\n      - run: go install github.com/ellisonleao/vl/cmd/vl@latest\n      - run: vl README.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fellisonleao%2Fvl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fellisonleao%2Fvl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fellisonleao%2Fvl/lists"}