urlsup
![Code Coverage](https://codecov.io/gh/simeg/urlsup/branch/master/graph/badge.svg?token=2bsQKkD1zg)
urlsup
(urls up) finds URLs in files and checks whether they are up by
making a GET
request and checking the response status code. This tool is
useful for lists, repos or any type of project containing URLs that you want to
be up.
It's written in Rust (stable) and executes the requests async in multiple threads, making it very fast. This in combination with its ease of use makes it the perfect tool for your CI pipeline.
This project is a slim version of
awesome_bot
but aims to be faster.
Usage
<FILES>...
)
)
Examples
> Using
> Using )
> Allow
> Will
> Found
> Issues
> Using
> Using )
> Allow
> Will
> Found
> No
# white list all links starting with rust or crates
# check links in 2 files
# check all markdown files in docs/ directory
# speed up validation by setting a timeout of 5 seconds per link request and allowing timeouts
# allow status code errors 403 and 429
Installation
Install with cargo
to run urlsup
on your local machine.
GitHub Actions
See urlsup-action
.
Development
This repo uses a Makefile as an interface for common operations.
- Do code changes
- Run
make build link
to build the project and create a symlink from the built binary to the root of the project - Run
./urlsup
to execute the binary with your changes - Profit :star: