zws

A command line interface for shortening URLs with ZWS instances


Keywords
url, url-shortener, cli, 32-bit, 64-bit, docker, linux, nim, windows, zws
License
MIT
Install
nimble install zws

Documentation

zws-im/cli

A command line interface for ZWS instances.

Usage

zws [options] [url]
zws [options] shorten [url]
zws [options] stats [url]
Flags Description
-h, --help Print help and exit.
-v, --version Print version and exit.
--json Output JSON.
--plain Output without formatting.
--no-input Disable reading from stdin.

Subcommands

shorten (default)

Shortens the provided URL.

zws [options] [url]
zws [options] shorten [url]

If no URL is provided and --no-input is not provided and the terminal is not a TTY it will be read from stdin.

stats

View total statistics for the configured ZWS instance.

zws [options] stats

stats <url>

View usage statistics for a shortened URL.

zws [options] stats <url>

Config

The config is stored as zws.ini in the config directory of the current user for applications as the Nim configuration file format.

Full example

[Api]
url = "https://api.example.com"
token = "YTdaKVdfGPxdkKaayRwaVHvLXtVkPdPz"

[Shortened]
baseUrl = "https://example.com"

Api

Key Description Default
url The URL of the ZWS instance. https://api.zws.im
token The API token to use in requests. Only required for custom instances with authentication configured.

Shortened

Key Description Default
baseUrl The URL shortened IDs should be appended to. https://zws.im if Api.url is set to default, otherwise the value of Api.url

Docker

An official Docker image is published on Docker Hub as zwsim/cli.

docker run zwsim/cli [options] url