An open API service indexing awesome lists of open source software.

https://github.com/essentialkaos/subdy

CLI for subdomain.center API
https://github.com/essentialkaos/subdy

arpsyndicate subdomains

Last synced: 3 months ago
JSON representation

CLI for subdomain.center API

Awesome Lists containing this project

README

          


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

ScreenshotsInstallationUsageCI StatusContributingLicense


`subdy` is a simple CLI for [subdomain.center](https://www.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](https://go.dev/doc/install)_), then:

```bash
go install github.com/essentialkaos/subdy@latest
```

#### Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/subdy/latest):

```bash
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](https://kaos.sh/p/subdy) and [Docker Hub](https://kaos.sh/d/subdy):

```bash
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:
```bash
sudo subdy --completion=bash 1> /etc/bash_completion.d/subdy
```

ZSH:
```bash
sudo subdy --completion=zsh 1> /usr/share/zsh/site-functions/subdy
```

Fish:
```bash
sudo subdy --completion=fish 1> /usr/share/fish/vendor_completions.d/subdy.fish
```

### Man documentation

You can generate man page using next command:

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

### Usage

### CI Status

| Branch | Status |
|--------|----------|
| `master` | [![CI](https://kaos.sh/w/subdy/ci.svg?branch=master)](https://kaos.sh/w/subdy/ci?query=branch:master) |
| `develop` | [![CI](https://kaos.sh/w/subdy/ci.svg?branch=develop)](https://kaos.sh/w/subdy/ci?query=branch:develop) |

### Contributing

Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).

### License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)