Get the CLI

The Wayfinder CLI allows you to interact with Wayfinder from your terminal and within continuous integration pipelines. All features of Wayfinder can be accessed equally from the UI and CLI.

CLI download links

See the Release Notes to find the CLI download links for the Wayfinder version and operating system you need. Download links are shown for every supported version. You'll use these links in the instructions below.

You can also download the CLI from the Wayfinder UI by clicking your account icon, then Setup Wayfinder CLI:

You'll still need to follow the instructions in Method 2 below to set up the CLI.

Download the latest version

Method 1

1. Copy the commands shown in the example below.

2. If needed, replace darwin with the OS you want.

   Example:

   In this example, you want to download the latest CLI version for the darwin OS.

   VERSION=latest
   OS=darwin
   curl -L https://storage.googleapis.com/wayfinder-releases/$VERSION/wf-cli-$OS-amd64 --output /tmp/wf
   chmod +x /tmp/wf
   sudo mv /tmp/wf /usr/local/bin/wf

   The above commands:

   • Download the latest CLI binary for darwin to a temporary directory.
   • Make the binary executable.
   • Use sudo to move the executable to the /usr/local/bin/wf directory. This is a suggested location, but you can use any location defined in your path.

Method 2

1. Check the Release Notes to find the latest CLI download link for the OS you want (or from the UI, click your account icon at the top right).
2. Download the CLI binary and place it in a temporary location.
3. Make the binary executable.
4. Use sudo to move the binary to a location defined in your path, for example /usr/local/bin.

Download a previous version

To download a specific version of the CLI:

1. Check the Release Notes to see the available versions.

2. Copy the commands in the example below.

3. Replace 1.x.x with the CLI version you want, and if needed replace darwin with the OS you want.

4. Run the commands.

   Example:

   VERSION=1.x.x
   OS=darwin
   curl -L https://storage.googleapis.com/wayfinder-releases/$VERSION/wf-cli-$OS-amd64 --output /tmp/wf
   chmod +x /tmp/wf
   sudo mv /tmp/wf /usr/local/bin/wf

   The commands above:

   • Download the v1.x.x CLI binary for darwin OS to a temporary directory.
   • Make the binary executable.
   • Use sudo to move the executable to your /usr/local/bin/wf directory. You can use any directory defined in your path.

You can also use Method 2 above for the version you want to download.

CLI help

To find help for any command, run wf help command, for example, wf help create cluster.