Skip to content

README.md

Latest commit

 

History

History
41 lines (25 loc) · 1.26 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.26 KB

Safelyx API

Safelyx API client

Safelyx API client for cross-platform CLI. It uses @safelyx/api to make requests to the Safelyx API.

You can find the API documentation at https://safelyx.com/safe-api.

Some things to note:

  1. It's simply making an HTTP request to the Safelyx API.

  2. It returns the raw JSON response from the API.

Usage

It has a command per API endpoint.

Download the binary from the releases page that's appropriate for your platform and architecture. Make sure the file is executable and is in your PATH (on macOS, you may also need to run chmod +x safelyx && xattr -dr com.apple.quarantine safelyx because the binary is not code signed).

safelyx check-link https://example.com
# Outputs the raw JSON response from the API.

Development

Requires deno.

deno run --allow-net=safelyx.com main.ts check-link example.com
make format
make test
make build

Publishing

Just push to the main branch (with the updated version in the deno.json file) and create a tag + release.