vl
github.com/npxbr/verify-links
go get github.com/npxbr/verify-links
vl

github.com/npxbr/verify-links

CLI tool that helps verify current status of URIs in text files

go get github.com/npxbr/verify-links
Readme

verify-links

CLI tool that helps verify current status of URIs in text files

Table of Contents

Prerequisites

  • Golang 1.16

Installing

go install github.com/npxbr/verify-links/cmd/vl@latest

Usage

Common usage

$ vl FILE

Flags

-a (Skip status codes list)

Example:

$ vl README.md -a 500,404

All 500 and 404 errors will be ignored and not considered as errors

-t (timeout for each request)

Example:

$ vl README.md -t 30s

Each request that takes more than 30s will be considered as an error. The values accepted must be under the durations values. Some examples here

-w Whitelist URIs

Example:

$ vl README.md -w server1.com,server2.com

Adds a list of whitelisted links that shouldn't be verified. Links must be exactly passed as they are in the text file

Running with docker

$ docker run -it --rm -v $PWD:/ ellisonleao/vl /yourfile.md

Screenshots

Terminal output

terminal colors are only working in linux

Github Action

Running in a Github Action

An example of a workflow file:

---
name: CI
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-go@v2.1.3
        id: go
        with:
          go-version: '^1.16.1'

      - uses: actions/checkout@v2.3.4

      - run: go get github.com/npxbr/verify-links/cmd/vl
      - run: vl README.md

GitHub Stars

12

LAST COMMIT

1yr ago

MAINTAINERS

0

CONTRIBUTORS

2

OPEN ISSUES

5

OPEN PRs

0
VersionTagPublished
v0.0.0-20210610205459-046df47c6282
1yr ago
v0.0.0-20210608173457-79941e0c6d8a
1yr ago
v0.0.0-20210607152818-c7dde4262973
1yr ago
v0.0.0-20210607131823-0e010cfc9a20
1yr ago
No alternatives found
No tutorials found
Add a tutorial