https://github.com/groovy-sky/gmuv
CLI tool to validate Markdown URLs
https://github.com/groovy-sky/gmuv
cli devops-tools git github-api go golang markdown validation-library
Last synced: 5 months ago
JSON representation
CLI tool to validate Markdown URLs
- Host: GitHub
- URL: https://github.com/groovy-sky/gmuv
- Owner: groovy-sky
- License: bsd-3-clause
- Created: 2022-05-18T17:34:03.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-22T07:30:58.000Z (5 months ago)
- Last Synced: 2025-12-23T14:56:09.151Z (5 months ago)
- Topics: cli, devops-tools, git, github-api, go, golang, markdown, validation-library
- Language: Go
- Homepage:
- Size: 1.31 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub's Markdown URL Validator
## Overview
`gmuv` stands for **G**itHub's **M**arkdown **U**RL **V**alidator. `gmuv` is an open-source CLI tool to check/validate broken/failure links in Markdown files(*.md) for public Github repositories under a certain account.
## Quick start
### Local installation
Go (requires ver. >= 1.18) and git installed on Linux OS:
```
go install github.com/groovy-sky/gmuv/v2@latest
```
### Using Docker image
```
docker run -it golang:latest
go install github.com/groovy-sky/gmuv/v2@latest
```
## Commands
To see available options run following command:
```
gmuv -h
```
To check and validate links under a specific account and write output to the console:
```
gmuv -u groovy-sky -o cli
```
To check and validate links under a specific account's repository and write output to 'result.md' file:
```
gmuv -u groovy-sky -r aaa -f result.md
```
Run gmuv from Github Marketplaces:
```
- name: Generate a report
uses: groovy-sky/gmuv@v1.1.1
with:
account: groovy-sky
repository: aaa
filename: output.md
```
## ToDo
* Learn how-to and write [tests](https://pkg.go.dev/testing)
* Publish a docker image to Github registry
* Improve code quality
* Learn how-to use [Codecov](https://app.codecov.io/gh/groovy-sky/gmuv)
~~* Choose which one CLI to use ([standard](https://pkg.go.dev/flag), [urfave/cli](https://github.com/urfave/cli), [spf13/cobra](https://github.com/spf13/cobra))~~
~~* Setup workflow for building packages for different platforms (386,amd64 etc.)~~
## License
This project is released under [the BSD-3-Clause license](https://github.com/groovy-sky/gmuc/blob/main/LICENSE).