Skip to main content

furyctl CLI reference

The Swiss Army knife for the SIGHUP Distribution

Synopsis​

The multi-purpose command line tool for the SIGHUP Distribution.

furyctl is a command line interface tool to manage the full lifecycle of SIGHUP Distribution Clusters.

Options​

  -D, --debug                       Enables furyctl debug output. This will greatly increase the verbosity. Debug logs and additional logs are also always written to the log file. See the --log flag.
  -d, --disable-analytics           Disable analytics
  -g, --git-protocol git-protocol   Download repositories using the given protocol. Use when SSH traffic is being blocked or when SSH client has not been configured
                                    set the GITHUB_TOKEN environment variable with your token to use authentication while downloading, for example for private repositories. 
                                    Options are: ssh, https (default https)
  -h, --help                        help for furyctl
  -H, --https                       DEPRECATED: by default furyctl uses https protocol to download repositories. See --git-protocol flag (default true)
  -l, --log string                  Path to a file or folder where to write logs to. Set to 'stdout' write to standard output. Target path will be created if it does not exists. Path is relative to --workdir. Default is '<outdir>/.furyctl/furyctl.<timestamp>-<random number>.log'
  -T, --no-tty                      Disable TTY making furyctl's output more friendly to non-interactive shells by disabling animations and colors
  -o, --outdir string               Path where to create the ".furyctl" data directory. Default is the user's home. Path is relative to --workdir
  -w, --workdir string              Switch to a different working directory before executing the given subcommand. NOTE: this will affect all the paths passed, including other flags like outdir and log, for example

See Also​

  • furyctl apply - Apply the configuration to create, update, or upgrade a battle-tested SIGHUP Distribution cluster
  • furyctl completion - Generate completion script for your shell
  • furyctl connect - Start up a new private connection to a cluster
  • furyctl create - Create a cluster, a sample configuration file, or the PKI needed for an on-premises cluster
  • furyctl delete - Delete a cluster and its related infrastructure
  • furyctl diff - Diff the current configuration with the one in the cluster
  • furyctl download - Download all dependencies for the SIGHUP Distribution version specified in the configuration file
  • furyctl dump - Dump rendered templates or other useful objects to the filesystem
  • furyctl get - Get the kubeconfig, available upgrade paths for a cluster or compatible versions to use between SD, providers, furyctl
  • furyctl legacy - Legacy commands for compatibility with older versions of furyctl
  • furyctl renew - Renew a resource (e.g. certificates) of a cluster
  • furyctl validate - Validate a configuration file and the dependencies relative to the SIGHUP Distribution version specified in it
  • furyctl version - Print the version number and build information of furyctl