yurl

module
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2023 License: MIT

README

CircleCI Build Status GitHub License

yURL is a CLI (Command-Line Interface) and webapp that allows you to validate whether a URL is properly configured for Universal Links and App Links. This allows you to check if the apple-app-site-association (AASA) and assetlinks.json files exist and are in the proper format as defined by Apple and Google.

macOS Install Instructions

Install yURL with Brew:

brew install chayev/tap/yurl
Install using cURL

Run the below command:

curl -sSL "https://github.com/chayev/yurl/releases/download/v0.7.3/yurl-v0.7.3-macos-amd64.tar.gz" | sudo tar -xz -C /usr/local/bin yurl

Note: You will be prompted to enter your password because of the sudo command. 0.7.3 may need to be replaced with your desired version.

Linux Install Instructions

Run the below command:

curl -sSL "https://github.com/chayev/yurl/releases/download/v0.7.3/yurl-v0.7.3-linux-amd64.tar.gz" | sudo tar -xz -C /usr/local/bin yurl

Note: You will be prompted to enter your password because of the sudo command. 0.7.3 may need to be replaced with your desired version.

Install with Snap (deprecated)

Install yURL with Snap:

sudo snap install yurl

Windows Install Instructions

You could download the executable from the releases page. More instructions coming soon!

We are planning on supporting chocolatey package manager as well.

Usage and Example

Run yurl help for information on how to use yURL.

Example:

To validate the Apple App Site Association (AASA) file run the following:

yurl aasa validate suadeo.onelink.me

To validate the Android assetlinks.json file run the following:

yurl assetlink validate suadeo.onelink.me

Contributing

Contributions to yURL of any kind are welcome! Feel free to open PRs or an issue.

Asking Support Questions

Feel free to open an issue if you have a question.

Reporting Issues

If you believe you have found a defect in yURL or its documentation, create an issue to report the problem. When reporting the issue, please provide the version of yURL in use (yurl version).

License

This repository is licensed under the MIT license. The license can be found here.

Directories

Path Synopsis
cli
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL