Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zws-im/cli
A command line interface for ZWS instances
https://github.com/zws-im/cli
32-bit 64-bit cli docker linux nim url-shortener windows zws
Last synced: 3 months ago
JSON representation
A command line interface for ZWS instances
- Host: GitHub
- URL: https://github.com/zws-im/cli
- Owner: zws-im
- Created: 2021-02-24T18:24:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T01:47:30.000Z (3 months ago)
- Last Synced: 2024-10-29T18:47:45.096Z (3 months ago)
- Topics: 32-bit, 64-bit, cli, docker, linux, nim, url-shortener, windows, zws
- Language: Nim
- Homepage:
- Size: 12.7 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# zws-im/cli
A command line interface for [ZWS][zws] instances.
## Usage
```sh
zws [options] [url]
zws [options] shorten [url]
zws [options] stats [url]
zws [options] config
```
| 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.
```sh
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.
```sh
zws [options] stats
```
### `stats `
View usage statistics for a shortened URL.
```sh
zws [options] stats
```
### `config`
Print the current configuration.
You can view the config path and if it's being loaded with the `-h` or `--help` flag.
```sh
zws [options] config
```
## Config
The config is stored as `zws.ini` in [the config directory of the current user for applications](https://nim-lang.org/docs/os.html#getConfigDir) as [the Nim configuration file format](https://nim-lang.org/docs/parsecfg.html).
### Full example
```ini
[Api]
url = "https://api.example.com"
token = "YTdaKVdfGPxdkKaayRwaVHvLXtVkPdPz"
[Shortened]
baseUrl = "https://example.com"
```
### `Api`
| Key | Description | Default |
| ------- | ---------------------------------------------------------------------------------------------------- | -------------------- |
| `url` | The URL of the [ZWS instance][zws]. | `https://api.zws.im` |
| `token` | The API token to use in requests. Only required for custom instances with authentication configured. | |
### `Shortened`
| Key | Description | Default |
| -------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| DEPRECATED `baseUrl` | The URL shortened IDs should be appended to. You only need to set this if you can't set the base URL on the API side. | `https://zws.im` if `Api.url` is set to default, otherwise the value of `Api.url` |
## Installation
Nimble is the preferred way to install the CLI and is the best option for regular use.
Docker is easiest for testing but containers are slower compared to native host execution.
### Nimble
1. [Install Nim and Nimble](https://nim-lang.org/install.html)
2. Install via Nimble
```sh
nimble install zws
```
### Docker
An official Docker image is published [on Docker Hub as `zwsim/cli`](https://hub.docker.com/repository/docker/zwsim/cli/general).
```sh
docker run --rm zwsim/cli [options] url
```
### Manual installation
1. Download a binary from the [latest release](https://github.com/zws-im/cli/releases/latest)
2. Add the binary to your `PATH`
3. Windows users will also need to add [these DLLs](https://nim-lang.org/download/dlls.zip) to their `PATH`
[zws]: https://github.com/zws-im/zws