The Swiss Army Knife
for the SIGHUP Distribution

What is furyctl?

furyctl is the command line companion for the SIGHUP Distribution (SD) to manage the full lifecycle of your SD Kubernetes clusters.

Tip

Learn more about the SIGHUP Distribution in the documentation site.

Note

Starting from v0.25.0, the next generation of furyctl has been officially released. Previous versions (<= 0.11), are considered legacy and will only receive bug fixes. It will be maintained under the release-v0.11 branch.

If you're looking for the old documentation for furyctl legacy, you can find it here.

Available providers

• EKSCluster: Provides comprehensive lifecycle management for a SIGHUP Distribution Kubernetes cluster based on EKS from AWS. It handles the installation of the VPC, VPN, EKS using the installers, and deploys the Distribution onto the EKS cluster.
• KFDDistribution: Dedicated provider for the distribution, which installs the SIGHUP Distribution (modules only) on an existing Kubernetes cluster.
• OnPremises: Provider to manage the full lifecycle of a SIGHUP Distribution cluster on Virtual Machines.

Support & Compatibility 🪢

Check the compatibility matrix for information about furyctl and SD versions compatibility.

Installation

Installing from binaries

You can find furyctl binaries on the Releases page.

To download the latest release, run:

curl -L "https://github.com/sighupio/furyctl/releases/latest/download/furyctl-$(uname -s)-amd64.tar.gz" -o /tmp/furyctl.tar.gz && tar xfz /tmp/furyctl.tar.gz -C /tmp
chmod +x /tmp/furyctl
sudo mv /tmp/furyctl /usr/local/bin/furyctl

Alternatively, you can install furyctl using mise or the asdf plugin.

Installing with mise

mise use [email protected]

Check that everything is working correctly with furyctl version:

$ furyctl version
...
goVersion: go1.23
osArch: arm64
version: 0.33.1

Installing with asdf

Add furyctl asdf plugin:

asdf plugin add furyctl

Check that everything is working correctly with furyctl version:

$ furyctl version
...
goVersion: go1.23
osArch: amd64
version: 0.33.1

Development

For development setup, building from source, and contributing guidelines, see DEVELOPMENT.md.

Usage

For basic and advanced usage instructions, please refer to furyctl's official documentation and the SIGHUP Distribution getting started guides.

Reporting Issues

In case you experience any problems with furyctl itslef, please open a new issue on GitHub. If the issue is related to the SIGHUP Distribution, please open the issue in its repository instead.

License

This software is open-source and it's released under the following LICENSE.