Installing the CLI

This guide provides details on how to install and use the Furiko CLI tool, furiko.

Installation Instructions

Currently, furiko is only released via Furiko's GitHub releases. You can install furiko by downloading the executable binary from Furiko's GitHub releases page directly.

macOS

curl https://github.com/furiko-io/furiko/releases/latest/download/furiko_darwin_amd64 -sL -O
mv furiko_darwin_amd64 /usr/local/bin/furiko
chmod +x /usr/local/bin/furiko

macOS (Apple Silicon)

Note that M1 Macs no longer have /usr/local/bin by default. You may wish to substitute /usr/local/bin for another directory in your $PATH.

curl https://github.com/furiko-io/furiko/releases/latest/download/furiko_darwin_arm64 -sL -O
mv furiko_darwin_arm64 /usr/local/bin/furiko
chmod +x /usr/local/bin/furiko

Linux

curl https://github.com/furiko-io/furiko/releases/latest/download/furiko_linux_amd64 -sL -O
mv furiko_linux_amd64 /usr/local/bin/furiko
chmod +x /usr/local/bin/furiko

Windows

curl https://github.com/furiko-io/furiko/releases/latest/download/furiko_windows_amd64.exe -sL -O
mv furiko_windows_amd64 /usr/local/bin/furiko
chmod +x /usr/local/bin/furiko

Usage Instructions

Running furiko --help will list all available commands for the CLI tool.

$ furiko --help
Command-line utility to manage Furiko.

Usage:
  furiko [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  disable     Disable automatic scheduling for a JobConfig.
  enable      Enable automatic scheduling for a JobConfig.
  get         Get one or more resources by name.
  help        Help about any command
  kill        Kill an ongoing Job.
  list        List all resources by kind.
  run         Run a new Job.

Flags:
      --dynamic-config-name string        Overrides the name of the dynamic cluster config. (default "execution-dynamic-config")
      --dynamic-config-namespace string   Overrides the namespace of the dynamic cluster config. (default "furiko-system")
  -h, --help                              help for furiko
      --kubeconfig string                 Path to the kubeconfig file to use for CLI requests.
  -n, --namespace string                  If present, the namespace scope for this CLI request.
  -v, --v int                             Sets the log level verbosity.

Use "furiko [command] --help" for more information about a command.