{"id":16972364,"url":"https://github.com/bhupesh-v/areyouok","last_synced_at":"2025-03-22T14:31:29.689Z","repository":{"id":37393024,"uuid":"327221172","full_name":"Bhupesh-V/areyouok","owner":"Bhupesh-V","description":"A fast and easy to use URL health checker ⛑️ Keep your links healthy during tough times (Out of box support for GitHub Actions)","archived":false,"fork":false,"pushed_at":"2022-07-04T18:05:44.000Z","size":4271,"stargazers_count":34,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T12:02:05.475Z","etag":null,"topics":["actions","automation","blogging","linkchecker","monitoring","tech-blogger","url","url-health","url-health-checker"],"latest_commit_sha":null,"homepage":"https://bhupesh.me/areyouok-keep-your-urls-healthy-github-actions-golang/","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/Bhupesh-V.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"open_collective":null,"ko_fi":"bhupesh","tidelift":null,"community_bridge":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/BhupeshVarshney"]}},"created_at":"2021-01-06T06:28:16.000Z","updated_at":"2024-12-05T17:09:04.000Z","dependencies_parsed_at":"2022-07-12T22:30:30.798Z","dependency_job_id":null,"html_url":"https://github.com/Bhupesh-V/areyouok","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhupesh-V%2Fareyouok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhupesh-V%2Fareyouok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhupesh-V%2Fareyouok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bhupesh-V%2Fareyouok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bhupesh-V","download_url":"https://codeload.github.com/Bhupesh-V/areyouok/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244972005,"owners_count":20540906,"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":["actions","automation","blogging","linkchecker","monitoring","tech-blogger","url","url-health","url-health-checker"],"created_at":"2024-10-14T00:59:02.577Z","updated_at":"2025-03-22T14:31:29.414Z","avatar_url":"https://github.com/Bhupesh-V.png","language":"Go","funding_links":["https://ko-fi.com/bhupesh","https://paypal.me/BhupeshVarshney","https://liberapay.com/bhupesh/donate"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eAreYouOK?\u003c/h1\u003e\n\n\u003cblockquote align=\"center\"\u003eA minimal, fast \u0026 easy to use URL health checker\u003c/blockquote\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg align=\"center\" alt=\"cat areyouok logo\" height=\"100px\" src=\"https://user-images.githubusercontent.com/34342551/103980534-0da0e000-51a6-11eb-8e67-f4c41599ce1e.png\" /\u003e\n  \u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"https://goreportcard.com/report/github.com/Bhupesh-V/areyouok\"\u003e\n    \u003cimg alt=\"Go report card\" src=\"https://goreportcard.com/badge/github.com/Bhupesh-V/areyouok\" target=\"_blank\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Bhupesh-V/areyouok/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/Bhupesh-V/areyouok?color=blue\" target=\"_blank\"\u003e\n  \u003c/a\u003e\n  \u003cimg alt=\"GitHub all releases\" src=\"https://img.shields.io/github/downloads/bhupesh-v/areyouok/total?color=purple\"\u003e\n  \u003ca href=\"\"\u003e\n    \u003cimg alt=\"CodeQL Analysis\" src=\"https://github.com/Bhupesh-V/areyouok/workflows/CodeQL%20Analysis/badge.svg?branch=master\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/bhupeshimself\"\u003e\n    \u003cimg alt=\"Twitter: bhupeshimself\" src=\"https://img.shields.io/twitter/follow/bhupeshimself.svg?style=social\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003cimg alt=\"areyouok-v1.0.0-demo\" title=\"areyouok-v1.0.0-demo\" src=\"https://user-images.githubusercontent.com/34342551/105573121-5a2d1380-5d81-11eb-8ae9-baf6d3d50e3a.gif\"\u003e\n\u003c/p\u003e\n\n## Who is `AreYouOk` made for ?\n\n- **OSS Package Maintainers** 📦️:\u003cbr\u003e\n  With packages comes documentation which needs to be constantly updated \u0026 checked for dead/non-functioning URLs.\n- **Tech Bloggers** ✍️ :\u003cbr\u003e\n  If you are someone who writes countless tutorials \u0026 owns the source for your website, Use areyouok to make sure your blogs don't contain any non-functioning URLs.\n- Literally anyone who wants to check a bunch of URLs for being dead ☠️  or not, SEO experts? \n\nWith time _AreYouOk_ can evolve to analyze URLs over a remote resource as well, send your ideas ✨️ through [**Discussions**](https://github.com/Bhupesh-V/areyouok/discussions)\n\n## Installation\n\n- Linux\n  ```bash\n  curl -LJO https://github.com/Bhupesh-V/areyouok/releases/latest/download/areyouok-linux-amd64\n  ```\n\n- MacOS\n  ```bash\n  curl -LJO https://github.com/Bhupesh-V/areyouok/releases/latest/download/areyouok-darwin-amd64\n  ```\n\n- Windows\n  ```bash\n  curl -LJO https://github.com/Bhupesh-V/areyouok/releases/latest/download/areyouok-windows-amd64.exe\n  ```\n\nCheck installation by running `areyouok -v`\n```bash\n$ mv areyouok-darwin-amd64 areyouok\n$ areyouok -v\nv1.0.0\n```\n\nDownload builds for other architectures from [**releases**](https://github.com/Bhupesh-V/areyouok/releases/latest)\n\n\n## Usage\n\nAreYouOk provides 3 optional arguments followed by a directory path (default: current directory)\n1. `-t` type of files to scan for links\n2. `-i` list of files or directories to ignore for links (node_modules, .git)\n3. `-r` type of report to generate\n\nSome example usages:\n\n- Analyze all HTML files for hyperlinks. The default directory path is set to current directory.\n  ```bash\n  areyouok -t=html Documents/my-directory\n  ```\n  There is not limitation on file type, to analyze json files use `-t=json`. The default type is set to `md` (markdown)\n\n- To ignore certain directories or file-types use the ignore `-i` flag.\n  ```bash\n  areyouok -i=_layouts,.git,_site,README.md,build.py,USAGE.md\n  ```\n\n- By default AreYouOk outputs analyzed data directly into console. To generate a report, use the `-r` flag\n  ```bash\n  areyouok -i=_layouts,.git,_site,README.md,build.py,USAGE.md -r=html ~/Documents/til/\n  ```\n  Currently supported report formats are: `json`, `txt`, `html` \u0026 `github`.\n\n  Different report types provide different levels of information which is briefly summarized below:\n  1. **JSON** (report.json)\u003cbr\u003e\n     The JSON report can be used for other computational tasks as required (E.g emailing dead urls to yourself)\n     ```json\n     {\n        \"http://127.0.0.1:8000/\": {\n                \"code\": \"\",\n                \"message\": \"Get \\\"http://127.0.0.1:8000/\\\": dial tcp 127.0.0.1:8000: connect: connection refused\",\n                \"response_time\": \"\"\n        },\n        \"http://freecodecamp.org\": {\n                \"code\": \"200\",\n                \"message\": \"OK\",\n                \"response_time\": \"5.44s\"\n        },\n        \"http://ogp.me/\": {\n                \"code\": \"200\",\n                \"message\": \"OK\",\n                \"response_time\": \"3.60s\"\n        },\n        \"http://prnbs.github.io/projects/regular-expression-parser/\": {\n                \"code\": \"200\",\n                \"message\": \"OK\",\n                \"response_time\": \"0.25s\"\n        },\n        \"https://bhupeshv.me/30-Seconds-of-C++/\": {\n                \"code\": \"404\",\n                \"message\": \"Not Found\",\n                \"response_time\": \"3.84s\"\n        },\n        ...\n     }\n     ```\n\n  2. **Text** (report.txt)\u003cbr\u003e\n     The text format just lists the URLs which were not successfully fetched. Useful if you just want dead urls.\n     Text report also puts the no.of hyperlinks analyzed along with total files \u0026 total reponse time.\n\n     ```\n     74 URLs were analyzed across 31 files in 21.69s\n\n     Following URLs are not OK:\n\n     http://freecodecamp.org`\n     http://127.0.0.1:8000/\n     https://drive.google.com/uc?export=view\u0026id=\u003cINSERT-ID\u003e`\n     https://drive.google.com/file/d/\n     https://drive.google.com/uc?export=view\u0026id=$get_last\n     https://github.com/codeclassroom/PlagCheck/blob/master/docs/docs.md\n     https://bhupeshv.me/30-Seconds-of-C++/\n     ```\n     Note that the total time would vary according to your internet speed \u0026 website latency.\n\n  3. **HTML** (report.html)\u003cbr\u003e\n     The html report is the most superior formats of all \u0026 can be used to have a visual representaion of analyzed links.\u003cbr\u003e\n     Below is demo of how this HTML report looks like, [**you can see it live**]()\n     ![report-latest](https://user-images.githubusercontent.com/34342551/105046278-e80db380-5a8e-11eb-8371-124fae8b3d7f.png)\n\n  4. **GitHub** (report.github)\u003cbr\u003e\n     The github report format is well suited if you are utilizing Github Actions. The format generated is largely HTML, compatible with github's commonmark markdown renderer.\u003cbr\u003e\n     Below is a demo of a Github Action which reports the analyzed URLs through github issues. [Here is a demo link](https://github.com/Bhupesh-V/til/issues/2)\n     \n     ![demo-action](https://user-images.githubusercontent.com/34342551/105579706-169cce80-5dae-11eb-8dd6-b51bf23e63ee.png)\n     \n\n\n## Development\n\n#### Prerequisites\n\n- [Go 1.16](https://golang.org/dl/#unstable)\n\n1. Clone the repository.\n   ```bash\n   git https://github.com/Bhupesh-V/areyouok.git\n   ```\n2. Run tests.\n   ```bash\n   go test -v\n   ```\n3. Format \u0026 Lint the project.\n   ```bash\n   gofmt -w areyouok.go \u0026\u0026 golint areyouok.go\n   ```\n\n## Projects Using `AreYouOk`\n\n- [til](https://github.com/Bhupesh-V/til)\n- [+ Add Yours](https://github.com/Bhupesh-V/areyouok/fork)\n\n## 📝 Changelog\n\nSee the [CHANGELOG.md](CHANGELOG.md) file for details.\n\n## ☺️ Show your support\n\nSupport me by giving a ⭐️ if this project helped you! or just [![Twitter URL](https://img.shields.io/twitter/url?style=social\u0026url=https%3A%2F%2Fgithub.com%2FBhupesh-V%2Fareyouok%2F)](https://twitter.com/intent/tweet?url=https://github.com/Bhupesh-V/areyouok\u0026text=areyouok%20via%20@bhupeshimself)\n\n\u003ca href=\"https://liberapay.com/bhupesh/donate\"\u003e\n  \u003cimg alt=\"Donate using Liberapay\" src=\"https://liberapay.com/assets/widgets/donate.svg\" width=\"100\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://ko-fi.com/bhupesh\"\u003e\n  \u003cimg title=\"ko-fi/bhupesh\" alt=\"Support on ko-fi\" src=\"https://user-images.githubusercontent.com/34342551/88784787-12507980-d1ae-11ea-82fe-f55753340168.png\" width=\"185\"\u003e\n\u003c/a\u003e\n\n\n## 📝 License\n\nCopyright © 2020 [Bhupesh Varshney](https://github.com/Bhupesh-V).\u003cbr /\u003e\nThis project is [MIT](https://github.com/Bhupesh-V/areyouok/blob/master/LICENSE) licensed.\n\n## 👋 Contributing\n\nPlease read the [CONTRIBUTING](CONTRIBUTING.md) file for the process of submitting pull requests to us.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://animesh-ghosh.github.io/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/34956994?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMaDDogx\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/Bhupesh-V/areyouok/issues?q=author%3AAnimesh-Ghosh\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhupesh-v%2Fareyouok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbhupesh-v%2Fareyouok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhupesh-v%2Fareyouok/lists"}