Skip to content

Interact with Waldo from the command line

License

Notifications You must be signed in to change notification settings

waldoapp/waldo-go-cli

Repository files navigation

Waldo CLI

License Platform

About Waldo

Waldo provides fast, reliable, and maintainable testing for the most critical flows in your app. Waldo CLI is a command-line tool which allows you to interact with Waldo in several useful ways:

  • Authenticate user access to Waldo with an API token.
  • Upload an iOS or Android build to Waldo for processing. See here and here for more details.
  • Trigger a run of of one or more test flows for your app. See here for more details.

Type waldo help to see all that Waldo CLI can do for you!

Installation

Note: If you intend to use Waldo CLI from a CI script, please refer to the next section — Installation for CI — for instructions.

Linux and macOS

To install Waldo CLI, simply download and execute the installer script:

TOKEN=u-xxxx bash -c "$(curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install.sh)"

The script attempts to install Waldo CLI to ~/.waldo/bin.

If you set the TOKEN environment variable to the value of your API token, the installer script will automatically run the waldo auth command upon successful installation of Waldo CLI. You can retrieve your API token by visiting the “Profile” tab of your Waldo account settings (https://app.waldo.com/settings/profile).

You can verify that you have installed Waldo CLI correctly with the which waldo and waldo help commands.

If you ever need to uninstall Waldo CLI, simply delete the binary at ~/.waldo/bin/waldo.

Windows

To install Waldo CLI, simply navigate to the latest release, download the appropriate waldo executable for your machine (either waldo-windows-x86_64.exe or waldo-windows-arm64.exe), and install it as waldo.exe to a location known to %PATH%.

You can verify that you have installed it correctly with the waldo help command.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Installation for CI

Note: If you intend to use Waldo CLI interactively, please refer to the previous section — Installation — for instructions.

Linux and macOS

To install Waldo CLI, simply download and execute the installer script:

bash -c "$(curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install-waldo.sh)"

By default, the script installs Waldo CLI to /usr/local/bin.

If you wish to install Waldo CLI to a different location, simply set the WALDO_CLI_BIN environment variable before invoking the installer script:

WALDO_CLI_BIN=/path/to/binary bash -c "$(curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install-waldo.sh)"

You can verify that you have installed Waldo CLI correctly with the which waldo and waldo help commands.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Windows

To install Waldo CLI, simply navigate to the latest release, download the appropriate waldo executable for your machine (either waldo-windows-x86_64.exe or waldo-windows-arm64.exe), and install it as waldo.exe to a location known to %PATH%.

You can verify that you have installed it correctly with the waldo help command.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.