https://github.com/lucasepe/uri

A commandline tool to resolve URI Templates expressions as specified in RFC 6570.
https://github.com/lucasepe/uri

commandline-tool cross-platform golang uri-templates

Last synced: about 1 month ago
JSON representation

A commandline tool to resolve URI Templates expressions as specified in RFC 6570.

• Host: GitHub
• URL: https://github.com/lucasepe/uri
• Owner: lucasepe
• License: bsd-3-clause
• Created: 2021-03-26T11:28:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-03-31T07:30:12.000Z (over 3 years ago)
• Last Synced: 2024-06-19T05:55:32.817Z (3 months ago)
• Topics: commandline-tool, cross-platform, golang, uri-templates
• Language: Go
• Homepage:
• Size: 14.6 KB
• Stars: 17
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# URI

## Are you tired to build, concat, replace URL(s) (via shell scripts sed/awk/tr) from your awesome commandline pipeline? 

### Well! here is the missing piece: `uri`!

```

         _            _  

o  / / _|     URI      |_ 

o / /   |_ Templates  _|

```

> A commandline tool to resolve URI Templates expressions as specified in [RFC 6570](http://tools.ietf.org/html/rfc6570).

For a complete syntax reference check the RFC6570 specs here: https://tools.ietf.org/html/rfc6570#section-2.

Expressions are placeholders which are to be substituted by the values their variables reference.

```text

http://example.org/~{username}/

http://example.org/dictionary/{term:1}/{term}

http://example.org/search{?q*,lang}

```

# How to use `uri`

This tool takes a JSON as input data model containing the values ​​of the variables. Example:

```json

{

    "username": "scarlett",

    "term": "black widow",

    "q": {

        "a": "mars",

        "b": "jupiter"

    },

    "lang": "en"

}

```

You can pass this JSON as file using the `-i` flag:

```bash

$ uri -i data.json http://example.org/~{username}/{term:1}/{term}{?q*,lang}

http://example.org/~scarlett/b/black%20widow?q*

```

Or you can pipe it directly to the tool (and this the most interesting use case):

```bash

$ cat data.json | uri http://example.org/~{username}/{term:1}/{term}{?q*,lang}

http://example.org/~scarlett/b/black%20widow?q*

```

Using commandline pipes you can achieve tasks like this:

```bash

$ cat testdata/pets.json \

  | jq --raw-output '.pets[1] | {category: .species, year: .birthYear}' \

  | uri https://pets.api.com/{category}{?year} \

  | xargs curl

```

# Installation Steps

In order to use the crumbs command, compile it using the following command:

```bash

go get -u github.com/lucasepe/uri

```

This will create the executable under your $GOPATH/bin directory.

## Ready-To-Use Releases 

If you don't want to compile the source code yourself, [here you can find the executables](https://github.com/lucasepe/uri/releases/latest) for:

- MacOS

- Linux (amd64, arm7, arm64)

- Windows

## Credits

`uri` was possible thanks to the [Joshua Tacoma URI Template library](https://github.com/jtacoma/uritemplates).