url-parser/README.md

94 lines
2.9 KiB
Markdown
Raw Normal View History

2020-02-02 23:05:18 +00:00
# url-parser
2021-01-17 19:49:40 +00:00
[![Build Status](https://img.shields.io/drone/build/thegeeklab/url-parser?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/url-parser)
2020-09-21 18:24:51 +00:00
[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/url-parser)](https://goreportcard.com/report/github.com/thegeeklab/url-parser)
2020-09-21 18:54:34 +00:00
[![Codecov](https://img.shields.io/codecov/c/github/thegeeklab/url-parser)](https://codecov.io/gh/thegeeklab/url-parser)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/url-parser)](https://github.com/thegeeklab/url-parser/graphs/contributors)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/url-parser)](https://github.com/thegeeklab/url-parser/blob/main/LICENSE)
2020-02-02 23:05:18 +00:00
Inspired by [herloct/url-parser](https://github.com/herloct/url-parser), a simple command-line utility for parsing URLs.
2021-10-25 10:48:09 +00:00
## Installation
2020-02-02 23:05:18 +00:00
Prebuild multiarch binaries are availabe for Linux only:
```Shell
2020-09-21 18:24:51 +00:00
curl -L https://github.com/thegeeklab/url-parser/releases/download/v0.1.0/url-parser-0.1.0-linux-amd64 > /usr/local/bin/url-parser
2020-02-02 23:05:18 +00:00
chmod +x /usr/local/bin/url-parser
url-parser --help
```
2021-10-25 10:48:09 +00:00
## Build
Build the binary from source with the following command:
```Shell
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on
make build
2021-10-25 10:48:09 +00:00
```
2020-02-02 23:05:18 +00:00
## Usage
```Shell
$ url-parser --help
NAME:
url-parser - Parse URL and shows the part of it.
USAGE:
url-parser [global options] command [command options] [arguments...]
VERSION:
2020-02-03 14:00:54 +00:00
devel
2020-02-02 23:05:18 +00:00
COMMANDS:
2020-02-03 14:00:54 +00:00
all, a Get all parts from url
scheme, s Get scheme from url
user, u Get username from url
password, pw Get password from url
path, pt Get path from url
host, h Get hostname from url
port, p Get port from url
query, q Get query from url
fragment, f Get fragment from url
help, h Shows a list of commands or help for one command
2020-02-02 23:05:18 +00:00
GLOBAL OPTIONS:
--url value source url to parse [$URL_PARSER_URL]
--help, -h show help (default: false)
--version, -v print the version (default: false)
```
## Examples
```Shell
$ url-parser host --url https://somedomain.com
somedomain.com
$ url-parser user --url https://herloct@somedomain.com
herloct
$ url-parser path --url https://somedomain.com/path/to
/path/to
$ url-parser path --path-index=1 --url https://somedomain.com/path/to
to
$ url-parser query --url https://somedomain.com/?some-key=somevalue
some-key=somevalue
$ url-parser query --query-field=some-key --url https://somedomain.com/?some-key=somevalue
somevalue
```
2020-09-21 18:54:34 +00:00
## Contributors
2022-07-12 07:12:32 +00:00
Special thanks to all [contributors](https://github.com/thegeeklab/url-parser/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/url-parser/blob/main/CONTRIBUTING.md).
2020-09-21 18:54:34 +00:00
2020-02-24 21:26:37 +00:00
## License
2020-02-02 23:05:18 +00:00
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/url-parser/blob/main/LICENSE) file for details.