Skip to content

essentialkaos/subdy

Code Climate Maintainability Codebeat badge GitHub Actions CI Status GitHub Actions CodeQL Status

ScreenshotsInstallationUsageCI StatusContributingLicense


subdy is a simple CLI for subdomain.center API.

Screenshots

subdy preview

Installation

From source

To build the subdy from scratch, make sure you have a working Go 1.20+ workspace (instructions), then:

go install github.com/essentialkaos/subdy@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository:

bash <(curl -fsSL https://apps.kaos.st/get) subdy

Container Image

The latest version of subdy also available as container image on GitHub Container Registry and Docker Hub:

podman run --rm -it ghcr.io/essentialkaos/subdy:latest mydomain.com
# or
docker run --rm -it ghcr.io/essentialkaos/subdy:latest mydomain.com

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo subdy --completion=bash 1> /etc/bash_completion.d/subdy

ZSH:

sudo subdy --completion=zsh 1> /usr/share/zsh/site-functions/subdy

Fish:

sudo subdy --completion=fish 1> /usr/share/fish/vendor_completions.d/subdy.fish

Man documentation

You can generate man page using next command:

subdy --generate-man | sudo gzip > /usr/share/man/man1/subdy.1.gz

Usage

CI Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0