README
¶
durl
CLI tool to check whether dead urls are included in files.
Motivation
Suppose you develop an oss and write documents about it. You would want many users to use it. But if it's documents include dead urls, maybe users are disappointed and give up it even if it is good.
How sad it is!
So we have developed this tool. It is good to use this tool at CI.
Of course, you can use durl other than oss documents. For example, you can also check your blog posts with durl.
Install
durl is written with Golang and binary is distributed at release page, so installation is easy.
Docker Image
We provide busybox based docker image installed durl.
https://hub.docker.com/r/suzukishunsuke/durl
You can try to use durl without installation, and this is useful for CI.
$ docker run -ti --rm -v $PWD:/workspace -w /workspace suzukishunsuke/durl sh
# echo foo.txt | durl check
Getting Started
At first generate the configuration file.
# Generate .durl.yml
$ durl init
Generate a file included dead url.
$ cat << EOF > bar.txt
heredoc> foo
http://example.com
Please see http://example.com/bar .
EOF
Then check the file with durl check.
durl check accepts file paths as stdin.
$ echo foo.txt | durl check
[foo.txt] http://example.com/bar is dead (404)
It is good to use durl combining with the find command.
find . \
-type d -name node_modules -prune -o \
-type d -name .git -prune -o \
-type d -name vendor -prune -o \
-type f -print | \
durl check || exit 1
Configuration
---
ignore_urls:
- http://example.com/bar
Change Log
Please see Releases.
Contributing
Please see CONTRIBUTING.md .
Directories