Skip to content

essentialkaos/rds-cli-completion-generator

GitHub Actions CI Status GitHub Actions CodeQL Status

InstallationCommand-line completionMan documentationUsageCI StatusContributingLicense


rds-cli-completion-generator is a a tool to generate completion for RDS CLI.

Installation

From source

To build the rds-cli-completion-generator from scratch, make sure you have a working Go 1.22+ workspace (instructions), then:

go install github.com/essentialkaos/rds-cli-completion-generator@latest

Prebuilt binaries

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

bash <(curl -fsSL https://apps.kaos.st/get) rds-cli-completion-generator

Container Image

The latest version of rds-cli-completion-generator also available as container image on GitHub Container Registry and Docker Hub:

podman run --rm -it ghcr.io/essentialkaos/rds-cli-completion-generator:latest
# or
docker run --rm -it ghcr.io/essentialkaos/rds-cli-completion-generator:latest

Command-line completion

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

Bash:

sudo rds-cli-completion-generator --completion=bash 1> /etc/bash_completion.d/rds-cli-completion-generator

ZSH:

sudo rds-cli-completion-generator --completion=zsh 1> /usr/share/zsh/site-functions/rds-cli-completion-generator

Fish:

sudo rds-cli-completion-generator --completion=fish 1> /usr/share/fish/vendor_completions.d/rds-cli-completion-generator.fish

Man documentation

You can generate man page using next command:

rds-cli-completion-generator --generate-man | sudo gzip > /usr/share/man/man1/rds-cli-completion-generator.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

About

Tool to generate completion for RDS CLI

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages